A game built with Rust and the Bevy game engine.
WorldKeeper is an ambitious game project that aims to create an engaging and immersive gaming experience using modern Rust development practices and the powerful Bevy engine.
- Rust (latest stable version)
- Git
-
Clone the repository:
git clone <your-repo-url> cd worldkeeper
-
Install dependencies and build:
cargo build
-
Run the game:
cargo run
For faster compile times during development, use the dev feature:
cargo run --features devworldkeeper/
├── src/
│ ├── main.rs # Entry point
│ ├── systems/ # Game systems
│ ├── components/ # ECS components
│ ├── resources/ # Game resources
│ ├── plugins/ # Bevy plugins
│ └── utils/ # Utility functions
├── assets/ # Game assets (sprites, sounds, etc.)
├── docs/ # Documentation
├── GAME_DESIGN.md # Game design document
├── DEVELOPMENT.md # Development guidelines
└── README.md # This file
cargo build
cargo runcargo build --release
cargo run --releasecargo testcargo fmt
cargo clippyThis section will be updated as features are implemented
- Basic game loop
- Player character
- World generation
- Game mechanics (TBD)
- Game Design Document - Overall game design and mechanics
- Development Guidelines - Coding standards and best practices
- Architecture Documentation - Technical architecture overview
- Read the Development Guidelines
- Create a feature branch
- Make your changes
- Run tests and formatting
- Submit a pull request
Add your license information here
- Initial project setup
- Added Bevy dependency
- Created project structure