30 releases
new 0.9.5 | Feb 12, 2025 |
---|---|
0.9.0-alpha.9 | Jan 28, 2025 |
0.8.0 | Dec 3, 2024 |
0.8.0-alpha.1 | Nov 10, 2024 |
0.1.2 | Oct 8, 2022 |
#207 in Game dev
1,631 downloads per month
1.5MB
34K
SLoC
[^2]
[^3]
Bevy Scripting
Although Bevy doesn't directly support scripting, efforts are underway to incorporate it. This crate represents an initial attempt to enable scripting within Bevy's existing framework. It's important to note that this is a work in progress and not yet optimized or complete. As Bevy evolves, significant changes to this API are anticipated.
Why Use Scripts?
- Update your game mechanics without the need for re-compiling
- Encapsulating game logic in scripts paves way for modders to create custom content easilly
- Scripting game logic/UI in a simpler language broadens development accessibility to non-programmers on your team
Features
- Script management via commands
- Hot loading
- Support for multiple scripting languages
- All script bindings managed in one place (
ScriptDynamicFunctionRegistry
) - Customizable event driven communication between bevy and scripts (
on_update
,on_init
etc..) - Automatically generated bevy bindings
Documentation generationtemporarilly on hold[^1]
Support
The languages currently supported are as follows:
Language |
---|
Lua |
Lua51 |
Lua52 |
Lua53 |
Lua54 |
Luajit |
Luajit52 |
Luau |
Rhai |
Documentation
For examples, installation and usage instructions see our shiny new book
Bevy Compatibility
bevy_mod_scripting | bevy |
---|---|
0.9.1 | 0.15.1 |
0.9 | 0.15.0 |
0.8 | 0.15.0 |
0.7 | 0.14 |
0.6 | 0.13.1 |
Supported Platforms
platform | is supported? |
---|---|
Windows | yes |
Linux | yes |
MacOS | yes |
WASM | no, see this issue |
[^1]: Due to the recent re-write of the crate, documentation generation as well as rune support are temporarilly on hold. They will likely be re-implemented in the future.
[^2]: the coverage does not include generated bindings.
[^3]: The crate strictly enforces no unwrap
, expect
, panic
or todo
's via clippy lints.
Dependencies
~56–89MB
~1.5M SLoC