roast2d

Crates.ioroast2d
lib.rsroast2d
version0.0.10
sourcesrc
created_at2024-09-23 14:53:00.160605
updated_at2024-10-27 09:44:18.989363
descriptionRoast2D is a homebrew 2D game engine inspired by high_impact
homepage
repositoryhttps://github.com/jjyr/roast2d
max_upload_size
id1384187
size296,543
jjy (jjyr)

documentation

README

Roast2D

Crates.io Docs CI

Roast2D is a rapid development 2D game engine written in Rust. Inspired by high_impact.

I wrote an article explaining why Roast2D was made

Features

  • Poor man's ECS, no archetype, just a little bit ECS to improve the composition ability

  • Simple physics and collision

  • LDTK editor integration

  • Multi-platform (via SDL2 and WebAssembly)

Examples

  • A copy of the classic breakout shows the basic usage
  • A 2D platformer prototype balloon game shows how to integrate with LDTK, kira (audio) and support web platform.

Usage

Run example:

cargo run --example breakout

Add roast2d to Rust project:

cargo add roast2d

Roast2D supports multiple backends:

SDL2

SDL2 is the default backend when you build for Linux / Mac / Windows.

Make sure the SDL2 library is installed on your machine before developing. This document can help to install SDL2.

WebAssembly

WebAssembly backend is implement with web canvas interface, you must make sure the game can build with wasm32-unknown-unknown target. Ensure you have wasm-pack installed, and use wasm-pack build to build project.

To render the game, ensure you provide a <canvas> element with the id #roast-2d-canvas.

License

The source code is licensed under MIT.

Commit count: 99

cargo fmt