diff --git a/Cargo.toml b/Cargo.toml index e3eedd0..0c22ced 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -6,7 +6,7 @@ members = [ "arsenal_scripting", # Language adapters - "language_adapters/python", + "arsenal_scripting/language_adapters/python", # Cargo utilities "xtask", diff --git a/arsenal_blender/README.md b/arsenal_blender/README.md new file mode 100644 index 0000000..3b1f715 --- /dev/null +++ b/arsenal_blender/README.md @@ -0,0 +1,3 @@ +# Arsenal Blender + +Arsenal Blender is the Python portion of the Arsenal Blender plugin. Arsenal Blender is responsible for adding all of our extra Blender GUI components we need for Arsenal and for being the "glue" that ties Blender to the functionality in [Arsenal Blender Core](../arsenal_blender_core). Arsenal Blender Core is written in Rust and used for most of the intense core logic required for Arsenal such as scene exporting and other game packaging or management operations. \ No newline at end of file diff --git a/arsenal_blender_core/README.md b/arsenal_blender_core/README.md new file mode 100644 index 0000000..3f57cc8 --- /dev/null +++ b/arsenal_blender_core/README.md @@ -0,0 +1,3 @@ +# Arsenal Blender Core + +Arsenal Blender Core is the Rust component of the Arsenal Blender plugin that is written in Python. Arsenal Blender Core gets compiled to a Python module that is loaded by the Python code in Arsenal Blender. Arsenal Blender Core is used to perform most of the intensive operations needed by the Arsenal Blender plugin such as scene export. Arsenal Blender Core may also later be responsible for handling details such as live game sync or rendering. \ No newline at end of file diff --git a/arsenal_runtime/README.md b/arsenal_runtime/README.md new file mode 100644 index 0000000..372e621 --- /dev/null +++ b/arsenal_runtime/README.md @@ -0,0 +1,3 @@ +# Arsenal Runtime + +The Arsenal Runtime is the binary that actually executes an Arsenal game. It is essentially just a tiny Bevy game that includes the Bevy plugins necessary for Arsenal. These plugins include things like the Arsenal Scripting plugin and other core plugins such as the Blender scene system. \ No newline at end of file diff --git a/arsenal_scripting/README.md b/arsenal_scripting/README.md index cf287cd..8617bc5 100644 --- a/arsenal_scripting/README.md +++ b/arsenal_scripting/README.md @@ -1,6 +1,6 @@ # Arsenal Scripting -`arsenal_scripting` is a crate designed to provide a language agnostic scripting interface on top of the [Bevy] game engine. This is **highly** experimental and the design is under constant re-evaluation at this point. +`arsenal_scripting` is a crate designed to provide a language agnostic scripting interface on top of the [Bevy] game engine. This is **highly** experimental and the design is under constant re-evaluation at this point. Arsenal Scripting is primarily intended to be included as a core plugin in the [Arsenal Runtime](../arsenal_runtime). [bevy]: https://bevyengine.org \ No newline at end of file diff --git a/arsenal_scripting/language_adapters/README.md b/arsenal_scripting/language_adapters/README.md new file mode 100644 index 0000000..7c46e7b --- /dev/null +++ b/arsenal_scripting/language_adapters/README.md @@ -0,0 +1,3 @@ +# Language Adapters + +These are the built-in language adapters supported by the Arsenal project. The Arsenal Scripting plugin allows for scripting languages to be implemented as standardized language adapters that can be dynamically loaded as native shared modules ( i.e. `.so`, `.dll`, or `.dylib` files, depending on the platform ). This allows scripting langauge adapters to be developed by 3rd party's and trivially added to Arsenal by downloading the relevant adapter for the target platform. \ No newline at end of file diff --git a/language_adapters/python/Cargo.toml b/arsenal_scripting/language_adapters/python/Cargo.toml similarity index 100% rename from language_adapters/python/Cargo.toml rename to arsenal_scripting/language_adapters/python/Cargo.toml diff --git a/arsenal_scripting/language_adapters/python/README.md b/arsenal_scripting/language_adapters/python/README.md new file mode 100644 index 0000000..1aefc39 --- /dev/null +++ b/arsenal_scripting/language_adapters/python/README.md @@ -0,0 +1,3 @@ +# Python Language Adapter + +This is the Python [language adapter](../) for Arsenal. \ No newline at end of file diff --git a/language_adapters/python/src/lib.rs b/arsenal_scripting/language_adapters/python/src/lib.rs similarity index 100% rename from language_adapters/python/src/lib.rs rename to arsenal_scripting/language_adapters/python/src/lib.rs