cvars-console-macroquad

Crates.iocvars-console-macroquad
lib.rscvars-console-macroquad
version0.3.0
sourcesrc
created_at2023-02-05 23:03:55.031147
updated_at2023-07-15 11:09:44.068724
descriptionIn-game console for the macroquad game engine, using the cvars crate for configuration
homepagehttps://github.com/martin-t/cvars
repositoryhttps://github.com/martin-t/cvars
max_upload_size
id777496
size248,864
Martin Taibr (martin-t)

documentation

README

Macroquad console


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

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

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

Macroquad console

Usage

  • Add cvars-console-macroquad to your Cargo.toml:
cargo add cvars-console-macroquad
  • Create a MacroquadConsole when initializing your game.

  • Call its update method in your main loop.

Real-world example

See how RecWars uses cvars and the console.

Compatibility

The version of macroquad used by your game has to match the version used by cvars-console-macroquad, otherwise you'll get a segfault. Unlike with cvars-console-fyrox, there is no error at compile time.

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 major1 release of cvars-console-macroquad for each new major release of macroquad even though there are no changes to the console. I will try to release a new version soon after macroquad but since i am the only maintainer, it might not always be possible. If you need to use the latest macroquad and cvars-console-macroquad hasn't caught up yet, feel free to submit a PR.

You can also temporarily make a fork of the console with the macroquad version number updated and add a patch section to your Cargo.toml.

License

AGPL-v3 or newer

Footnotes

  1. Since macroquad's version number is 0.y.z, changing y is considered a major release as per Cargo's flavor of semantic versioning.

Commit count: 353

cargo fmt