Frame Tool for Ren'Py

Overview

If you've ever struggled with making resizeable backgrounds using Frame, or disliked the inefficiency of guess-and-check for getting the correct numbers, the Frame Tool will help visually present how your resizeable background will look in a simple, intuitive manner.

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

This tool also accompanies my tutorial on resizeable backgrounds for Ren'Py: How to make resizeable backgrounds in Ren’Py with Frame

Description

Included is a file, frame_tool.rpy, with the following features:

• Enter an image path or image name from your project and click and drag the resizing rectangle on the left side to adjust the Frame numbers
• Preview the result of your Frame on the right side, which also has a resizing rectangle to see how it adapts to different dimensions
• Zoom in or out of your image to carefully adjust the Frame numbers or preview it at different sizes
• Use the arrow keys to nudge the selected edge one pixel at a time for extra precision
• Hold down ALT while dragging to adjust the Frame borders symmetrically, or use the Lock Symmetrical button
• Toggle tiling on, off, or use integer tiling
• Flip the UI colours for better contrast with your images
• Copy the final result to the clipboard, formatted so it can be pasted directly into Ren'Py
• Adjust padding numbers on the right side, with a text preview for what it will look like
• Copy the final padding numbers to the clipboard
• 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

Drop the provided frame_tool.rpy file into your project's game/ folder or a subfolder.

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")

Click this button to go to the tool hub screen, and then click on the Frame Tool button from this screen to access the Frame 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 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

Final Notes

If you haven't already, be sure to check out my tutorial, How to make resizeable backgrounds in Ren’Py with Frame. Keep an eye out for a future release on Frame as well, which will act as a playground/test area for using Frame - you can follow me to be notified of new tools and tutorials!

If you haven't already, you should also check out the other tools in my image tools series, which all build off of the base Image Tools for Ren'Py toolset. You can find the whole collection here: https://itch.io/c/3637329/image-tools