Merge branch 'main' of https://github.com/makspll/bevy_mod_scripting

Author: pro470

.github/workflows/bencher_on_pr_or_fork.yml

@@ -0,0 +1,34 @@
+name: Run benchmarks on PR
+
+on:
+  pull_request:
+    types: [opened, reopened, edited, synchronize]
+
+jobs:
+  benchmark_fork_pr_branch:
+    name: Run Fork PR Benchmarks
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Rust Cache
+        uses: Swatinem/[email protected]
+        with:
+          # reasoning: we want to cache xtask, most of the jobs in the matrix will be sped up a good bit thanks to that 
+          save-if: ${{ github.ref == 'refs/heads/main' }}
+          cache-all-crates: true
+      - name: Run `cargo xtask init`
+        run: |
+          cargo xtask init
+      - name: Run `cargo xtask bench` and save results
+        run: |
+          cargo xtask bench > benchmark_results.txt
+      - name: Upload Benchmark Results
+        uses: actions/upload-artifact@v4
+        with:
+          name: benchmark_results.txt
+          path: ./benchmark_results.txt
+      - name: Upload GitHub Pull Request Event
+        uses: actions/upload-artifact@v4
+        with:
+          name: event.json
+          path: ${{ github.event_path }}

.github/workflows/bencher_on_pr_or_fork_closed.yml

@@ -0,0 +1,18 @@
+on:
+  pull_request_target:
+    types: [closed]
+
+jobs:
+  archive_fork_pr_branch:
+    name: Archive closed fork PR branch with Bencher
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: bencherdev/bencher@main
+      - name: Archive closed fork PR branch with Bencher
+        run: |
+          bencher archive \
+          --project bms \
+          --token '${{ secrets.BENCHER_API_TOKEN }}' \
+          --branch "$GITHUB_HEAD_REF"
+        continue-on-error: true

.github/workflows/bencher_on_pr_or_fork_upload.yml

@@ -0,0 +1,54 @@
+name: Upload benchmarks to bencher
+
+on:
+  workflow_run:
+    workflows: [Run benchmarks on PR]
+    types: [completed]
+
+permissions: write-all
+
+jobs:
+  track_fork_pr_branch:
+    if: github.event.workflow_run.conclusion == 'success'
+    runs-on: ubuntu-latest
+    env:
+      BENCHMARK_RESULTS: benchmark_results.txt
+      PR_EVENT: event.json
+    steps:
+      - name: Download Benchmark Results
+        uses: dawidd6/action-download-artifact@v6
+        with:
+          name: ${{ env.BENCHMARK_RESULTS }}
+          run_id: ${{ github.event.workflow_run.id }}
+      - name: Download PR Event
+        uses: dawidd6/action-download-artifact@v6
+        with:
+          name: ${{ env.PR_EVENT }}
+          run_id: ${{ github.event.workflow_run.id }}
+      - name: Export PR Event Data
+        uses: actions/github-script@v6
+        with:
+          script: |
+            let fs = require('fs');
+            let prEvent = JSON.parse(fs.readFileSync(process.env.PR_EVENT, {encoding: 'utf8'}));
+            core.exportVariable("PR_HEAD", prEvent.pull_request.head.ref);
+            core.exportVariable("PR_BASE", prEvent.pull_request.base.ref);
+            core.exportVariable("PR_BASE_SHA", prEvent.pull_request.base.sha);
+            core.exportVariable("PR_NUMBER", prEvent.number);
+      - uses: bencherdev/bencher@main
+      - name: Track Benchmarks with Bencher
+        run: |
+          bencher run \
+          --project bms \
+          --token '${{ secrets.BENCHER_API_TOKEN }}' \
+          --branch "$PR_HEAD" \
+          --start-point "$PR_BASE" \
+          --start-point-hash "$PR_BASE_SHA" \
+          --start-point-clone-thresholds \
+          --start-point-reset \
+          --testbed linux-gha \
+          --err \
+          --adapter rust_criterion \
+          --github-actions '${{ secrets.GITHUB_TOKEN }}' \
+          --ci-number "$PR_NUMBER" \
+          --file "$BENCHMARK_RESULTS"

.github/workflows/bevy_mod_scripting.yml

@@ -16,7 +16,9 @@ env:
   IMAGE_NAME: bevy-mod-scripting
   CODEGEN_BRANCH_NAME: __update-bevy-bindings-${{ github.head_ref || github.ref_name }}
   GH_TOKEN: ${{ github.token }}
-
+  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+  BENCHER_API_TOKEN: ${{ secrets.BENCHER_API_TOKEN }}
+  
 concurrency:
   # Use github.run_id on main branch
   # Use github.event.pull_request.number on pull requests, so it's unique per pull request
@@ -79,6 +81,7 @@ jobs:
       pull-requests: write
       contents: write
       issues: write
+      checks: write
     name: Check - ${{ matrix.run_args.name }}
     runs-on: ${{ matrix.run_args.os }}
     strategy:

.github/workflows/mdbook.yml

@@ -9,13 +9,15 @@ on:
       - 'docs/**'
       - 'crates/xtask/**'
       - '.github/workflows/mdbook.yml'
+      - 'crates/bevy_mod_scripting_functions/**'
   pull_request:
     branches:
       - "**"
     paths:
       - 'docs/**'
       - 'crates/xtask/**'
       - '.github/workflows/mdbook.yml'
+      - 'crates/bevy_mod_scripting_functions/**'
 
 jobs:
 

.github/workflows/pr-titles.yml

@@ -27,8 +27,9 @@ jobs:
             test
             docs
             refactor
+            perf
 
           scopes: |
             ladfile
             ladfile_builder
-            bms
+            bms

CHANGELOG.md

@@ -1,5 +1,54 @@
 # Changelog
 
+## [0.12.0](https://github.com/makspll/bevy_mod_scripting/compare/v0.11.1...v0.12.0) - 2025-04-07
+
+### Added
+
+- improve errors when entity is unavailable ([#410](https://github.com/makspll/bevy_mod_scripting/pull/410))
+- [**breaking**] Add `BMSPlugin` group, feature flag for bindings per bevy crate & add script global filter options ([#408](https://github.com/makspll/bevy_mod_scripting/pull/408))
+    - The CoreScriptGlobalsPlugin now also stores options for filtering registered globals, which can be changed.
+- add option to emit response event on each callback  & `RunScriptCallback` command for "once-off" callbacks ([#403](https://github.com/makspll/bevy_mod_scripting/pull/403))
+### Fixed
+
+- `lua54` feature being forced ([#413](https://github.com/makspll/bevy_mod_scripting/pull/413))
+- `GetTypeDependency` derive macro using the wrong path for `bms_core` ([#409](https://github.com/makspll/bevy_mod_scripting/pull/409))
+
+### Other
+
+- add script loading benchmark ([#411](https://github.com/makspll/bevy_mod_scripting/pull/411))
+- refactor `ReflectReference` internally ([#406](https://github.com/makspll/bevy_mod_scripting/pull/406))
+- reduces size of `ScriptValue` to 64 bytes, moves some dynamic function methods into function info ([#404](https://github.com/makspll/bevy_mod_scripting/pull/404))
+
+## [0.11.1](https://github.com/makspll/bevy_mod_scripting/compare/v0.11.0...v0.11.1) - 2025-03-29
+
+### Added
+
+- bump bevy to 0.15.3 ([#401](https://github.com/makspll/bevy_mod_scripting/pull/401))
+
+## [0.11.0](https://github.com/makspll/bevy_mod_scripting/compare/v0.10.0...v0.11.0) - 2025-03-29
+
+### Added
+
+- allow the conversion of lua functions into `ScriptValue` via `DynamicScriptFunction` ([#396](https://github.com/makspll/bevy_mod_scripting/pull/396))
+- improve tracing spans, add more benchmarks ([#394](https://github.com/makspll/bevy_mod_scripting/pull/394))
+- add `profile_with_tracy` feature which plays nicely with bevy's `bevy/trace_tracy` feature ([#393](https://github.com/makspll/bevy_mod_scripting/pull/393))
+- Add initial benchmarks, integrate them into CI & add getters/settters for `Scripts` resource ([#381](https://github.com/makspll/bevy_mod_scripting/pull/381))
+- :sparkles: Dynamic Script Components, `register_new_component` binding, `remove_component` no longer requires `ReflectComponent` data ([#379](https://github.com/makspll/bevy_mod_scripting/pull/379))
+- [**breaking**] optimize `get` and `set` functions, add `MagicFunctions` sub-registry ([#397](https://github.com/makspll/bevy_mod_scripting/pull/397))
+- optimize access map ([#395](https://github.com/makspll/bevy_mod_scripting/pull/395))
+- add ScriptValue override for printing opaque values ([#380](https://github.com/makspll/bevy_mod_scripting/pull/380))
+- overhaul mdbook preprocessor, prettify generated docs, support dummy globals ([#377](https://github.com/makspll/bevy_mod_scripting/pull/377))
+
+### Fixed
+
+- fix global type cache not containing generic types ([#388](https://github.com/makspll/bevy_mod_scripting/pull/388))
+
+### Other
+
+- switch to hashbrown hashmap in the function registry ([#399](https://github.com/makspll/bevy_mod_scripting/pull/399))
+- try play with hashing for access maps ([#398](https://github.com/makspll/bevy_mod_scripting/pull/398))
+- allow check creation for bencher
+
 ## [0.10.0](https://github.com/makspll/bevy_mod_scripting/compare/v0.9.11...v0.10.0) - 2025-03-16
 
 ### Added

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "bevy_mod_scripting"
-version = "0.10.0"
+version = "0.12.0"
 authors = ["Maksymilian Mozolewski <[email protected]>"]
 edition = "2021"
 license = "MIT OR Apache-2.0"
@@ -15,15 +15,28 @@ include = ["readme.md", "/src", "/examples", "/assets", "LICENSE", "/badges"]
 [lib]
 name = "bevy_mod_scripting"
 path = "src/lib.rs"
+bench = false
 
 [package.metadata."docs.rs"]
 features = ["lua54", "rhai"]
 
 [features]
-default = ["core_functions", "bevy_bindings"]
+default = [
+    "core_functions",
+    "bevy_core_bindings",
+    "bevy_ecs_bindings",
+    "bevy_hierarchy_bindings",
+    "bevy_input_bindings",
+    "bevy_math_bindings",
+    "bevy_reflect_bindings",
+    "bevy_time_bindings",
+    "bevy_transform_bindings",
+]
 
-## lua
-lua = ["bevy_mod_scripting_lua", "bevy_mod_scripting_functions/lua_bindings"]
+lua = [
+    "bevy_mod_scripting_lua",
+    "bevy_mod_scripting_functions/lua_bindings",
+] ## lua
 # one of these must be selected
 lua51 = ["bevy_mod_scripting_lua/lua51", "lua"]
 lua52 = ["bevy_mod_scripting_lua/lua52", "lua"]
@@ -35,7 +48,14 @@ luau = ["bevy_mod_scripting_lua/luau", "lua"]
 
 # bindings 
 core_functions = ["bevy_mod_scripting_functions/core_functions"]
-bevy_bindings = ["bevy_mod_scripting_functions/bevy_bindings"]
+bevy_core_bindings = ["bevy_mod_scripting_functions/bevy_core"]
+bevy_ecs_bindings = ["bevy_mod_scripting_functions/bevy_ecs"]
+bevy_hierarchy_bindings = ["bevy_mod_scripting_functions/bevy_hierarchy"]
+bevy_input_bindings = ["bevy_mod_scripting_functions/bevy_input"]
+bevy_math_bindings = ["bevy_mod_scripting_functions/bevy_math"]
+bevy_reflect_bindings = ["bevy_mod_scripting_functions/bevy_reflect"]
+bevy_time_bindings = ["bevy_mod_scripting_functions/bevy_time"]
+bevy_transform_bindings = ["bevy_mod_scripting_functions/bevy_transform"]
 
 # optional
 unsafe_lua_modules = ["bevy_mod_scripting_lua?/unsafe_lua_modules"]
@@ -50,21 +70,24 @@ rhai = ["bevy_mod_scripting_rhai", "bevy_mod_scripting_functions/rhai_bindings"]
 ## rune
 # rune = ["bevy_mod_scripting_rune"]
 
+### Profiling
+profile_with_tracy = ["bevy/trace_tracy"]
+
 [dependencies]
 bevy = { workspace = true }
 bevy_mod_scripting_core = { workspace = true }
-bevy_mod_scripting_lua = { path = "crates/languages/bevy_mod_scripting_lua", version = "0.10.0", optional = true }
-bevy_mod_scripting_rhai = { path = "crates/languages/bevy_mod_scripting_rhai", version = "0.10.0", optional = true }
+bevy_mod_scripting_lua = { path = "crates/languages/bevy_mod_scripting_lua", version = "0.12.0", optional = true }
+bevy_mod_scripting_rhai = { path = "crates/languages/bevy_mod_scripting_rhai", version = "0.12.0", optional = true }
 # bevy_mod_scripting_rune = { path = "crates/languages/bevy_mod_scripting_rune", version = "0.9.0-alpha.2", optional = true }
 bevy_mod_scripting_functions = { workspace = true }
 bevy_mod_scripting_derive = { workspace = true }
 
 [workspace.dependencies]
 profiling = { version = "1.0" }
-bevy = { version = "0.15.2", default-features = false }
-bevy_mod_scripting_core = { path = "crates/bevy_mod_scripting_core", version = "0.10.0" }
-bevy_mod_scripting_functions = { path = "crates/bevy_mod_scripting_functions", version = "0.10.0", default-features = false }
-bevy_mod_scripting_derive = { path = "crates/bevy_mod_scripting_derive", version = "0.10.0" }
+bevy = { version = "0.15.3", default-features = false }
+bevy_mod_scripting_core = { path = "crates/bevy_mod_scripting_core", version = "0.12.0" }
+bevy_mod_scripting_functions = { path = "crates/bevy_mod_scripting_functions", version = "0.12.0", default-features = false }
+bevy_mod_scripting_derive = { path = "crates/bevy_mod_scripting_derive", version = "0.12.0" }
 
 # test utilities
 script_integration_test_harness = { path = "crates/testing_crates/script_integration_test_harness" }
@@ -76,8 +99,14 @@ clap = { version = "4.1", features = ["derive"] }
 rand = "0.8.5"
 bevy_console = "0.13"
 # rhai-rand = "0.1"
+criterion = { version = "0.5" }
 ansi-parser = "0.9"
-ladfile_builder = { path = "crates/ladfile_builder", version = "0.2.6" }
+ladfile_builder = { path = "crates/ladfile_builder", version = "0.3.2" }
+script_integration_test_harness = { workspace = true }
+test_utils = { workspace = true }
+libtest-mimic = "0.8"
+tracing-tracy = "0.11"
+regex = "1.11"
 
 [workspace]
 members = [
@@ -149,3 +178,11 @@ todo = "deny"
 
 [workspace.lints.rust]
 missing_docs = "deny"
+
+[[bench]]
+name = "benchmarks"
+harness = false
+
+[[test]]
+name = "script_tests"
+harness = false

assets/benchmarks/component/access.lua

@@ -0,0 +1,5 @@
+local entity_with_component = world._get_entity_with_test_component("TestComponent")
+
+function bench()
+    local strings = world.get_component(entity_with_component, types.TestComponent).strings
+end

assets/benchmarks/component/access.rhai

@@ -0,0 +1,5 @@
+let entity_with_component = world._get_entity_with_test_component.call("TestComponent");
+
+fn bench(){
+    let strings = world.get_component.call(entity_with_component, types.TestComponent).strings;
+}