https://github.com/TakWolf/tge

A lightweight cross-platform 2D game framework written in pure Rust and based on OpenGL 3.3+.
https://github.com/TakWolf/tge

game-engine graphics opengl rust tge

Last synced: 8 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/TakWolf/tge
• Owner: TakWolf
• License: apache-2.0
• Created: 2019-12-24T10:41:39.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2025-01-24T17:43:40.000Z (over 1 year ago)
• Last Synced: 2025-02-02T18:26:31.572Z (over 1 year ago)
• Topics: game-engine, graphics, opengl, rust, tge
• Language: Rust
• Homepage:
• Size: 15.8 MB
• Stars: 34
• Watchers: 4
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE-APACHE

Awesome Lists containing this project

README

          
# TakWolf's Game Engine (tge)

[![crates.io](https://img.shields.io/crates/v/tge)](https://crates.io/crates/tge)

[![Docs.rs](https://docs.rs/tge/badge.svg)](https://docs.rs/tge)

[![License](https://img.shields.io/crates/l/tge)](#License)

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

## Features

* 2D only and use pixel unit.

* Hardware-accelerated rendering base on OpenGL.

* Automatically process rendering batch.

* Dynamic font rendering with text layout.

* Support high-DPI.

* Keyboard, mouse, touch, touchpad and gamepad input handling.

* Audio play. (TODO)

## Non goals

* 3D.

* Visual editor.

The following does not contain, but can easily work with other crates:

* Entity Component System (ECS).

* Physics engines and collision detection.

* Network.

## Usage

Add the dependency line to your `Cargo.toml` file:

```toml

[dependencies]

tge = "0.0.4"

```

To release performance, also add the following configs:

```toml

[profile.dev]

opt-level = 3

```

Then create a basic template. Here is the minimal example that will create a window:

```rust

use tge::prelude::*;

struct App {}

impl App {

    fn new(_: &mut Engine) -> GameResult {

        // 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()

        .window_config(WindowConfig::new()

            .title("My Game")

            .inner_size((1024.0, 600.0)))

        .build()?;

    let mut app = App::new(&mut engine)?;

    engine.run(&mut app)

}

```

That is!

You can also see the [`examples/`](examples/) directory to learn other examples.

## Examples

### [camera](examples/camera.rs)

![Camera](docs/camera.png)

### [cannon](examples/cannon.rs)

![Cannon](docs/cannon.png)

### [clock](examples/clock.rs)

![Clock](docs/clock.png)

### [bunny_mark](examples/bunny_mark.rs)

![Bunny Mark](docs/bunny_mark.png)

### [hare_mark](examples/hare_mark.rs)

![Hare Mark](docs/hare_mark.png)

### [frame_animation](examples/frame_animation.rs)

![Frame Animation](docs/frame_animation.png)

### [parallax_forest](examples/parallax_forest.rs)

![Parallax Forest](docs/parallax_forest.png)

### [parallax_mountain](examples/parallax_mountain.rs)

![Parallax Mountain](docs/parallax_mountain.png)

### [dvd](examples/dvd.rs)

![DVD](docs/dvd.png)

### [text_layout](examples/text_layout.rs)

![Text Layout](docs/text_layout.png)

### [stroke_text](examples/stroke_text.rs)

![Stroke Text](docs/stroke_text.png)

## License

[MIT License](LICENSE-MIT) OR [Apache License 2.0](LICENSE-APACHE)