diff --git a/README.md b/README.md index 9fef9a0..91b8804 100644 --- a/README.md +++ b/README.md @@ -1,77 +1,128 @@ - +COA Tools logo -# Cutout Animation Tools - Documentation -This is the Documentation for the Blender/Godot Addon Cutout Animation Tools. +# Cutout Animation Tools – documentation -If you like this addon and want to thank me with a small donation feel free to do this here: +This is the documentation for the Cutout Animation Tools Blender/Godot add-on. + +If you like this add-on and want to thank me with a small donation, +feel free to do this here: [![](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=8TB6CNT9G8LEN) ## Description -The Cutout Animation Tools (COA Tools) Addon for blender is a 2D rigging and animation suite. It offers you similar tools as for example programs like Spine or Spriter. COA Tools offer you a rapid workflow to create 2D Cutout Character/Animations in blender. Thanks to blenders great animation system and and this addon you get a powerfull solution to create 2D animations. It is parted into 3 different components. Photoshop sprite exporter, Blender Addon, Godot importer. -[Take a look at the addon in action.](https://www.youtube.com/playlist?list=PLPI26-KXCXpA-VMlDIWpmdq6M1m4LEjf_) +The Cutout Animation Tools (COA Tools) add-on for Blender is a 2D rigging +and animation suite. It offers you tools similar to programs like +Spine or Spriter. COA Tools offer you a rapid workflow to create 2D cut-out +characters and animations using Blender. Thanks to Blender's great animation +system and to this addon, you get a powerful solution to create 2D animations. +It is split into 3 different components: the Photoshop sprite exporter, +the Blender add-on and the Godot importer. + +[Take a look at the add-on in action.](https://www.youtube.com/playlist?list=PLPI26-KXCXpA-VMlDIWpmdq6M1m4LEjf_) ### Photoshop sprite exporter -Quickly export photoshop layers into separate files with json coordinate informations. This can be used in blender to import sprites very quickly. + +Quickly export Photoshop layers into separate files with +JSON coordinate information. This can be used in Blender to import sprites +very quickly. + Features: -- export layers as sprites -- export folder with multiple layers as spritesheets -- generate json data with all layer positions and spritesheet informations + +- Export layers as sprites. +- Export folder with multiple layers as spritesheets. +- Generate JSON data with all layer positions and spritesheet information. ### GIMP sprite exporter -Export GIMP layers and layer groups into separate files with json coordinate information. For additional usage information see the README.md in the GIMP folder. + +Export GIMP layers and layer groups into separate files with +JSON coordinate information. For additional usage information, +see [README.md](GIMP/README.md) in the `GIMP/` folder. ### Cutout Animation Tools Blender + This is the biggest component, as most of the work will be done here. -Features the addon offers are: -- sprite importer (import single sprites or multiple, or use json data as import information) -- animated spritesheet support for meshes -- armature editing - superfast bone creation tool. Just draw bones and click append sprites to bones -- mesh editing - draw vertex countours and fill them quickly with tesselated mesh. filling also unwraps and maps texture data -- weight editing - fast weight editing for tesselated meshes -- fast ik and stretch to constraint generation -- enhanced animation handling for sprite_objects -- Spriteobject outliner -> displays all containing sprites, armatures with bones for better and quick access to single sprites -- ortho cam operator -> generates an orthogonal camera which can be used to render animations. Camera resolution fits perfectly the pixel space of sprites -- json export - > Exports all sprite_object data to a json file. Supported features are: Bone and Sprite hierarchy export. Baked animation export + +The add-on offers the following features: + +- Sprite importer (import single sprites or multiple, or use JSON data as import information) +- Animated spritesheet support for meshes. +- Armature editing – super fast bone creation tool. + Just draw bones and click to append sprites to bones. +- Mesh editing – draw vertex countours and fill them quickly with tesselated mesh. + Filling also unwraps and maps texture data. +- Weight editing – fast weight editing for tesselated meshes +- Fast IK and stretch to constraint generation +- Enhanced animation handling for sprite_objects +- Sprite object outliner → displays all containing sprites, armatures with bones + for better and quick access to single sprites +- Orthographic camera operator → generates an orthographic camera which can + be used to render animations. Camera resolution fits perfectly the pixel + space of sprites +- JSON export → Exports all sprite_object data to a JSON file. + Supported features are: Bone and Sprite hierarchy export, baked animation export. ### Godot Cutout Animation Importer -This is an advanced importer that helps you get all your exported blender data into godot. + +This is an advanced importer that helps you get all your +exported Blender data into Godot. + Features: -- Json importer -- sprites, bones and animations get imported -- clever reimport functionality. Offers the possibility to merge local changes that were made in godot to the newly imported scene. This enables a very flexible workflow. Work in blender, then export. Import in godot. Make additions like adding new nodes, adding custom animations. After reimport all local changes will be preserved if merging is enabled. + +- JSON importer. +- Sprites, bones and animations get imported. +- Clever reimport functionality. Offers the possibility to merge local changes + that were made in Godot to the newly imported scene. This enables a + very flexible workflow: work in Blender, then export, then import in Godot. + Make additions such as adding new nodes or adding custom animations. + After reimporting, all local changes will be preserved if merging is enabled. ## Download and Installation -Download or Clone the github repository to your local drive. If you download the ZIP File from Github, please make sure to unzip. -Don't try to install the downloaded zip file directly in blender. This won't work. Once unzipped follow the installation instructions below. -### Photoshop Exporter: +Download or clone the GitHub repository to your local drive. +If you downloaded the ZIP file from GitHub, make sure to extract it. +Don't try to install the downloaded ZIP file directly in Blender; +this won't work. Once you have extracted the ZIP file, follow +the installation instructions below. + +### Photoshop exporter -The .jsx file has to be copied into the photoshop scripts folder which is located in: +The `.jsx` file has to be copied into the Photoshop scripts folder which is located in: +``` C:\Program Files\Adobe\Adobe Photoshop CC 2015\Presets\Scripts +``` + +Don’t forget to restart Photoshop and then go to +**File** → **Scripts** → **BlenderExporter.jsx**. -Don’t forget to restart Photoshop and then go to File -> Scripts -> BlenderExporter.jsx +### GIMP exporter -### GIMP Exporter: +The `coatools_exporter.py` file should be copied to your GIMP plug-ins folder +which is located in: -The coatools_exporter.py should be copied to your GIMP plug-ins folder which is located in: -- Linux: /home/YOU/.gimp2.8/plug-ins/ -- Windows: C:\Users\YOU\.gimp2.8\plug-ins +- Linux: `$HOME/.gimp-2.8/plug-ins/` +- Windows: `%USERPROFILE%\.gimp-2.8\plug-ins\` -It should show up unde Files>Export to CoaTools... after your restart GIMP +After restarting GIMP, it should show up under **Files** → **Export to CoaTools…**. +### Blender add-on -### Blender Addon: -Zip the coa_folder. -Go to File -> User Preferences -> Add-ons and click the “Install from file...” button. -This will install and enable the Addon for Blender. Don’t forget to save the user preferences, otherwise the addon will not be activated after restart. +Create a ZIP archive of `coa_folder/` which is located inside the `Blender/` folder. +Go to **File** → **User Preferences** → **Add-ons** and click the +**Install from file…** button. +This will install and enable the add-on for Blender. Don’t forget to +save the user preferences, otherwise the add-on will not be activated +after restarting. - + + + -### Godot Importer: -Notice, this importer will only run with current godot 2.1 dev builds. -Create an /addons folder in your game projects folder and copy the coa_importer folder into that addons folder. Once the files are loaded go to Project Settings -> Plugins -> Cutout Animation Importer and activate the Plugin. +### Godot importer +Note that this importer will only run with current Godot 2.1 development builds. +Create an `addons/` folder in your game project's folder and copy the `coa_importer/` +folder into that addons folder. Once the files are loaded, go to +**Project Settings** → **Plugins** → **Cutout Animation Importer** +then activate the plugin.