Fyrox console

A simple and ergonomic way to store and edit configuration in your game at runtime

In-game console for the Fyrox game engine for changing cvars at runtime.

Fyrox console

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 uses cvars and the console.

Compatibility

The version of fyrox-ui used by your game must 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.

This means that there has to be a new version of cvars-console-fyrox for each new version of fyrox-ui even though there are no changes to the console. If you're using the latest Fyrox and cvars-console-fyrox hasn't caught up yet, you might have to temporarily make a fork of the console with the fyrox-ui version number updated and add a patch section to your Cargo.toml.

License

AGPL-v3 or newer