Skip to content

Latest commit

 

History

History
79 lines (49 loc) · 4.53 KB

README.md

File metadata and controls

79 lines (49 loc) · 4.53 KB

LimitPush

Important

THE TEMPLATE IS IN FULL REWRITE! TERMINAL & STD FULL FEATURED 3D TEMPLATE! (no-std planned on further updates due to current Bevy no-std status)

Welcome to LimitPush – a modular, high-performance cross-platform template for the Bevy game engine, designed with flexibility and ease of use in mind. This project is a work in progress but is rapidly evolving into a stable, feature-rich foundation for developing both 2D and 3D games in Bevy.

Technologies

This project uses bevy as a game framework and its community crates by organizing everything in the rusty way. So, this project is written in Rust, with some script and web components for automatic updates/builds and wasm builds. Also, this project does graphs with automated scripts.

🚀 About the Project

LimitPush provides a universal template that accelerates development and facilitates easy extension, aiming to be the go-to framework for building Bevy-based games. Key features include:

  • Customizability: Easily adjust core gameplay components such as player movement, object spawners, game mechanics, and more.
  • Cross-Platform Support: Compatibility across mobile, web, and desktop platforms (terminal-based OS supported too!), with ongoing efforts to expand further.
  • Future-Proofing: Built with a vision for future platform support and optimized performance for a range of hardware setups.

⚙️ Key Features

LimitPush comes packed with tools and features to streamline your development process:

  • Modular Architecture: The game is structured with a modular crate system, offering flexibility to customize and extend as needed.
  • Platform Expansion: Planning for future support on platforms such as Raspberry Pi, Steam Deck, and more. If you want a platform to be supported, feel free to open an issue!
  • Cross-Platform Performance: Designed to provide high-performance gameplay on multiple platforms, ensuring smooth experiences whether you're developing for mobile, desktop, web, or embedded (yes, it supports embedded targets too).
  • Maximum Productivity: Comes with various tools, preconfigured VSCode, extensions recommendations, bevy basic snippets and more!

🛠 How You Can Help

We’re looking for contributors, testers, and supporters to help make LimitPush even better. Here’s how you can get involved:

  • Open Issues: If you find a bug or have a feature request, please open an issue and provide any relevant resources or references to help us address it.
  • Code Contributions: Feel free to explore the repository and submit a pull request. Your contributions are highly appreciated!
  • Feedback and Ideas: Share any insights, suggestions, or improvements you think could enhance LimitPush.
  • Testing & Usage Feedback: Your experience with the template can help us improve its direction and usability.

✅ Supported Platforms

LimitPush prioritizes blazing performance and broad platform compatibility. Current platform support includes:

  • Mobile:

    • Fully supported (iOS support pending testing).
  • Web:

    • Fully supported.
  • Desktop:

    • MacOS: Fully supported.
    • Linux (Graphics-based): Fully supported.
    • Linux (Terminal-based): Fully supported.
    • Windows: Fully supported.
  • Embedded:

    • UEFI: Work in progress.
    • MCU: Work in progress.
    • Bare Metal: Work in progress.

🛠 Project Status

LimitPush is currently unstable as foundational work is still being finalized. Expect occasional breaking changes during development. A stable release is planned as we approach feature completion.

📝 Changelog

Current Version: v2.1.0

v2.1.0 changelog – This changelog file will contain a detailed log of changes, updates, and bug fixes for each version of the project. Please refer to this file for information on new features, updates, and fixes as the project evolves.

🏆 Credits

I want to express my gratitude to the projects and people that inspired and contributed to the creation of LimitPush! That's why I've created a dedicated CREDITS file to honour them all!

🌱 Community & Feedback

Your feedback is essential to making LimitPush a valuable tool for game developers. Feel free to contribute, ask questions, or provide suggestions in the issues section.

Join the community, stay tuned for updates, and let’s build something amazing together. Happy coding! 🎮