Colorize Tool for Ren'Py
A downloadable tool
Overview
Although Better Colorize for Ren'Py is an extremely powerful shader, it may be difficult to visualize how the colours and thresholds affect the final result. Which combinations look best? How might it look in-game? This tool is designed to help you visualize and adjust the final shader results in real-time before you copy them out for use in your game.
Features
- View the shader results in real-time as you select a colour with the colour picker and adjust the thresholds
- Type in any image name and freely drag it around, zoom in/out, and save the tag for later.
- Specify up to 7 colours and associated thresholds per channel, with different colours used for red, green, blue, and gray channels.
- Automatically uses Multi-Thumb Bar for Ren'Py for easier threshold manipulation, if present.
- Undo and redo threshold and colour changes
- Copy the final colour setup to the clipboard as a special RGBColorize object, which can be pasted into the tool to bring up again later, used to make a transform for an image, or put into a list and used with the Better Colorize for Ren'Py DynamicDisplayable to smoothly blend between different colour setups
- Input fields for colour codes and thresholds for precise control
- In-game tutorial included to walk you through the various features
- Most buttons have a tooltip if hovered for a short while
Instructions
Included in colorize_tool.zip are several rpy files:
- colorize_tool.rpy, which contains the bulk of the code for this tool
- image_tool_common.rpy, the version compatible with the colorize tool as of 2024-02-05. If newer versions of image_tool_common.rpy are released, they can replace this file. Find it separately here: https://feniksdev.itch.io/image-tools-for-renpy
- color_picker.rpy, the version compatible with the colorize tool as of 2024-02-05. If newer versions of color_picker.rpy are released, they can replace this file. Find it separately here: https://feniksdev.itch.io/color-picker-for-renpy
- better_colorize.rpy, the version compatible with the colorize tool as of 2024-02-05. If newer versions of better_colorize.rpy are released, they can replace this file. Find it separately here: https://feniksdev.itch.io/better-colorize-for-renpy
Place these rpy files into your game/ folder - generally, I recommend you make a subfolder called image_tools to put them in.
Also included is hand_rgb.png. Put this file into your images folder somewhere.
If you haven't already, create a button to access the image tools - I recommend adding a textbutton to the main menu screen with a line like:
textbutton "Image Tools" action ShowMenu("image_tools")
Clicking this button will take you to the tool hub screen, where you can select the Image Colorizing Tool. The first time you open this tool, you will be shown the tutorial. You can use the menu button in the top left corner of the tool screen to reread the tutorial at any time.
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.
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 in the file colorize_tool.rpy 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
Credits
Cove is from Our Life: Beginnings & Always by GB Patch
Character with bob haircut is from sutemo
Final Notes
Huge thank you once again to the devs who've tested this tool and the Better Colorize shader, without whom this tool would not be nearly as useful as it is.
I've put a lot of effort into this tool to make understanding and using the shader as simple as possible, so you can test it out with your images and see if it'll work for your game. But if you'd like more quality-of-life features, I have packed tons of them into Colorize Tool Extras, found below:
I've bundled Colorize Tool Extras together with my multi-thumb bar code for a discounted price if you buy them both at once. If you have one or both files, just pop them into your project and the tool will automatically find and use them. Find the sale here!
The Extras file includes the option to save and load sets of swatches; the ability to save and load your whole setup to a file so you'll retain it even if you reset persistent; a tab to add extra layers to the one you're editing so you can preview things like a recoloured hair alongside the base body; the option to add a comparison image next to the image you're editing, and more!
I also have tutorials for the tool on my website! How to Colorize Images in Ren’Py and How to Format Images for Colorizing in Ren’Py.
Status | Released |
Category | Tool |
Rating | Rated 5.0 out of 5 stars (1 total ratings) |
Author | Feniks |
Genre | Visual Novel |
Made with | Ren'Py |
Tags | Character Customization, Kinetic Novel, Ren'Py, Shaders |
Download
Click download now to get access to the following files:
Development log
- 8.2 UpdateFeb 06, 2024
- Colorize Tool Tutorial Released!Nov 19, 2023