cvars-console-fyrox 0.5.0

In-game console for the Fyrox game engine, using the cvars crate for configuration
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

<div align="center">
    <h1>Fyrox console</h1>
    <br />
    A simple and ergonomic way to store and edit configuration in your game at runtime
</div>
<br />

[![GitHub](https://img.shields.io/badge/github-martin--t/cvars-8da0cb?logo=github)](https://github.com/martin-t/cvars)
[![Docs.rs](https://img.shields.io/badge/docs.rs-cvars--console--fyrox-66c2a5?logo=docs.rs)](https://docs.rs/cvars-console-fyrox)
[![Crates.io](https://img.shields.io/crates/v/cvars-console-fyrox?logo=rust)](https://crates.io/crates/cvars-console-fyrox)
[![License (AGPL3)](https://img.shields.io/github/license/martin-t/cvars)](https://github.com/martin-t/cvars/blob/master/LICENSE)
[![CI](https://github.com/martin-t/cvars/workflows/CI-fyrox/badge.svg)](https://github.com/martin-t/cvars/actions)
[![Audit](https://github.com/martin-t/cvars/workflows/audit-fyrox/badge.svg)](https://rustsec.org/)
[![Dependency status](https://deps.rs/repo/github/martin-t/cvars/status.svg?path=cvars-console-fyrox)](https://deps.rs/repo/github/martin-t/cvars?path=cvars-console-fyrox)
[![Discord](https://img.shields.io/badge/-Discord-7389d8?logo=discord&label=&logoColor=ffffff&labelColor=6A7EC2)](https://discord.gg/aA7hCFvYh9)

In-game console for the [Fyrox](https://github.com/FyroxEngine/Fyrox) game engine for changing [cvars](https://github.com/martin-t/cvars) at runtime.

![Fyrox console](screenshot.png)

## Usage

- Add `cvars-console-fyrox` to your `Cargo.toml`:

```shell
cargo add cvars-console-fyrox
```

- Create a `FyroxConsole` when initializing your game:

```rust,ignore
FyroxConsole::new(&mut engine.user_interface);
```

You're responsible for opening and closing the console according to your game's key bindings.
You also need to call `resized` and `ui_message` on the appropriate engine events.

## Real-world example

See how [RustCycles](https://github.com/rustcycles/rustcycles) uses [cvars](https://github.com/rustcycles/rustcycles/blob/master/src/cvars.rs) and the [console](https://github.com/rustcycles/rustcycles/blob/master/src/client/process.rs).

## Compatibility

The version of fyrox-ui used by your game has to match the version used by cvars-console-fyrox, otherwise you'll get confusing errors such as:

```text
expected struct `fyrox_ui::UserInterface`, found struct `UserInterface`
```

You can use `cargo tree` to debug the issue but in general **every time you update the engine after a breaking change, you have to update the console**.

This means that there has to be a new major[^major] release of cvars-console-fyrox for each new major release of fyrox-ui even though there are no changes to the console. I will try to release a new version soon after Fyrox but since i am the only maintainer, it might not always be possible. If you need to use the latest Fyrox and cvars-console-fyrox hasn't caught up yet, feel free to submit a PR. Usually the only change needed is updating the version numbers.

You can also temporarily make a fork of the console with the fyrox-ui version number updated and add a [patch section](https://doc.rust-lang.org/cargo/reference/overriding-dependencies.html#the-patch-section) to your `Cargo.toml`.

[^major]: Since fyrox-ui's version number is `0.y.z`, changing `y` is considered a major release as per [Cargo's flavor of semantic versioning](https://doc.rust-lang.org/cargo/reference/semver.html#change-categories).

## License

AGPL-v3 or newer