Skip to content

Commit

Permalink
Add READMEs For Different Components
Browse files Browse the repository at this point in the history
  • Loading branch information
zicklag committed Oct 30, 2020
1 parent 158288a commit a0e9e90
Show file tree
Hide file tree
Showing 9 changed files with 17 additions and 2 deletions.
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ members = [
"arsenal_scripting",

# Language adapters
"language_adapters/python",
"arsenal_scripting/language_adapters/python",

# Cargo utilities
"xtask",
Expand Down
3 changes: 3 additions & 0 deletions arsenal_blender/README.md
Original file line number Diff line number Diff line change
@@ -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.
3 changes: 3 additions & 0 deletions arsenal_blender_core/README.md
Original file line number Diff line number Diff line change
@@ -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.
3 changes: 3 additions & 0 deletions arsenal_runtime/README.md
Original file line number Diff line number Diff line change
@@ -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.
2 changes: 1 addition & 1 deletion arsenal_scripting/README.md
Original file line number Diff line number Diff line change
@@ -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

3 changes: 3 additions & 0 deletions arsenal_scripting/language_adapters/README.md
Original file line number Diff line number Diff line change
@@ -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.
File renamed without changes.
3 changes: 3 additions & 0 deletions arsenal_scripting/language_adapters/python/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Python Language Adapter

This is the Python [language adapter](../) for Arsenal.
File renamed without changes.

0 comments on commit a0e9e90

Please sign in to comment.