https://github.com/swiiz/rgine

🦀 Rust modular game engine. ⏳ Work in progress
https://github.com/swiiz/rgine

game-engine gamedev rust rust-gamedev

Last synced: 18 days ago
JSON representation

🦀 Rust modular game engine. ⏳ Work in progress

• Host: GitHub
• URL: https://github.com/swiiz/rgine
• Owner: Swiiz
• Created: 2024-05-16T15:25:03.000Z (8 months ago)
• Default Branch: master
• Last Pushed: 2024-05-28T16:28:05.000Z (8 months ago)
• Last Synced: 2024-05-29T16:52:14.965Z (7 months ago)
• Topics: game-engine, gamedev, rust, rust-gamedev
• Language: Rust
• Homepage:
• Size: 171 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 🛠 Rgine [![Documentation][doc-img]][doc-url]

[doc-img]: https://img.shields.io/badge/docs.rs-rgine-4d76ae

[doc-url]: https://Swiiz.github.io/rgine

**🦀 Rust modular game engine made from scratch.

The code is divided into crates, each having example to better understand how the engine works.**

Check out the todo list at `todo.txt`.

## Examples and how to run

> Event scheduling debug logging can be enabled using the flag `--features "rgine/schedulelog"` or the `schedulelog` feature of the rgine root crate. (Consider logging into a file using for example `> log.txt` on windows)

### Main examples:

- **2D Rendering:**  

Path: `examples/render2d`  

How to run: `cargo run -p rgine_render2d_example`

### Core modules examples:

> Event scheduling debug logging can be enabled using the flag `--features "rgine_modules/debuglog"` or the `debuglog` feature of the crate. (Consider logging into a file using for example `> log.txt` on windows)

#### Graphics context:

- **Simple Render pass:**  

Path: `core/graphics/examples/simple.rs`  

How to run: `cargo run -p rgine_graphics --example simple`

#### Platform:

- **Windowed:**  

Path: `core/platform/examples/windowed.rs`  

How to run: `cargo run -p rgine_platform --example windowed`

- **Headless:** TODO...

#### Modules:

- **Walkthrough:**  

Path: `core/modules/examples/walkthrough.rs`  

How to run: `cargo run -p rgine_modules --example walkthrough`