Add annotations about Ruby only being supported on Linux (#64)

* Don't check for rdynamic linking on Windows for now, fixes Windows builds

---------

Co-authored-by: Jaroslaw Konik <konikjar@gmail.com>

.github/workflows/book.yml

@@ -0,0 +1,54 @@
+name: Book
+
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+    branches: ["main"]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Cache Ruby
+        id: cache-ruby
+        uses: actions/cache@v4
+        with:
+          path: rubies
+          key: ${{ runner.os }}-ruby
+      - name: Install Ruby
+        if: steps.cache-ruby.outputs.cache-hit != 'true'
+        env:
+          CC: clang
+        run: |
+          url="https://cache.ruby-lang.org/pub/ruby/3.4/ruby-3.4.4.tar.gz"
+          prefix=`pwd`/rubies/ruby-3.4
+          mkdir rubies
+          mkdir ruby_src
+          curl -sSL $url | tar -xz
+          cd ruby-3.4.4
+          mkdir build
+          cd build
+          ../configure --without-shared --prefix=$prefix
+          make install
+          echo $prefix/bin >> $GITHUB_PATH
+      - name: Add Ruby to PATH
+        run: |
+          prefix=`pwd`/rubies/ruby-3.4
+          echo $prefix/bin >> $GITHUB_PATH
+      - name: Install latest mdbook
+        run: |
+          tag=$(curl 'https://api.github.com/repos/rust-lang/mdbook/releases/latest' | jq -r '.tag_name')
+          url="https://github.com/rust-lang/mdbook/releases/download/${tag}/mdbook-${tag}-x86_64-unknown-linux-gnu.tar.gz"
+          mkdir mdbook
+          curl -sSL $url | tar -xz --directory=./mdbook
+          echo `pwd`/mdbook >> $GITHUB_PATH
+      - name: Test Book
+        run: |
+          cd book
+          export CARGO_MANIFEST_DIR=$(pwd)
+          cargo build
+          mdbook test -L target/debug/deps/

.github/workflows/deploy_book.yml

@@ -0,0 +1,38 @@
+name: Deploy book
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write  # To push a branch
+      pages: write  # To push to a GitHub Pages site
+      id-token: write # To update the deployment status
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Install latest mdbook
+        run: |
+          tag=$(curl 'https://api.github.com/repos/rust-lang/mdbook/releases/latest' | jq -r '.tag_name')
+          url="https://github.com/rust-lang/mdbook/releases/download/${tag}/mdbook-${tag}-x86_64-unknown-linux-gnu.tar.gz"
+          mkdir mdbook
+          curl -sSL $url | tar -xz --directory=./mdbook
+          echo `pwd`/mdbook >> $GITHUB_PATH
+      - name: Build Book
+        run: |
+          cd book
+          mdbook build
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          # Upload entire repository
+          path: 'book/book'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/rust.yml

@@ -2,27 +2,48 @@ name: Rust
 
 on:
   push:
-    branches: [ "main" ]
+    branches: ["main"]
   pull_request:
-    branches: [ "main" ]
+    branches: ["main"]
 
 env:
   CARGO_TERM_COLOR: always
 
 jobs:
   build:
-
     runs-on: ubuntu-latest
-
+    env:
+      RUSTFLAGS: -D warnings
     steps:
-    - uses: actions/checkout@v3
-    - name: Clippy
-      run: cargo clippy --verbose -- -D warnings
-    - name: Build
-      run: cargo build --verbose
-    - name: Run tests
-      run: cargo test --verbose
-    - name: Install cargo-examples
-      run: cargo install cargo-examples
-    - name: Run all examples
-      run: cargo examples
+      - uses: actions/checkout@v3
+      - name: Cache Ruby
+        id: cache-ruby
+        uses: actions/cache@v4
+        with:
+          path: rubies
+          key: ${{ runner.os }}-ruby
+      - name: Install Ruby
+        if: steps.cache-ruby.outputs.cache-hit != 'true'
+        env:
+          CC: clang
+        run: |
+          url="https://cache.ruby-lang.org/pub/ruby/3.4/ruby-3.4.4.tar.gz"
+          prefix=`pwd`/rubies/ruby-3.4
+          mkdir rubies
+          mkdir ruby_src
+          curl -sSL $url | tar -xz
+          cd ruby-3.4.4
+          mkdir build
+          cd build
+          ../configure --without-shared --prefix=$prefix
+          make install
+      - name: Add Ruby to PATH
+        run: |
+          prefix=`pwd`/rubies/ruby-3.4
+          echo $prefix/bin >> $GITHUB_PATH
+      - name: Clippy
+        run: cargo clippy --all-features --verbose -- -D warnings
+      - name: Build
+        run: cargo build --all-features --verbose
+      - name: Run tests
+        run: cargo test --all-features --verbose

.gitignore

@@ -1,3 +1,4 @@
 /target
 /Cargo.lock
 .vscode
+.nvim.lua

Cargo.toml

@@ -1,22 +1,217 @@
 [package]
 name = "bevy_scriptum"
 authors = ["Jaroslaw Konik <konikjar@gmail.com>"]
-version = "0.4.0"
-edition = "2021"
+version = "0.9.1"
+edition = "2024"
 license = "MIT OR Apache-2.0"
 readme = "README.md"
 categories = ["game-development"]
-description = "Plugin for Bevy engine that allows you to write some of your game logic in a scripting language"
+description = "Plugin for Bevy engine that allows you to write some of your game or application logic in a scripting language"
 repository = "https://github.com/jarkonik/bevy_scriptum"
-keywords = ["bevy", "rhai", "scripting", "game", "gamedev"]
+keywords = ["bevy", "lua", "scripting", "game", "script"]
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+[features]
+lua = ["dep:mlua", "mlua/luajit"]
+rhai = ["dep:rhai"]
+ruby = ["dep:magnus", "dep:rb-sys"]
 
 [dependencies]
-bevy = { default-features = false, version = "0.13.0", features = [
-    "bevy_asset",
-] }
+bevy = { default-features = false, version = "0.16", features = ["bevy_asset", "bevy_log"] }
 serde = "1.0.162"
-rhai = { version = "1.14.0", features = ["sync", "internals", "unchecked"] }
+rhai = { version = "1.14.0", features = [
+    "sync",
+    "internals",
+    "unchecked",
+], optional = true }
 thiserror = "1.0.40"
 anyhow = "1.0.82"
+tracing = "0.1.40"
+mlua = { version = "0.9.8", features = [
+    "luajit",
+    "vendored",
+    "send",
+], optional = true }
+magnus = { version = "0.7.1", optional = true }
+rb-sys = { version = "0.9", default-features = false, features = ["link-ruby", "ruby-static"], optional = true }
+crossbeam-channel = "0.5.15"
+libc = "0.2.172"
+
+[[example]]
+name = "call_function_from_rust_rhai"
+path = "examples/rhai/call_function_from_rust.rs"
+required-features = ["rhai"]
+
+[[example]]
+name = "current_entity_rhai"
+path = "examples/rhai/current_entity.rs"
+required-features = ["rhai"]
+
+[[example]]
+name = "custom_type_rhai"
+path = "examples/rhai/custom_type.rs"
+required-features = ["rhai"]
+
+[[example]]
+name = "ecs_rhai"
+path = "examples/rhai/ecs.rs"
+required-features = ["rhai"]
+
+[[example]]
+name = "entity_variable_rhai"
+path = "examples/rhai/entity_variable.rs"
+required-features = ["rhai"]
+
+[[example]]
+name = "function_params_rhai"
+path = "examples/rhai/function_params.rs"
+required-features = ["rhai"]
+
+[[example]]
+name = "hello_world_rhai"
+path = "examples/rhai/hello_world.rs"
+required-features = ["rhai"]
+
+[[example]]
+name = "multiple_plugins_rhai"
+path = "examples/rhai/multiple_plugins.rs"
+required-features = ["rhai"]
+
+[[example]]
+name = "non_closure_system_rhai"
+path = "examples/rhai/non_closure_system.rs"
+required-features = ["rhai"]
+
+[[example]]
+name = "promises_rhai"
+path = "examples/rhai/promises.rs"
+required-features = ["rhai"]
+
+[[example]]
+name = "side_effects_rhai"
+path = "examples/rhai/side_effects.rs"
+required-features = ["rhai"]
+
+[[example]]
+name = "function_return_value_rhai"
+path = "examples/rhai/function_return_value.rs"
+required-features = ["rhai"]
+
+[[example]]
+name = "call_function_from_rust_lua"
+path = "examples/lua/call_function_from_rust.rs"
+required-features = ["lua"]
+
+[[example]]
+name = "current_entity_lua"
+path = "examples/lua/current_entity.rs"
+required-features = ["lua"]
+
+[[example]]
+name = "custom_type_lua"
+path = "examples/lua/custom_type.rs"
+required-features = ["lua"]
+
+[[example]]
+name = "ecs_lua"
+path = "examples/lua/ecs.rs"
+required-features = ["lua"]
+
+[[example]]
+name = "entity_variable_lua"
+path = "examples/lua/entity_variable.rs"
+required-features = ["lua"]
+
+[[example]]
+name = "function_params_lua"
+path = "examples/lua/function_params.rs"
+required-features = ["lua"]
+
+[[example]]
+name = "hello_world_lua"
+path = "examples/lua/hello_world.rs"
+required-features = ["lua"]
+
+[[example]]
+name = "multiple_plugins_lua"
+path = "examples/lua/multiple_plugins.rs"
+required-features = ["lua"]
+
+[[example]]
+name = "non_closure_system_lua"
+path = "examples/lua/non_closure_system.rs"
+required-features = ["lua"]
+
+[[example]]
+name = "promises_lua"
+path = "examples/lua/promises.rs"
+required-features = ["lua"]
+
+[[example]]
+name = "side_effects_lua"
+path = "examples/lua/side_effects.rs"
+required-features = ["lua"]
+
+[[example]]
+name = "function_return_value_lua"
+path = "examples/lua/function_return_value.rs"
+required-features = ["lua"]
+
+[[example]]
+name = "call_function_from_rust_ruby"
+path = "examples/ruby/call_function_from_rust.rs"
+required-features = ["ruby"]
+
+[[example]]
+name = "current_entity_ruby"
+path = "examples/ruby/current_entity.rs"
+required-features = ["ruby"]
+
+[[example]]
+name = "custom_type_ruby"
+path = "examples/ruby/custom_type.rs"
+required-features = ["ruby"]
+
+[[example]]
+name = "ecs_ruby"
+path = "examples/ruby/ecs.rs"
+required-features = ["ruby"]
+
+[[example]]
+name = "entity_variable_ruby"
+path = "examples/ruby/entity_variable.rs"
+required-features = ["ruby"]
+
+[[example]]
+name = "function_params_ruby"
+path = "examples/ruby/function_params.rs"
+required-features = ["ruby"]
+
+[[example]]
+name = "function_return_value_ruby"
+path = "examples/ruby/function_return_value.rs"
+required-features = ["ruby"]
+
+[[example]]
+name = "hello_world_ruby"
+path = "examples/ruby/hello_world.rs"
+required-features = ["ruby"]
+
+[[example]]
+name = "multiple_plugins_ruby"
+path = "examples/ruby/multiple_plugins.rs"
+required-features = ["ruby"]
+
+[[example]]
+name = "promises_ruby"
+path = "examples/ruby/promises.rs"
+required-features = ["ruby"]
+
+[[example]]
+name = "side_effects_ruby"
+path = "examples/ruby/side_effects.rs"
+required-features = ["ruby"]
+
+[dev-dependencies]
+tracing-subscriber = "0.3.18"
+mlua = { version = "0.9.8", features = ["luajit", "vendored", "send"] }
+rhai = { version = "1.14.0", features = ["sync", "internals", "unchecked"] }

README.md

@@ -1,32 +1,47 @@
 # bevy_scriptum 📜
 
-bevy_scriptum is a a plugin for [Bevy](https://bevyengine.org/) that allows you to write some of your game logic in a scripting language.
-Currently, only [Rhai](https://rhai.rs/) is supported, but more languages may be added in the future.
+![demo](demo.gif)
 
-It's main advantages include:
+bevy_scriptum is a a plugin for [Bevy](https://bevyengine.org/) that allows you to write some of your game or application logic in a scripting language.
+### Supported scripting languages/runtimes
+
+| language/runtime                           | cargo feature | documentation chapter                                           |
+| ------------------------------------------ | ------------- | --------------------------------------------------------------- |
+| 🌙 LuaJIT                                  | `lua`         | [link](https://jarkonik.github.io/bevy_scriptum/lua/lua.html)   |
+| 🌾 Rhai                                    | `rhai`        | [link](https://jarkonik.github.io/bevy_scriptum/rhai/rhai.html) |
+| 💎 Ruby(currently only supported on Linux) | `ruby`        | [link](https://jarkonik.github.io/bevy_scriptum/ruby/ruby.html) |
+
+Documentation book is available [here](https://jarkonik.github.io/bevy_scriptum/) 📖
+
+Full API docs are available at [docs.rs](https://docs.rs/bevy_scriptum/latest/bevy_scriptum/) 🧑‍💻
+
+bevy_scriptum's main advantages include:
 - low-boilerplate
 - easy to use
 - asynchronicity with a promise-based API
 - flexibility
 - hot-reloading
 
-Scripts are separate files that can be hot-reloaded at runtime. This allows you to quickly iterate on your game logic without having to recompile your game.
+Scripts are separate files that can be hot-reloaded at runtime. This allows you to quickly iterate on your game or application logic without having to recompile it.
 
 All you need to do is register callbacks on your Bevy app like this:
 ```rust
 use bevy::prelude::*;
 use bevy_scriptum::prelude::*;
+use bevy_scriptum::runtimes::lua::prelude::*;
 
 App::new()
     .add_plugins(DefaultPlugins)
-    .add_plugins(ScriptingPlugin::default())
-    .add_script_function(String::from("hello_bevy"), || {
-      println!("hello bevy, called from script");
-    });
+    .add_scripting::<LuaRuntime>(|runtime| {
+         runtime.add_function(String::from("hello_bevy"), || {
+           println!("hello bevy, called from script");
+         });
+    })
+    .run();
 ```
 And you can call them in your scripts like this:
-```rhai
-hello_bevy();
+```lua
+hello_bevy()
 ```
 
 Every callback function that you expose to the scripting language is also a Bevy system, so you can easily query and mutate ECS components and resources just like you would in a regular Bevy system:
@@ -34,42 +49,47 @@ Every callback function that you expose to the scripting language is also a Bevy
 ```rust
 use bevy::prelude::*;
 use bevy_scriptum::prelude::*;
+use bevy_scriptum::runtimes::lua::prelude::*;
 
 #[derive(Component)]
 struct Player;
 
 App::new()
     .add_plugins(DefaultPlugins)
-    .add_plugins(ScriptingPlugin::default())
-    .add_script_function(
-        String::from("print_player_names"),
-        |players: Query<&Name, With<Player>>| {
-            for player in &players {
-                println!("player name: {}", player);
-            }
-        },
-    );
+    .add_scripting::<LuaRuntime>(|runtime| {
+        runtime.add_function(
+            String::from("print_player_names"),
+            |players: Query<&Name, With<Player>>| {
+                for player in &players {
+                    println!("player name: {}", player);
+                }
+            },
+        );
+    })
+    .run();
 ```
 
 You can also pass arguments to your callback functions, just like you would in a regular Bevy system - using `In` structs with tuples:
 ```rust
 use bevy::prelude::*;
 use bevy_scriptum::prelude::*;
-use rhai::ImmutableString;
+use bevy_scriptum::runtimes::lua::prelude::*;
 
 App::new()
     .add_plugins(DefaultPlugins)
-    .add_plugins(ScriptingPlugin::default())
-    .add_script_function(
-        String::from("fun_with_string_param"),
-        |In((x,)): In<(ImmutableString,)>| {
-            println!("called with string: '{}'", x);
-        },
-    );
+    .add_scripting::<LuaRuntime>(|runtime| {
+        runtime.add_function(
+            String::from("fun_with_string_param"),
+            |In((x,)): In<(String,)>| {
+                println!("called with string: '{}'", x);
+            },
+        );
+    })
+    .run();
 ```
 which you can then call in your script like this:
-```rhai
-fun_with_string_param("Hello world!");
+```lua
+fun_with_string_param("Hello world!")
 ```
 
 ### Usage
@@ -78,97 +98,118 @@ Add the following to your `Cargo.toml`:
 
 ```toml
 [dependencies]
-bevy_scriptum = "0.2"
+bevy_scriptum = { version = "0.9", features = ["lua"] }
 ```
 
-or execute `cargo add bevy_scriptum` from your project directory.
-
-Add the following to your `main.rs`:
-
-```rust
-use bevy::prelude::*;
-use bevy_scriptum::prelude::*;
-
-App::new()
-    .add_plugins(DefaultPlugins)
-    .add_plugins(ScriptingPlugin::default())
-    .run();
-```
+or execute `cargo add bevy_scriptum --features lua` from your project directory.
 
 You can now start exposing functions to the scripting language. For example, you can expose a function that prints a message to the console:
 
 ```rust
-use rhai::ImmutableString;
 use bevy::prelude::*;
 use bevy_scriptum::prelude::*;
+use bevy_scriptum::runtimes::lua::prelude::*;
 
 App::new()
     .add_plugins(DefaultPlugins)
-    .add_plugins(ScriptingPlugin::default())
-    .add_script_function(
-        String::from("my_print"),
-        |In((x,)): In<(ImmutableString,)>| {
-            println!("my_print: '{}'", x);
-        },
-    );
+    .add_scripting::<LuaRuntime>(|runtime| {
+       runtime.add_function(
+           String::from("my_print"),
+           |In((x,)): In<(String,)>| {
+               println!("my_print: '{}'", x);
+           },
+       );
+    })
+    .run();
 ```
 
-Then you can create a script file in `assets` directory called `script.rhai` that calls this function:
+Then you can create a script file in `assets` directory called `script.lua` that calls this function:
 
-```rhai
-my_print("Hello world!");
+```lua
+my_print("Hello world!")
 ```
 
-And spawn a `Script` component with a handle to a script source file`:
+And spawn an entity with attached `Script` component with a handle to a script source file:
 
 ```rust
 use bevy::prelude::*;
-use bevy_scriptum::Script;
+use bevy_scriptum::prelude::*;
+use bevy_scriptum::runtimes::lua::prelude::*;
 
 App::new()
+    .add_plugins(DefaultPlugins)
+    .add_scripting::<LuaRuntime>(|runtime| {
+       runtime.add_function(
+           String::from("my_print"),
+           |In((x,)): In<(String,)>| {
+               println!("my_print: '{}'", x);
+           },
+       );
+    })
     .add_systems(Startup,|mut commands: Commands, asset_server: Res<AssetServer>| {
-        commands.spawn(Script::new(asset_server.load("script.rhai")));
-    });
+        commands.spawn(Script::<LuaScript>::new(asset_server.load("script.lua")));
+    })
+    .run();
 ```
 
+You should then see `my_print: 'Hello world!'` printed in your console.
+
 ### Provided examples
 
-You can also try running provided examples by cloning this repository and running `cargo run --example <example_name>`.  For example:
+You can also try running provided examples by cloning this repository and running `cargo run --example <example_name>_<language_name>`.  For example:
 
 ```bash
-cargo run --example hello_world
+cargo run --example hello_world_lua
 ```
 The examples live in `examples` directory and their corresponding scripts live in `assets/examples` directory within the repository.
 
 ### Bevy compatibility
 
 | bevy version | bevy_scriptum version |
-|--------------|----------------------|
-| 0.13         | 0.4                  |
-| 0.12         | 0.3                  |
-| 0.11         | 0.2                  |
-| 0.10         | 0.1                  |
+|--------------|-----------------------|
+| 0.16         | 0.8-0.9               |
+| 0.15         | 0.7                   |
+| 0.14         | 0.6                   |
+| 0.13         | 0.4-0.5               |
+| 0.12         | 0.3                   |
+| 0.11         | 0.2                   |
+| 0.10         | 0.1                   |
 
 ### Promises - getting return values from scripts
 
-Every function called from script returns a promise that you can call `.then` with a callback function on. This callback function will be called when the promise is resolved, and will be passed the return value of the function called from script. For example:
+Every function called from script returns a promise that you can call `:and_then` with a callback function on. This callback function will be called when the promise is resolved, and will be passed the return value of the function called from script. For example:
 
-```rhai
-get_player_name().then(|name| {
-    print(name);
-});
+```lua
+get_player_name():and_then(function(name)
+    print(name)
+end)
 ```
+which will print out `John` when used with following exposed function:
 
-### Access entity from script
+```rust
+use bevy::prelude::*;
+use bevy_scriptum::prelude::*;
+use bevy_scriptum::runtimes::lua::prelude::*;
+
+App::new()
+   .add_plugins(DefaultPlugins)
+   .add_scripting::<LuaRuntime>(|runtime| {
+           runtime.add_function(String::from("get_player_name"), || String::from("John"));
+   });
+````
+
+## Access entity from script
 
 A variable called `entity` is automatically available to all scripts - it represents bevy entity that the `Script` component is attached to.
-It exposes `.index()` method that returns bevy entity index.
+It exposes `index` property that returns bevy entity index.
 It is useful for accessing entity's components from scripts.
 It can be used in the following way:
-```rhai
-print("Current entity index: " + entity.index());
+```lua
+print("Current entity index: " .. entity.index)
 ```
 
+`entity` variable is currently not available within promise callbacks.
+
 ### Contributing
 
 Contributions are welcome! Feel free to open an issue or submit a pull request.

SECURITY.md

@@ -7,8 +7,7 @@ currently being supported with security updates.
 
 | Version | Supported          |
 | ------- | ------------------ |
-| 0.1     | :x: |
-| 0.2     | :white_check_mark: |
+| 0.9     | :white_check_mark: |
 
 ## Reporting a Vulnerability
 

assets/examples/lua/call_function_from_rust.lua

@@ -0,0 +1,13 @@
+local my_state = {
+	iterations = 0,
+}
+
+function on_update()
+	my_state.iterations = my_state.iterations + 1;
+	print("on_update called " .. my_state.iterations .. " times")
+
+	if my_state.iterations >= 10 then
+		print("calling quit");
+		quit();
+	end
+end

assets/examples/lua/current_entity.lua

@@ -0,0 +1,7 @@
+-- entity is a global variable that is set to the entity that is currently being processed,
+-- it is automatically available in all scripts
+
+-- get name of the entity
+get_name(entity):and_then(function(name)
+	print(name)
+end)

assets/examples/lua/custom_type.lua

@@ -0,0 +1,4 @@
+-- Create a new instance of MyType
+my_type = MyType();
+-- Call registered method
+print(my_type:my_method())

assets/examples/lua/ecs.lua

@@ -0,0 +1 @@
+print_player_names()

assets/examples/lua/entity_variable.lua

@@ -0,0 +1,3 @@
+-- entity is a global variable that is set to the entity that is currently being processed,
+-- it is automatically available in all scripts
+print("Current entity index: " .. entity.index)

assets/examples/lua/function_params.lua

@@ -0,0 +1,4 @@
+fun_with_string_param("hello")
+fun_with_i64_param(5)
+fun_with_multiple_params(5, "hello")
+fun_with_i64_and_array_param(5, { 1, 2, "third element" })

assets/examples/lua/function_return_value.lua

@@ -0,0 +1,3 @@
+function get_value()
+	return 42
+end

assets/examples/lua/multiple_plugins_plugin_a.lua

@@ -0,0 +1 @@
+hello_from_plugin_a()

assets/examples/lua/multiple_plugins_plugin_b.lua

@@ -0,0 +1 @@
+hello_from_plugin_b_with_parameters("hello", 42)

assets/examples/lua/promises.lua

@@ -0,0 +1,3 @@
+get_player_name():and_then(function(name)
+	print(name)
+end);

assets/examples/rhai/entity_variable.rhai

@@ -1,3 +1,3 @@
 // entity is a global variable that is set to the entity that is currently being processed,
 // it is automatically available in all scripts
-print("Current entity index: " + entity.index());
+print("Current entity index: " + entity.index);

assets/examples/rhai/function_return_value.rhai

@@ -0,0 +1,3 @@
+fn get_value() {
+    42
+}

assets/examples/rhai/hello_world.rhai

@@ -0,0 +1 @@
+hello_bevy();

assets/examples/rhai/multiple_plugins_plugin_a.rhai

@@ -0,0 +1 @@
+hello_from_plugin_a();

assets/examples/rhai/multiple_plugins_plugin_b.rhai

@@ -0,0 +1 @@
+hello_from_plugin_b_with_parameters("hello", 42);

assets/examples/rhai/side_effects.rhai

@@ -0,0 +1 @@
+spawn_entity();

assets/examples/ruby/call_function_from_rust.rb

@@ -0,0 +1,13 @@
+$my_state = {
+  iterations: 0,
+}
+
+def on_update
+  $my_state[:iterations] += 1
+  puts("on_update called #{$my_state[:iterations]} times")
+
+  if $my_state[:iterations] >= 10
+    print("calling quit");
+    quit()
+  end
+end

assets/examples/ruby/current_entity.rb

@@ -0,0 +1,3 @@
+get_name(Bevy::Entity.current).and_then do |name|
+  puts(name)
+end

assets/examples/ruby/custom_type.rb

@@ -0,0 +1,4 @@
+# Create a new instance of MyType
+my_type = MyType.new()
+# Call registered method
+puts(my_type.my_method)

assets/examples/ruby/ecs.rb

@@ -0,0 +1 @@
+print_player_names

assets/examples/ruby/entity_variable.rb

@@ -0,0 +1,2 @@
+# Bevy::Entity.current can be used to access the entity that is currently being processed
+puts("Current entity index: #{Bevy::Entity.current.index}")

assets/examples/ruby/function_params.rb

@@ -0,0 +1,4 @@
+fun_with_string_param("hello")
+fun_with_i64_param(5)
+fun_with_multiple_params(5, "hello")
+fun_with_i64_and_array_param(5, [1, 2, "third element"])

assets/examples/ruby/function_return_value.rb

@@ -0,0 +1,3 @@
+def get_value
+  42
+end

assets/examples/ruby/hello_world.rb

@@ -0,0 +1 @@
+hello_bevy()

assets/examples/ruby/multiple_plugins_plugin_a.rb

@@ -0,0 +1 @@
+hello_from_plugin_a

assets/examples/ruby/multiple_plugins_plugin_b.rb

@@ -0,0 +1 @@
+hello_from_plugin_b_with_parameters("hello", 42)

assets/examples/ruby/promises.rb

@@ -0,0 +1,3 @@
+get_player_name.and_then do |name|
+  puts name
+end

assets/examples/ruby/side_effects.rb

@@ -0,0 +1 @@
+spawn_entity()

assets/tests/lua/call_script_function_that_causes_runtime_error.lua

@@ -0,0 +1,3 @@
+function test_func()
+	print("abc" + 5)
+end

assets/tests/lua/call_script_function_with_params.lua

@@ -0,0 +1,7 @@
+State = {
+	called_with = nil
+}
+
+function test_func(x)
+	called_with = x
+end

assets/tests/lua/entity_variable.lua

@@ -0,0 +1,3 @@
+function test_func()
+	rust_func(entity.index)
+end

assets/tests/lua/entity_variable_eval.lua

@@ -0,0 +1,5 @@
+index = entity.index
+
+function test_func()
+	rust_func(index)
+end

assets/tests/lua/eval_that_causes_runtime_error.lua

@@ -0,0 +1,2 @@
+mark_called()
+error()

assets/tests/lua/pass_entity_from_script.lua

@@ -0,0 +1,3 @@
+function test_func()
+	rust_func(entity)
+end

assets/tests/lua/pass_vec3_from_script.lua

@@ -0,0 +1,3 @@
+function test_func()
+	rust_func(Vec3(1.5, 2.5, -3.5))
+end

assets/tests/lua/pass_vec3_to_script.lua

@@ -0,0 +1,6 @@
+function test_func(vec3)
+	assert(vec3.x == 1.5)
+	assert(vec3.y == 2.5)
+	assert(vec3.z == -3.5)
+	mark_success()
+end

assets/tests/lua/promise_runtime_error.lua

@@ -0,0 +1,5 @@
+function test_func()
+	rust_func():and_then(function(x)
+		print("abc" + 5)
+	end)
+end

assets/tests/lua/return_via_promise.lua

@@ -0,0 +1,9 @@
+State = {
+	x = nil
+}
+
+function test_func()
+	rust_func():and_then(function(x)
+		State.x = x
+	end)
+end

assets/tests/lua/rust_function_gets_called_from_script.lua

@@ -0,0 +1,3 @@
+function test_func()
+	rust_func()
+end

assets/tests/lua/rust_function_gets_called_from_script_with_multiple_params.lua

@@ -0,0 +1,3 @@
+function test_func()
+	rust_func(5, "test")
+end

assets/tests/lua/rust_function_gets_called_from_script_with_param.lua

@@ -0,0 +1,3 @@
+function test_func()
+	rust_func(5)
+end

assets/tests/lua/script_function_gets_called_from_rust.lua

@@ -0,0 +1,7 @@
+State = {
+	times_called = 0
+}
+
+function test_func()
+	State.times_called = State.times_called + 1;
+end

assets/tests/lua/script_function_gets_called_from_rust_with_multiple_params.lua

@@ -0,0 +1,9 @@
+State = {
+	a_value = nil,
+	b_value = nil
+}
+
+function test_func(a, b)
+	State.a_value = a
+	State.b_value = b
+end

assets/tests/lua/script_function_gets_called_from_rust_with_single_param.lua

@@ -0,0 +1,7 @@
+State = {
+	a_value = nil
+}
+
+function test_func(a)
+	State.a_value = a
+end

assets/tests/lua/side_effects.lua

@@ -0,0 +1,3 @@
+function test_func()
+	spawn_entity()
+end

assets/tests/rhai/call_script_function_that_causes_runtime_error.rhai

@@ -0,0 +1,3 @@
+fn test_func() {
+	print("abc" * 5)
+}

assets/tests/rhai/call_script_function_with_params.rhai

@@ -0,0 +1,2 @@
+fn test_func(x) {
+}

assets/tests/rhai/entity_variable.rhai

@@ -0,0 +1,3 @@
+fn test_func() {
+  rust_func(entity.index);
+}

assets/tests/rhai/entity_variable_eval.rhai

@@ -0,0 +1,5 @@
+let index = entity.index;
+
+fn test_func() {
+  rust_func(index);
+}

assets/tests/rhai/eval_that_causes_runtime_error.rhai

@@ -0,0 +1,2 @@
+mark_called();
+throw();

assets/tests/rhai/pass_entity_from_script.rhai

@@ -0,0 +1,3 @@
+fn test_func() {
+  rust_func(entity);
+}

assets/tests/rhai/pass_vec3_from_script.rhai

@@ -0,0 +1,3 @@
+fn test_func() {
+  rust_func(new_vec3(1.5, 2.5, -3.5));
+}

assets/tests/rhai/pass_vec3_to_script.rhai

@@ -0,0 +1,7 @@
+fn test_func(vec3) {
+  if type_of(vec3) != "Vec3" { throw() }
+  if vec3.x != 1.5 { throw() }
+  if vec3.y != 2.5 { throw() }
+  if vec3.z != -3.5 { throw() }
+  mark_success();
+}

assets/tests/rhai/promise_runtime_error.rhai

@@ -0,0 +1,5 @@
+fn test_func() {
+	rust_func().then(|x| {
+		print("abc" * 5)
+	})
+}

assets/tests/rhai/return_via_promise.rhai

@@ -0,0 +1,9 @@
+let state = #{
+	x: 0
+};
+
+fn test_func() {
+	rust_func().then(|x| {
+		state.x = x;
+	})
+}

assets/tests/rhai/rust_function_gets_called_from_script.rhai

@@ -0,0 +1,3 @@
+fn test_func() {
+	rust_func();
+}

assets/tests/rhai/rust_function_gets_called_from_script_with_multiple_params.rhai

@@ -0,0 +1,3 @@
+fn test_func() {
+	rust_func(5, "test");
+}

assets/tests/rhai/rust_function_gets_called_from_script_with_param.rhai

@@ -0,0 +1,3 @@
+fn test_func() {
+	rust_func(5);
+}

assets/tests/rhai/script_function_gets_called_from_rust.rhai

@@ -0,0 +1,7 @@
+let state = #{ 
+	times_called: 0
+};
+
+fn test_func() {
+	state.times_called += 1;
+}

assets/tests/rhai/script_function_gets_called_from_rust_with_multiple_params.rhai

@@ -0,0 +1,9 @@
+let state = #{
+	a_value: (),
+	b_value: ()
+};
+
+fn test_func(a, b) {
+	state.a_value = a;
+	state.b_value = b;
+}

assets/tests/rhai/script_function_gets_called_from_rust_with_single_param.rhai

@@ -0,0 +1,7 @@
+let state = #{
+	a_value: ()
+};
+
+fn test_func(a) {
+	state.a_value = a
+}

assets/tests/rhai/side_effects.rhai

@@ -0,0 +1,3 @@
+fn test_func() {
+	spawn_entity()
+}

assets/tests/ruby/call_script_function_that_causes_runtime_error.rb

@@ -0,0 +1,3 @@
+def test_func
+  raise
+end

assets/tests/ruby/call_script_function_with_params.rb

@@ -0,0 +1,7 @@
+$state = {
+  'called_with' => nil
+}
+
+def test_func(val)
+  $state['called_with'] = val
+end

assets/tests/ruby/entity_variable.rb

@@ -0,0 +1,3 @@
+def test_func
+  rust_func(Bevy::Entity.current.index)
+end

assets/tests/ruby/entity_variable_eval.rb

@@ -0,0 +1,5 @@
+$index = Bevy::Entity.current.index
+
+def test_func
+  rust_func($index)
+end

assets/tests/ruby/eval_that_causes_runtime_error.rb

@@ -0,0 +1,2 @@
+mark_called
+raise

assets/tests/ruby/pass_entity_from_script.rb

@@ -0,0 +1,3 @@
+def test_func
+  rust_func(Bevy::Entity.current)
+end

assets/tests/ruby/pass_vec3_from_script.rb

@@ -0,0 +1,3 @@
+def test_func
+  rust_func(Bevy::Vec3.new(1.5, 2.5, -3.5))
+end

assets/tests/ruby/pass_vec3_to_script.rb

@@ -0,0 +1,7 @@
+def test_func(vec3)
+  raise unless vec3.is_a?(Bevy::Vec3)
+  raise unless vec3.x == 1.5
+  raise unless vec3.y == 2.5
+  raise unless vec3.z == -3.5
+  mark_success
+end

assets/tests/ruby/promise_runtime_error.rb

@@ -0,0 +1,5 @@
+def test_func
+  rust_func.and_then do |x|
+    raise
+  end
+end

assets/tests/ruby/return_via_promise.rb

@@ -0,0 +1,9 @@
+$state = {
+  'x' => nil
+}
+
+def test_func
+  rust_func.and_then do |x|
+    $state['x'] = x
+  end
+end

assets/tests/ruby/rust_function_gets_called_from_script.rb

@@ -0,0 +1,3 @@
+def test_func
+  rust_func
+end

assets/tests/ruby/rust_function_gets_called_from_script_with_multiple_params.rb

@@ -0,0 +1,3 @@
+def test_func
+  rust_func(5, 'test')
+end

assets/tests/ruby/rust_function_gets_called_from_script_with_param.rb

@@ -0,0 +1,3 @@
+def test_func
+  rust_func(5)
+end

assets/tests/ruby/script_function_gets_called_from_rust.rb

@@ -0,0 +1,7 @@
+$state = {
+  'times_called' => 0
+}
+
+def test_func
+  $state['times_called'] += 1
+end

assets/tests/ruby/script_function_gets_called_from_rust_with_multiple_params.rb

@@ -0,0 +1,9 @@
+$state = {
+  'a_value' => nil,
+  'b_value' => nil
+}
+
+def test_func(a, b)
+  $state['a_value'] = a
+  $state['b_value'] = b
+end

assets/tests/ruby/script_function_gets_called_from_rust_with_single_param.rb

@@ -0,0 +1,7 @@
+$state = {
+  'a_value' => nil
+}
+
+def test_func(a)
+  $state['a_value'] = a
+end

assets/tests/ruby/side_effects.rb

@@ -0,0 +1,3 @@
+def test_func
+  spawn_entity
+end

book/.gitignore

@@ -0,0 +1,3 @@
+book
+doctest_cache
+target

book/Cargo.toml

@@ -0,0 +1,7 @@
+[package]
+name = "bevy_scriptum_book"
+publish = false
+edition = "2024"
+
+[dependencies]
+bevy_scriptum = { path = "../", features = ["ruby", "lua", "rhai"] }

book/book.toml

@@ -0,0 +1,6 @@
+[book]
+authors = ["Jaroslaw Konik"]
+language = "en"
+multilingual = false
+src = "src"
+title = "bevy_scriptum"

book/justfile

@@ -0,0 +1,15 @@
+export CARGO_MANIFEST_DIR := `pwd`
+
+build-deps:
+	cargo clean && cargo build
+
+_test:
+	mdbook test -L target/debug/deps/
+
+test: build-deps _test
+
+test-watch: build-deps
+	watchexec --exts md -r just _test
+
+serve:
+	mdbook serve

book/src/SUMMARY.md

@@ -0,0 +1,30 @@
+# Summary
+
+- [Introduction](./introduction.md)
+- [Runtimes](./runtimes.md)
+  - [Lua](./lua/lua.md)
+    - [Installation](./lua/installation.md)
+    - [Hello World](./lua/hello_world.md)
+    - [Spawning scripts](./lua/spawning_scripts.md)
+    - [Calling Rust from Lua](./lua/calling_rust_from_script.md)
+    - [Calling Lua from Rust](./lua/calling_script_from_rust.md)
+    - [Interacting with bevy in callbacks](./lua/interacting_with_bevy.md)
+    - [Builtin types](./lua/builtin_types.md)
+    - [Builtin variables](./lua/builtin_variables.md)
+  - [Ruby](./ruby/ruby.md)
+    - [Installation](./ruby/installation.md)
+    - [Hello World](./ruby/hello_world.md)
+    - [Spawning scripts](./ruby/spawning_scripts.md)
+    - [Calling Rust from Ruby](./ruby/calling_rust_from_script.md)
+    - [Calling Ruby from Rust](./ruby/calling_script_from_rust.md)
+    - [Interacting with bevy in callbacks](./ruby/interacting_with_bevy.md)
+    - [Builtin types](./ruby/builtin_types.md)
+  - [Rhai](./rhai/rhai.md)
+    - [Installation](./rhai/installation.md)
+    - [Hello World(TBD)]()
+- [Multiple plugins](./multiple_plugins.md)
+- [Multiple runtimes(TBD)]()
+- [Implementing custom runtimes(TBD)]()
+- [Workflow](./workflow/workflow.md)
+  - [Live-reload](./workflow/live_reload.md)
+- [Bevy support matrix](./bevy_support_matrix.md)