<h1 align="center">
<img src="resources/img/forging.png" alt="Forge Engine" width="192">
<div align="center">Stone</div>
</h1>
[<img alt="github" src="https://img.shields.io/badge/github-Yrrrrrf%2Fstone-58A6FF?style=for-the-badge&logo=github" height="24">](https://github.com/Yrrrrrf/stone)
[<img alt="crates.io" src="https://img.shields.io/crates/v/stone.svg?style=for-the-badge&logo=rust" height="24">](https://crates.io/crates/stone)
[<img alt="docs.rs" src="https://img.shields.io/badge/docs.rs-stone-66c2a5?style=for-the-badge&labelColor=555555" height="24">](https://docs.rs/stone)
Stone is a foundational game engine built on top of Bevy, designed to provide a robust blueprint for game development in Rust. It offers essential game development features while maintaining flexibility and extensibility for various game genres and styles.
## Features
- 🎮 Built on Bevy: Leverages the powerful Bevy game engine
- 🔧 Modular Architecture: Easy to extend and customize
- 🚀 Performance Focused: Optimized for both development and production
- 📦 Ready-to-use Components: Common game systems and components
- 🛠Development Tools: Built-in debugging and development utilities
## Examples
Check out the [examples](./examples) directory for implementation examples.
```bash
# Run any example from the examples directory
cargo run --example <example-name>
```
## Usage
```bash
# Add stone to your project
cargo add stone
# Or add it to your Cargo.toml
[dependencies]
stone = "0.*"
```
## Basic Example
```rust
use stone::prelude::*;
fn main() {
Stone::new().add_plugins(DefaultPlugins).run();
}
```
## Roadmap
- [ ] **Core Engine Features**: Essential game engine components and systems
- [ ] **Scene Management**: Flexible scene loading and management
- [ ] **Asset Pipeline**: Streamlined asset loading and management
- [ ] **Input System**: Comprehensive input handling
- [ ] **Physics Integration**: Easy-to-use physics system
- [ ] **UI Framework**: Customizable user interface components
- [ ] **Networking**: Basic networking capabilities
- [ ] **Development Tools**: Debug overlays and development utilities
## License
MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)