This is an aspirational handmade game engine meant for games targeting the web and SDL2. It reads Tiled map files into a specs based entity component system.
Rendering is handled by HtmlCanvasElement or the built in SDL2 renderer.
A number of base systems handle the core of the engine:
- TiledmapSystem - loads maps
- Physics - collision detection and handling
- AnimationSystem - sprite animation
- GamepadSystem - controller support
More specific add-ons are available as separate crates.
This is a WIP and it was also my first Rust project.
I'm really surprised at the performance. So far without any attention to
performance the engine is running at about 330FPS, with a high of about 500FPS
(in SDL2). On wasm it's running at a pretty steady 60FPS, but this is only
because the frame rate is tied to requestAnimationFrame.
- Map creation using the ubiquitous Tiled map editor.
- Animation
- Sprites (nested, keyframed Tiled maps)
- Collision detection and handling (SAT for AABBs)
- Dynamic viewport rendering
- Easily overridable default rendering
See the old gods architectural diagram for a quick overview of the core systems.
- Inventory and items
First you'll need new(ish) version of the rust toolchain. For that you can visit https://rustup.rs/ and follow the installation instructions.
This project uses the nightly release:
rustup default nightly
Then you'll need wasm-pack.
Then, if you don't already have it, cargo install basic-http-server or use your
favorite alternative static web server to serve assets.
After that building is pretty straightforward
cargo build
wasm-pack build --debug --target web examples/{some example}
basic-http-server -x -a 127.0.0.1:8888 examples/{some example}
Then visit http://localhost:8888/
If you'd like to contribute check the issues. Or look at what projects are kicking around!
Formatting is enforced by rustfmt. Before you commit do:
cargo fmt
and your changes will be reformatted to fit our standard.