cortenforge-sim-core

Crates.iocortenforge-sim-core
lib.rscortenforge-sim-core
version0.6.0
created_at2026-01-03 16:04:51.34127+00
updated_at2026-01-14 00:55:04.899845+00
descriptionBevy-based simulation runtime primitives (modes, config, plugins) for the CortenForge stack.
homepagehttps://github.com/via-balaena/CortenForge
repositoryhttps://github.com/via-balaena/CortenForge
max_upload_size
id2020395
size131,091
(bigmark222)

documentation

https://docs.rs/cortenforge-sim-core

README

sim_core

crates.io docs.rs MSRV

Bevy runtime scaffolding, hooks, and recorder types shared by sim/datagen/inference apps. It owns:

  • ModeSet + SimRunMode: system sets for common vs sim/datagen vs inference paths.
  • SimConfig: mode, headless, capture output/prune settings, max_frames, optional capture interval.
  • Plugins: SimPlugin (mode sets), SimRuntimePlugin (default runtime resources); app crates wire their own systems (e.g., their AppSystemsPlugin).
  • Modules: camera/controls, autopilot_types/recorder_types, probe_types.

How to use (in your app repo)

  1. Build the base app via sim_core::build_app(SimConfig { .. }).
  2. Add plugins: SimPlugin, SimRuntimePlugin, plus your app systems plugin and any app-specific bootstrap (e.g., environment).
  3. If you need inference, add detector resources/systems in an inference-only branch (ModeSet::Inference).
  4. Bins set SimRunMode through CLI (sim/datagen/inference) and pass headless/output/prune/max_frames via SimConfig.

Adding systems

  • Common systems: add to ModeSet::Common.

  • Sim/datagen-only: add to ModeSet::SimDatagen.

  • Inference-only: add to ModeSet::Inference. Use SimRuntimePlugin to keep registration in one place; avoid detector wiring here to keep the core crate lean. Recorder metadata/sink/world-state live here (recorder_meta); apps provide world-state updates and can inject custom sinks.

License

Apache-2.0 (see LICENSE in the repo root).

Commit count: 361

cargo fmt