From 80c27d51da9f406f433b2e22ed12d2ec8ddfe6c6 Mon Sep 17 00:00:00 2001 From: Lucas Schwiderski Date: Sun, 4 Apr 2021 20:54:21 +0200 Subject: [PATCH] docs: Update README Signed-off-by: Lucas Schwiderski --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index ea256d1..3b19a0d 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,14 @@ # Bitsquid Blender Tools +## Install + +Copy the `addons/bitsquid` directory as `$BLENDER/scripts/addons/bitsquid`, where `$BLENDER` is one of [Blender's configuration directories](https://docs.blender.org/manual/en/latest/advanced/blender_directory_layout.html#blender-directory-layout). +It should now show up in Blender's preferences as `Import-Export: Bitsquid Engine`. + +### Development + +For active development, you'll want to symlink the above, rather than copy. The scripts itself are already set up for proper reloading via the `System > Reload scripts` command in Blender. + ## Goal Extend Blender to become capable of creating various assets for the Bitsquid (and Stingray) game engine.