rusty_console_game_engine 0.4.1

A Rust port of the olcConsoleGameEngine
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84

![Cube](https://github.com/user-attachments/assets/a96058d7-3939-4c1e-9974-fa99a06e2763)

# The Rusty Console Game Engine


A Rust port of the [olcConsoleGameEngine](https://github.com/OneLoneCoder/Javidx9/blob/master/ConsoleGameEngine/olcConsoleGameEngine.h). Make simple retro-style console games directly in the terminal, with an API closely matching the original C++ engine.

⚠️ Currently works only on Windows 10/11. ⚠️

⚠️ Make sure to use `conhost.exe` to run any console games. ⚠️

## ✨ Features

- Basic Console Rendering (text, colors, and shapes)
- Sprites (.spr format)
- Keyboard & mouse input
- Audio support (.wav files and arbitrary frequencies)

## 🛠 Roadmap

- [x] Publish to crates.io (available [here](https://crates.io/crates/rusty_console_game_engine))
- [x] Documentation
- [x] Audio support
- [ ] Image → sprite converter
- [ ] Cross-platform support

## 🚀 Quickstart


Add the engine to your `Cargo.toml`:

```toml
[dependencies]
rusty_console_game_engine = "0.4.1"
```

Then create a game:
```rust
use rusty_console_game_engine::prelude::*;

struct Demo;

impl ConsoleGame for Demo {
    fn app_name(&self) -> &str {
        "Demo"
    }

    fn create(&mut self, _engine: &mut ConsoleGameEngine<Self>) -> bool {
        true
    }

    fn update(&mut self, engine: &mut ConsoleGameEngine<Self>, _elapsed_time: f32) -> bool {
        engine.clear(FG_BLACK);
        engine.fill_circle(engine.mouse_x(), engine.mouse_y(), 5);

        if engine.key_pressed(SPACE) {
            engine.audio.play_note(D4, 500);
        }

        true
    }
}

fn main() {
    let mut engine = ConsoleGameEngine::new(Demo);
    engine
        .construct_console(150, 150, 4, 4)
        .expect("Console Construction Failed");
    engine.start();
}
```
To see more typical use cases of the engine, check out the `examples`!

## 🎮 Examples


Open `conhost.exe` (in the repo root) before running an example.

[Platformer](https://github.com/rip-super/RustyConsoleGameEngine/blob/main/examples/jario.rs) – Mario-style scrolling platformer

[Mode7](https://github.com/rip-super/RustyConsoleGameEngine/blob/main/examples/mode7.rs) – Pseudo 3D flying effect

[Mazes](https://github.com/rip-super/RustyConsoleGameEngine/blob/main/examples/mazes.rs) – Maze generator and renderer

[Raycaster](https://github.com/rip-super/RustyConsoleGameEngine/blob/main/examples/raycaster.rs) - Simple raycasted world to explore

[Piano](https://github.com/rip-super/RustyConsoleGameEngine/blob/main/examples/piano.rs) - Piano to play different notes

## If you find any bugs, feel free to open an [issue](https://github.com/rip-super/RustyConsoleGameEngine/issues) or a [pull request!](https://github.com/rip-super/RustyConsoleGameEngine/pulls)