Colorize Tool Extras [Addon]

Overview

This addon for Colorize Tool for Ren'Py includes a huge array of quality-of-life features to make colorizing images in-engine as quick and easy as possible. It requires the files from Colorize Tool for Ren'Py to work, which you can find below:

Features

• New swatches tab:
  • Save swatch sets and associated thresholds with an optional name for later. 
  • Stores around 80*7 swatches (so there are 80 slots to store swatch sets with 4 swatches, 80 slots to store swatch sets with 7 swatches, etc.). 
  • The name will be shown when you hover over it to easily identify the swatches later.
  • Hover over a saved swatch set and press delete to remove it
• New layers tab:
  • Enter an additional image and hit "View" to have it show up on the screen separately from the image you're editing. Comes with bars to move the image around and zoom in/out. Useful for comparing a recoloured image to existing in-game images.
  • Add images to layer on top of the image you're recolouring e.g. if you're editing the body layer of a sprite, add in the hair, clothing, and face layers to see how it all comes together
  • Added layer order can be rearranged e.g. so clothes appear on top of a sprite but "hair back" layers appear behind it.
  • Toggle the visibility of an individual layer on and off without needing to completely remove it
  • Added layers will automatically use the last saved recolour set up with that image name. Each layer has the option to toggle the recolour on and off as well.
  • Click on any individual image to make that the "main" image you're recolouring, while preserving the order and contents of the layer list
• New save system:
  • Save your whole recolour setup to a json file so you won't lose it even if you have to reset persistent (Ren'Py 7.6 and 8.1+ only). 
  • Includes both a manual save you can trigger yourself, and an automatic save that saves every time you close the game.
  • Json files appear in your game repository and can be version controlled or saved separately as backups.
  • Saves information on all your saved colour swatches, layer setups, saved image tags, and more. 
  • Includes a timestamp on the load screen so you can tell when the save was made.

Instructions

Place colorize_tool_extras.rpy into your game/ folder, ideally alongside colorize_tool.rpy (which is required for this addon to work). You can then access the Colorize Tool (following the instructions in Colorize Tool for Ren'Py) and the new features will automatically become available.

Compatibility

This tool has been tested for compatibility with Ren'Py 7.5-7.6 and 8.0-8.2. It uses nearrect for dropdowns and thus is not compatible with earlier Ren'Py versions without modification. It has been tested with several project sizes and image declarations for UI adaptability, but as the possible permutations are near-infinite, some edge cases may have been missed - if you have any issues, please make a post in the forums below.

The JSON save feature is only available in Ren'Py 7.6+ and 8.1+, but the rest of the addon features will also work on 7.5 and 8.0. Since this is a development tool, however, you're free to make a project on a later Ren'Py version to add this tool to and get the colorize values to then copy back to your original project, which I suggest if you'd like to take advantage of the JSON file saving.

Terms of Use

You may:

• Use this code during development of any kind of project, commercial or noncommercial.
• Modify and edit the code to suit your needs

You may not:

• Resell all or part of the code as-is or sell it with modifications
• Release the code with your project - it is a development tool, and should not be packaged in a completed game. The code to exclude the tool from a built game is included in the files.
• Release any projects created using this code without providing attribution

Attribution must be credited as Feniks, with a link either to the page with this code or to https://feniksdev.com

Final Notes

You can buy this addon in a bundle with Multi-thumb Bar for Ren'Py to power up the colorize tool even further! If 01_multibar.rpy is present in your game folder, the colorize tool will automatically use it. Find the sale here!

Thank you again to the many devs who've helped me test and refine this tool for different art styles! An extra special thank you goes out to GB Patch, without whom this tool and the shader is likely to have never existed at all.

Cove is from Our Life: Beginnings & Always by GB Patch

My website, feniksdev.com, also has tutorials on how to set up your base images and use the tool to achieve the best results!