TakWolf's Game Engine (Tge)

A lightweight cross-platform 2D game framework written in pure Rust and based on OpenGL 3.3+.

Tge is currently in a very early stage of development. The API may be changed. Until the version to 0.1.0.

Features

• Modular API like LÖVE.
• Vertex and sprite rendering use hardware-accelerated.
• Font support and text rendering. (TODO)
• Interface for handling keyboard, mouse, touch, touchpad and gamepad.
• Audio play. (TODO)

Usage

Just add the dependency line to your Cargo.toml file:

toml [dependencies] tge = "0.0.1"

Examples

Here is the minimal example that will create a window:

```rust use tge::error::GameResult; use tge::engine::{Engine, EngineBuilder}; use tge::window::WindowConfig; use tge::graphics::Color; use tge::game::Game;

struct App {}

impl App {

fn new(_: &mut Engine) -> GameResult<Self> {
    // load assets
    Ok(Self {})
}

}

impl Game for App {

fn update(&mut self, _: &mut Engine) -> GameResult {
    // handle logic
    Ok(())
}

fn render(&mut self, engine: &mut Engine) -> GameResult {
    engine.graphics().clear(Color::BLUE);
    // draw sprites
    Ok(())
}

}

fn main() -> GameResult { let mut engine = EngineBuilder::new() .windowconfig(WindowConfig::new() .title("My Game") .innersize((800, 600))) .build()?; let mut app = App::new(&mut engine)?; engine.run(&mut app) } ```

Just execute cargo run --example hello_world to run this example. And you can browse the examples/ directory to learn more.

Performance

Cargo builds projects in debug mode by default. This may cause the program running slowly.

Add following to your Cargo.toml file to release performance:

toml [profile.dev] opt-level = 3

You can also use the --release flag when building your project to enable release mode. Please note that release mode will increase build times quite significantly and remove debug info from the binary.

Run the example bunny_mark and sprites both with and without the --release flag to observe the impact of compiler optimizations.

TODO

Working in progress: * blend * program uniform * font and text * texture to image and screenshot * virtual assets path * assets load async * audio * document

Others

• Issue and PR are welcome.
• Third-party extend crates are welcome, but please do not name with prefix tge-.

License

MIT OR Apache-2.0