In-game console for the Fyrox game engine for changing cvars at runtime.
cvars-console-fyrox
to your Cargo.toml
:shell
cargo add cvars-console-fyrox
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.
See how RustCycles uses cvars and the console.
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 to your Cargo.toml
.
AGPL-v3 or newer