Layered Image Visualizer for Ren'Py [Addon]

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, beginning with the Image Attributes Tool and continuing with this Layered Image Visualizer, aims to provide developers with a simpler and more visual way to preview their sprite expressions for scripting.

The files from Image Tools for Ren'Py are required for this tool to work.

Description

The layered image visualizer builds off of Image Tools for Ren'Py, with features specific to layered images:

• Enter an image tag and use a custom crop tool to specify an area (such as the face) to focus on for attribute changes. Tags can be saved and crop areas are automatically persisted between relaunches.
• Select groups from your layered image to display in a visual grid, which you can select individual attributes from to apply to the image.
• Supports short forms in combination with config.adjust_attributes to preview and apply multiple attributes at once.
• Randomize attributes in the currently selected groups to find unique expression combinations
• Buttons 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

Included in layered_image_visualizer.zip is one script file, layered_image_visualizer.rpy inside an image_tools folder. Place the image_tools folder with your other script files inside the project's game/ folder.

This tool requires the files from Image Tools for Ren'Py. You must include those files in your project as well for this tool to work.

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 Layered Image Visualizer. 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 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 the following for contributing screenshots:

• Seamus is from Of Sense and Soul by Forsythia Productions
• Aldrias is from Reanimation Scheme by Wind Chimes Games
• Marion is from Made Marion by Velvet Cupcake Games

Final Notes

This is the second part of a multi-part release which includes addons to the base Image Tools for Ren'Py tool. Follow me to be informed of future releases! 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, http://feniksdev.com

The third and final tool in this release series is an image tinter. Find it below!

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