Crates.io | bevy_simple_subsecond_system |
lib.rs | bevy_simple_subsecond_system |
version | 0.2.0 |
created_at | 2025-05-20 00:31:06.366967+00 |
updated_at | 2025-06-02 16:20:27.207512+00 |
description | Hotpatch your Bevy systems, allowing you to change their code while the app is running and directly seeing the results! |
homepage | |
repository | https://github.com/janhohenheim/bevy_simple_subsecond_system |
max_upload_size | |
id | 1680589 |
size | 204,390 |
Hotpatch your Bevy systems and observers, allowing you to change their code while the app is running and directly see the results! This is an intermediate solution you can use until Bevy implements this feature upstream.
Powered by Dioxus' subsecond
Please report all hotpatch-related problems to them :)
https://github.com/user-attachments/assets/a44e446b-b2bb-4e10-81c3-3f20cccadea0
First, we need to install the Dioxus CLI of the newest alpha build.
cargo install dioxus-cli@0.7.0-alpha.1
Building the CLI like this can take a while. To speed this up, consider setting up cargo-binstall first.
Depending on your OS, you'll have to set up your environment a bit more:
For some users, this should work out of the box on Windows
If that happens, move your crate closer to your drive, e.g. C:\my_crate
.
If that is not enough, create or edit either a global ~\.cargo\config.toml
or a local .\.cargo\config.toml
with this config:
[profile.dev]
codegen-units = 1
Note that this may increase compile times significantly if your crate is very large.
When changing this number, always run cargo clean
before rebuilding.
If you can verify that this solved your issue,
try increasing this number until you find a happy middle ground. For reference, the default number
for incremental builds is 256
, and for non-incremental builds 16
.
You're in luck! Everything should work out of the box if you use the default system linker.
Prerequisites: clang
and either lld
(recommended) or mold
(faster, but less stable)
Create or edit either a global ~/.cargo/config.toml
or a local ./.cargo/config.toml
with this minimal config
[target.x86_64-unknown-linux-gnu]
linker = "clang"
rustflags = [
"-C",
"link-arg=-fuse-ld=lld",
]
⚠️ WARNING In the past we recommended symlinking mold over /usr/bin/ld Please make sure to undo this to avoid issues with your installation cause by incompatibilities, such as DKMS failing to load modules
rustup component add rustc-codegen-cranelift-preview --toolchain nightly
~/.cargo/config.toml
or local ./.cargo/config.toml
:[unstable]
codegen-backend = true
[profile]
incremental = true
[profile.dev]
codegen-backend = "cranelift"
debug = "line-tables-only"
[profile.dev.package."*"]
codegen-backend = "llvm"
[profile.test.package."*"]
codegen-backend = "llvm"
[profile.release]
codegen-backend = "llvm"
[profile.web]
codegen-backend = "llvm"
[target.x86_64-unknown-linux-gnu]
linker = "clang"
rustflags = [
"-Clink-arg=-fuse-ld=mold",
"-Zshare-generics=y",
"-Zthreads=8",
]
If you run into trouble, replace mold
with lld
.
This repo also includes ./.cargo/config_faster_builds.toml
which contains more advanced compile-time improving configs known to work with subsecond.
Add the crate to your dependencies.
cargo add bevy_simple_subsecond_system
Then add the plugin to your app and annotate any system you want with #[hot]
:
use bevy::prelude::*;
use bevy_simple_subsecond_system::prelude::*;
fn main() -> AppExit {
App::new()
.add_plugins(DefaultPlugins)
.add_plugins(SimpleSubsecondPlugin::default())
.add_systems(Update, greet)
.run()
}
#[hot]
fn greet(time: Res<Time>) {
info_once!(
"Hello from a hotpatched system! Try changing this string while the app is running! Patched at t = {} s",
time.elapsed_secs()
);
}
Now run your app with
BEVY_ASSET_ROOT="." dx serve --hot-patch
or on Windows' PowerShell
$env:BEVY_ASSET_ROOT="." ; dx serve --hot-patch
Now try changing that string at runtime and then check your logs!
Note that changing the greet
function's signature at runtime by e.g. adding a new parameter will still require a restart.
In general, you can only change the code inside the function at runtime. See the Advanced Usage section for more.
Run the examples with
BEVY_ASSET_ROOT="." dx serve --hot-patch --example name_of_the_example
e.g.
BEVY_ASSET_ROOT="." dx serve --hot-patch --example patch_on_update
#[hot]
attribute#[hot]
attribute does simply nothing on such builds.World
yet.
Resource
s and Component
s of your system at runtimelib.rs
or a workspace setup.bevy_mod_debugdump
still work? Maybe. Let me know!A
that calls a function B
,
changing B
will only work at runtime if that function existed already when the app was launched.In general, rust-analyzer will play nice with the #[hot]
attribute.
If you're running into issues, you can configure your editor like this:
"rust-analyzer.procMacro.ignored": {
"bevy_simple_subsecond_system_macros": [
"hot"
]
},
"rust-analyzer.diagnostics.disabled": [
"proc-macro-disabled"
]
lspconfig.rust_analyzer.setup({
capabilities = capabilities,
settings = {
["rust-analyzer"] = {
procMacro = {
ignored = {
bevy_simple_subsecond_system_macros = { "hot" },
},
},
diagnostics = {
disabled = { "proc-macro-disabled" },
},
},
},
})
There are some more things you can hot-patch, but they come with extra caveats right now
#[hot(rerun_on_hot_patch)]
or #[hot(hot_patch_signature)]
on a system that uses any of the following:
EventReader
Local
Added
, Changed
, or Spawned
#[hot(rerun_on_hot_patch)]
or #[hot(hot_patch_signature)]
commented out to indicate thisHotPatchMigrate
), changing definitions of the types used as fields of the components isn't supported. It might work in some cases but most probably will be an undefined behaviourUI is often spawned in Startup
or OnEnter
schedules. Hot-patching such setup systems would be fairly useless, as they wouldn't run again.
For this reason, the plugin supports automatically rerunning systems that have been hot-patched. To opt-in, replace #[hot]
with #[hot(rerun_on_hot_patch = true)]
.
See the rerun_setup
example for detailed instructions.
Replace #[hot]
with #[hot(hot_patch_signature = true)]
to allow changing a system's signature at runtime.
This allows you to e.g. add additional Query
or Res
parameters or modify existing ones.
bevy | bevy_simple_subsecond_system |
---|---|
0.16 | 0.2 |