Merge branch 'main' into feat/static-scripts

Author: makspll

.github/workflows/missing-documentation-reminder.yml

@@ -0,0 +1,58 @@
+name: Missing Documentation Reminder
+
+on:
+  workflow_dispatch:
+  pull_request:
+    types:
+      - edited
+      - closed
+
+jobs:
+  find-missing-documentation:
+    permissions:
+      contents: read
+      pull-requests: read
+      issues: write
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Find closed PRs with 'needs documentation' label
+        uses: actions/github-script@v6
+        id: find-prs
+        with:
+          script: |
+
+            const query = `repo:makspll/bevy_mod_scripting is:pr is:merged is:closed label:"needs documentation"`;
+            const encodedQuery = encodeURIComponent(query);
+
+            console.log(encodedQuery);
+
+            const { data: { items: pullRequests } } = await github.rest.search.issuesAndPullRequests({
+              q: query,
+              per_page: 100
+            });
+
+            console.log(pullRequests)
+
+            const prsNeedingDocs = pullRequests.map(pr => `- [ ] ${pr.html_url} by @${pr.user.login}`).join("\n");
+            if (!prsNeedingDocs) {
+              return "- [x] All PRs with 'needs documentation' label have been updated in the book.";
+            } else {
+              return prsNeedingDocs;
+            }
+          result-encoding: string
+          
+      - name: Update Issue Body
+        uses: julien-deramond/update-issue-body@v1
+        with:
+          issue-number: 255
+          body: |
+            This is an automatically generated issue.
+            
+            The following PRs have been closed but still need updates in the book:
+            ${{ steps.find-prs.outputs.result }}
+
+            If you are an author of one of these PRs, please consider updating the boook in `/docs` with appropriate documentation.
+            Thank you!
+          edit-mode: replace

CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## [0.9.2](https://github.com/makspll/bevy_mod_scripting/compare/v0.9.1...v0.9.2) - 2025-02-08
+
+### Added
+
+- make `extractors` module non-public (#251)
+
+### Fixed
+
+- add missing extensions in the asset loader (#254)
+
 ## [0.9.1](https://github.com/makspll/bevy_mod_scripting/compare/v0.9.0...v0.9.1) - 2025-02-01
 
 ### Fixed

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "bevy_mod_scripting"
-version = "0.9.1"
+version = "0.9.2"
 authors = ["Maksymilian Mozolewski <makspl17@gmail.com>"]
 edition = "2021"
 license = "MIT OR Apache-2.0"
@@ -53,15 +53,15 @@ rhai = ["bevy_mod_scripting_rhai"]
 [dependencies]
 bevy = { workspace = true }
 bevy_mod_scripting_core = { workspace = true }
-bevy_mod_scripting_lua = { path = "crates/languages/bevy_mod_scripting_lua", version = "0.9.1", optional = true }
-bevy_mod_scripting_rhai = { path = "crates/languages/bevy_mod_scripting_rhai", version = "0.9.1", optional = true }
+bevy_mod_scripting_lua = { path = "crates/languages/bevy_mod_scripting_lua", version = "0.9.2", optional = true }
+bevy_mod_scripting_rhai = { path = "crates/languages/bevy_mod_scripting_rhai", version = "0.9.2", 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 }
 [workspace.dependencies]
 profiling = { version = "1.0" }
 bevy = { version = "0.15.1", default-features = false }
-bevy_mod_scripting_core = { path = "crates/bevy_mod_scripting_core", version = "0.9.1" }
-bevy_mod_scripting_functions = { path = "crates/bevy_mod_scripting_functions", version = "0.9.1", default-features = false }
+bevy_mod_scripting_core = { path = "crates/bevy_mod_scripting_core", version = "0.9.2" }
+bevy_mod_scripting_functions = { path = "crates/bevy_mod_scripting_functions", version = "0.9.2", default-features = false }
 
 # test utilities
 script_integration_test_harness = { path = "crates/script_integration_test_harness" }

crates/bevy_mod_scripting_core/CHANGELOG.md

@@ -7,6 +7,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.9.2](https://github.com/makspll/bevy_mod_scripting/compare/bevy_mod_scripting_core-v0.9.1...bevy_mod_scripting_core-v0.9.2) - 2025-02-08
+
+### Added
+
+- make `extractors` module non-public (#251)
+
+### Fixed
+
+- add missing extensions in the asset loader (#254)
+
 ## [0.9.0-alpha.9](https://github.com/makspll/bevy_mod_scripting/compare/bevy_mod_scripting_core-v0.9.0-alpha.8...bevy_mod_scripting_core-v0.9.0-alpha.9) - 2025-01-28
 
 ### Fixed

crates/bevy_mod_scripting_core/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "bevy_mod_scripting_core"
-version = "0.9.1"
+version = "0.9.2"
 authors = ["Maksymilian Mozolewski <makspl17@gmail.com>"]
 edition = "2021"
 license = "MIT OR Apache-2.0"
@@ -43,6 +43,7 @@ derivative = "2.2"
 profiling = { workspace = true }
 [dev-dependencies]
 test_utils = { workspace = true }
+tokio = { version = "1", features = ["rt", "macros"] }
 
 [lints]
 workspace = true

crates/bevy_mod_scripting_core/src/asset.rs

@@ -112,6 +112,12 @@ pub struct ScriptAssetSettings {
     pub script_id_mapper: AssetPathToScriptIdMapper,
     /// Strategies for mapping asset paths to languages
     pub script_language_mappers: Vec<AssetPathToLanguageMapper>,
+
+    /// The currently supported asset extensions
+    /// Should be updated by each scripting plugin to include the extensions it supports.
+    ///
+    /// Will be used to populate the script asset loader with the supported extensions
+    pub supported_extensions: &'static [&'static str],
 }
 
 impl ScriptAssetSettings {
@@ -136,6 +142,7 @@ impl Default for ScriptAssetSettings {
                 map: (|path: &AssetPath| path.path().to_string_lossy().into_owned().into()),
             },
             script_language_mappers: vec![],
+            supported_extensions: &[],
         }
     }
 }
@@ -374,6 +381,7 @@ mod tests {
 
     fn make_test_settings() -> ScriptAssetSettings {
         ScriptAssetSettings {
+            supported_extensions: &[],
             script_id_mapper: AssetPathToScriptIdMapper {
                 map: |path| path.path().to_string_lossy().into_owned().into(),
             },

crates/bevy_mod_scripting_core/src/event.rs

@@ -122,6 +122,8 @@ pub enum Recipients {
     Script(ScriptId),
     /// The event is to be handled by all the scripts on the specified entity
     Entity(Entity),
+    /// The event is to be handled by all the scripts of one language
+    Language(crate::asset::Language),
 }
 
 /// A callback event meant to trigger a callback in a subset/set of scripts in the world with the given arguments

crates/bevy_mod_scripting_core/src/handler.rs

@@ -138,6 +138,11 @@ pub(crate) fn event_handler_internal<L: IntoCallbackLabel, P: IntoScriptPluginPa
                     crate::event::Recipients::Entity(target_entity) if target_entity != entity => {
                         continue
                     }
+                    crate::event::Recipients::Language(target_language)
+                        if *target_language != P::LANGUAGE =>
+                    {
+                        continue
+                    }
                     _ => (),
                 }
                 let script = match res_ctxt.scripts.scripts.get(script_id) {

crates/bevy_mod_scripting_core/src/lib.rs

@@ -24,14 +24,15 @@ use handler::{CallbackSettings, HandlerFn};
 use runtime::{initialize_runtime, Runtime, RuntimeContainer, RuntimeInitializer, RuntimeSettings};
 use script::{ScriptId, Scripts, StaticScripts};
 
+mod extractors;
+
 pub mod asset;
 pub mod bindings;
 pub mod commands;
 pub mod context;
 pub mod docgen;
 pub mod error;
 pub mod event;
-pub mod extractors;
 pub mod handler;
 pub mod reflection_extensions;
 pub mod runtime;
@@ -56,6 +57,10 @@ pub enum ScriptingSystemSet {
 
 /// Types which act like scripting plugins, by selecting a context and runtime
 /// Each individual combination of context and runtime has specific infrastructure built for it and does not interact with other scripting plugins
+///
+/// When implementing a new scripting plugin, also ensure the following implementations exist:
+/// - [`Plugin`] for the plugin, both [`Plugin::build`] and [`Plugin::finish`] methods need to be dispatched to the underlying [`ScriptingPlugin`] struct
+/// - [`AsMut<ScriptingPlugin<Self>`] for the plugin struct
 pub trait IntoScriptPluginParams: 'static {
     /// The language of the scripts
     const LANGUAGE: Language;
@@ -86,6 +91,9 @@ pub struct ScriptingPlugin<P: IntoScriptPluginParams> {
     pub context_initializers: Vec<ContextInitializer<P>>,
     /// initializers for the contexts run every time before handling events
     pub context_pre_handling_initializers: Vec<ContextPreHandlingInitializer<P>>,
+
+    /// Supported extensions to be added to the asset settings without the dot
+    pub supported_extensions: &'static [&'static str],
 }
 
 impl<P: IntoScriptPluginParams> Plugin for ScriptingPlugin<P> {
@@ -110,6 +118,8 @@ impl<P: IntoScriptPluginParams> Plugin for ScriptingPlugin<P> {
         // add extension for the language to the asset loader
         once_per_app_init(app);
 
+        app.add_supported_script_extensions(self.supported_extensions);
+
         app.world_mut()
             .resource_mut::<ScriptAssetSettings>()
             .as_mut()
@@ -118,6 +128,10 @@ impl<P: IntoScriptPluginParams> Plugin for ScriptingPlugin<P> {
 
         register_types(app);
     }
+
+    fn finish(&self, app: &mut App) {
+        once_per_app_finalize(app);
+    }
 }
 
 impl<P: IntoScriptPluginParams> ScriptingPlugin<P> {
@@ -200,6 +214,33 @@ impl<P: IntoScriptPluginParams + AsMut<ScriptingPlugin<P>>> ConfigureScriptPlugi
     }
 }
 
+fn once_per_app_finalize(app: &mut App) {
+    #[derive(Resource)]
+    struct BMSFinalized;
+
+    if app.world().contains_resource::<BMSFinalized>() {
+        return;
+    }
+    app.insert_resource(BMSFinalized);
+
+    // read extensions from asset settings
+    let asset_settings_extensions = app
+        .world_mut()
+        .get_resource_or_init::<ScriptAssetSettings>()
+        .supported_extensions;
+
+    // convert extensions to static array
+    bevy::log::info!(
+        "Initializing BMS with Supported extensions: {:?}",
+        asset_settings_extensions
+    );
+
+    app.register_asset_loader(ScriptAssetLoader {
+        extensions: asset_settings_extensions,
+        preprocessor: None,
+    });
+}
+
 // One of registration of things that need to be done only once per app
 fn once_per_app_init(app: &mut App) {
     #[derive(Resource)]
@@ -208,7 +249,6 @@ fn once_per_app_init(app: &mut App) {
     if app.world().contains_resource::<BMSInitialized>() {
         return;
     }
-
     app.insert_resource(BMSInitialized);
 
     app.add_event::<ScriptErrorEvent>()
@@ -217,11 +257,7 @@ fn once_per_app_init(app: &mut App) {
         .init_resource::<Scripts>()
         .init_resource::<StaticScripts>()
         .init_asset::<ScriptAsset>()
-        .init_resource::<AppScriptFunctionRegistry>()
-        .register_asset_loader(ScriptAssetLoader {
-            extensions: &[],
-            preprocessor: None,
-        });
+        .init_resource::<AppScriptFunctionRegistry>();
 
     app.add_systems(
         PostUpdate,
@@ -279,6 +315,7 @@ impl AddRuntimeInitializer for App {
     }
 }
 
+
 /// Trait for adding static scripts to an app
 pub trait ManageStaticScripts {
     /// Registers a script id as a static script.
@@ -303,3 +340,63 @@ impl ManageStaticScripts for App {
         self
     }
 }
+
+/// Trait for adding a supported extension to the script asset settings.
+///
+/// This is only valid in the plugin building phase, as the asset loader will be created in the `finalize` phase.
+/// Any changes to the asset settings after that will not be reflected in the asset loader.
+pub trait ConfigureScriptAssetSettings {
+    /// Adds a supported extension to the asset settings
+    fn add_supported_script_extensions(&mut self, extensions: &[&'static str]) -> &mut Self;
+}
+
+impl ConfigureScriptAssetSettings for App {
+    fn add_supported_script_extensions(&mut self, extensions: &[&'static str]) -> &mut Self {
+        let mut asset_settings = self
+            .world_mut()
+            .get_resource_or_init::<ScriptAssetSettings>();
+
+        let mut new_arr = Vec::from(asset_settings.supported_extensions);
+
+        new_arr.extend(extensions);
+
+        let new_arr_static = Vec::leak(new_arr);
+
+        asset_settings.supported_extensions = new_arr_static;
+
+        self
+    }
+}
+
+#[cfg(test)]
+mod test {
+    use super::*;
+
+    #[tokio::test]
+    async fn test_asset_extensions_correctly_accumulate() {
+        let mut app = App::new();
+        app.init_resource::<ScriptAssetSettings>();
+        app.add_plugins(AssetPlugin::default());
+
+        app.world_mut()
+            .resource_mut::<ScriptAssetSettings>()
+            .supported_extensions = &["lua", "rhai"];
+
+        once_per_app_finalize(&mut app);
+
+        let asset_loader = app
+            .world()
+            .get_resource::<AssetServer>()
+            .expect("Asset loader not found");
+
+        asset_loader
+            .get_asset_loader_with_extension("lua")
+            .await
+            .expect("Lua loader not found");
+
+        asset_loader
+            .get_asset_loader_with_extension("rhai")
+            .await
+            .expect("Rhai loader not found");
+    }
+}

crates/bevy_mod_scripting_functions/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "bevy_mod_scripting_functions"
-version = "0.9.1"
+version = "0.9.2"
 edition = "2021"
 authors = ["Maksymilian Mozolewski <makspl17@gmail.com>"]
 license = "MIT OR Apache-2.0"