Configuration

YAML File

You can customize the behavior of Rinf CLI commands by configuring the pubspec.yaml file. All fields are optional and it’s not necessary to write them.

pubspec.yaml

rinf:
  gen_input_crates:
    - hub
  gen_output_dir: lib/src/bindings

• gen_input_crates: A list of crate names under the native folder. The rinf gen command will search for signal structs in these crates. Each crate should be located directly under the native folder.

• gen_output_dir: The directory where the generated Dart code will be placed by the rinf gen command.

You can check the current configuration status by running the command below in the CLI.

CLI

rinf config

Crate Features

Customizing the behavior of the Rinf crate is possible through its crate features.

native/hub/Cargo.toml

rinf = { version = "0.0.0", features = ["feature-name"] }

• show-backtrace: Prints the full backtrace in the CLI when a panic occurs in debug mode. In general, backtrace is not very helpful when debugging async apps, so consider using tracing for logging purposes. Note that this feature does not affect debugging on the web platform.

• bevy: Implements the Event trait from bevy_ecs for DartSignalPack, allowing Bevy’s entity component system to listen for events from Dart. This feature is highly experimental, and using it in production is not recommended.