bevywasmscripting
Adds support for wasm/wat assets in Bevy, and enables easy scripting. This is enabled through the wasmer crate.
- [ ] Prepare for public use. This is very experimental! Please share any feedback in the Bevy Discord!
- [x] Scripts managed through bevy asset management
- [x] Scripts attached to components
- [x] Scripts attached to resources
- [x] Hot-reloading of component- and resource-based scripts
- [x] [Basic examples](examples)
- [x] Harmonize resource- and component-based scripts, as they could both be simpler to define.
- [ ] Put this through its paces with a game project, to find pain points
- [ ] Confirm safety of
WorldPointer imports strategy.
- [ ] Investigate compilation performance and multi-threading options.
- [ ] Investigate memory usage.
- [x] Investigate cooperation with web builds.
- [ ] Configuration for Wasmer Tunables.
- [ ] Configuration for Wasmer compiler. (The
Cranelift compiler is currently hardcoded.)
- [ ] Example game (probably a breakout clone with powerups)
- [ ] Rust -> wasm script example
- [ ] Lua -> wasm script example
- [ ] Other language examples?
Examples
For component-based scripts:
```rust
fn main() {
App::new()
...
.addplugin(WasmPlugin)
.addwasmscriptcomponent::()
.addstartupsystem(spawnscriptentity)
.addsystem(callscriptonentity)
...
}
impl WasmScriptComponent for AdderScript {
type ImportQueriedComponents = ();
type ImportResources = ();
fn getwasmscript_handle(&self) -> &Handle {
&self.handle
}
}
fn spawnscriptentity(mut commands: Commands, assetserver: Res) {
commands.spawn(AdderScript {
handle: assetserver.load("add_one.wat"),
accumulator: 0,
});
}
//
fn callscriptonentity(
mut scriptedentities: Query<&mut AdderScript>,
mut scriptenv: WasmScriptComponentEnv,
) {
for mut scriptedentity in scriptedentities.itermut() {
if let Ok(newval) = scriptenv.callifinstantiated(
&scriptedentity.handle,
"main",
scriptedentity.accumulator,
) {
scriptedentity.accumulator = newval;
}
println!("Accumulated value: {}", scripted_entity.accumulator);
}
}
```
More examples, for hot reloading, resource-based scripts, and script imports, are available in the examples directory.
Web Build Example
You can run the breakout example, very similar to the bevy examples:
sh
cargo build --release --example breakout --target wasm32-unknown-unknown --features js --no-default-features
wasm-bindgen --out-name wasm_example --out-dir examples/wasm/target --target web target/wasm32-unknown-unknown/release/examples/breakout.wasm
basic-http-server examples/wasm