#console #debugging #configuration #settings #gamedev #game-engine

cvars-console-fyrox

Fyrox 游戏引擎的内置控制台,使用 cvars crate 进行配置

5 个版本 (重大更新)

0.5.0 2024年1月25日
0.4.0 2023年10月28日
0.3.0 2023年7月22日
0.2.0 2023年7月1日
0.1.0 2023年2月5日

#1214 in 游戏开发

AGPL-3.0-or-later

255KB
313

Fyrox 控制台


在游戏运行时以简单易用的方式存储和编辑配置

GitHub Docs.rs Crates.io License (AGPL3) CI Audit Dependency status Discord

Fyrox 游戏引擎的内置控制台,允许在运行时更改 cvars

Fyrox console

使用方法

  • cvars-console-fyrox 添加到您的 Cargo.toml
cargo add cvars-console-fyrox
  • 在初始化游戏时创建一个 FyroxConsole
FyroxConsole::new(&mut engine.user_interface);

您需要根据游戏的热键绑定来打开和关闭控制台。您还需要在适当的引擎事件上调用 resizedui_message

实际案例

看看 RustCycles 是如何使用 cvars控制台 的。

兼容性

您游戏中使用的 fyrox-ui 版本必须与 cvars-console-fyrox 使用的版本匹配,否则您可能会遇到一些令人困惑的错误,例如

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

您可以使用 cargo tree 来调试问题,但一般来说,每次在引擎进行破坏性更改后更新引擎,都必须更新控制台。

这意味着,即使控制台没有变化,也必须为每个新的 fyrox-ui 主要版本发布一个新的 cvars-console-fyrox 主要版本。我将尽力在 Fyrox 发布后尽快发布新版本,但由于我只有一个维护者,这并不总是可能的。如果您需要使用最新的 Fyrox,而 cvars-console-fyrox 还没有跟上,请随时提交 PR。通常只需更新版本号。

您还可以临时创建一个带有更新 fyrox-ui 版本号的控制台分支,并在您的 Cargo.toml 中添加一个 补丁部分

[^major]: 由于 fyrox-ui 的版本号为 0.y.z,根据 Cargo 的语义版本控制版本,更改 y 被视为主要版本。

许可证

AGPL-v3 或更高版本

依赖项

~13–28MB
~399K SLoC