Image Tools for Ren'Py

Overview

Thanks to the flexibility provided by layered images, image tagging, and dynamic image paths, character sprites and other dynamically layered images are more complex and flexible than ever. This can make it difficult to envision all the possibilities when it comes to scripting, however - a character with just 5 eye layers, 5 brow layers, and 5 mouth layers already has dozens of possible expressions.

This set of Ren'Py image tools, which begins here with an Image Attributes Tool and shared code across several more tools, aims to provide developers with a simpler and more visual way to preview their sprite expressions for scripting.

Find more tools in my Image Tools collection, such as the below tools:

Description

Included are two files, one with common code required by all my Ren'Py image tools, and one with an Image Attributes Tool with several features:

• Enter an image tag, and use click-and-drag to move the image around the screen and the mousewheel to zoom in and out to position it where needed
• A tab with available attributes for the entered image tag will let you select attributes to apply to the image, narrowing the list to exclude attributes which conflict with already-applied attributes
  • Mark attributes for "swapping" so you can quickly switch between different eye layers, outfits, etc.
  • Filter attributes to quickly find what you're looking for
• A tab to type in attributes for the character to preview in real-time
• A tab to enter short forms used in combination with config.adjust_attributes to apply or remove multiple attributes at once
• Buttons to copy the currently-shown image tag + attributes to the clipboard to paste into your script. Comes in two flavours - one which includes show image_tag and one which is just the attributes (for side images or dialogue)
• Built-in tutorial to walk you through all the features
• Adaptable UI intended to work with most project sizes and dimensions - just drop in your project and get started

Instructions

Unzip the provided image_tools.zip file and drop the included image_tools folder into your project's game/ folder. Create a button to access the tool - I recommend adding a textbutton to the main menu screen with a line like:

textbutton "Image Tools" action ShowMenu("image_tools")

Click this button to go to the tool hub screen, and then click on the Image Attributes Tool button from this screen to access the Image Attributes Tool. The first time you open this screen, 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 this 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

Credits

Special thank you to Wind Chimes for helping to test the code and providing suggestions for additional features, to Esh of Steamberry Studio for making me realize this was a useful tool for others in the first place, and to Ayael of Synstoria for screenshots and testing help!

The character Jori in the screenshots belongs to Reanimation Scheme by Wind Chimes Games.

The MC and character Theodore belong to Imperial Grace by Synstoria.

Final Notes

This is the first part of a multi-part release which includes additional addons to this base image tool. Follow me to be informed of future tools! You may also consider looking at my other Ren'Py tools, which I've added to a collection here: https://itch.io/c/3491447/my-renpy-tools. I also release tutorials on my website, https://feniksdev.com

The next tool is a layered image visualizer, available below!

(Tamarack is from Our Life: Now & Forever by GB Patch)