Multi-Thumb Bar for Ren'Py

Overview

This tool for Ren'Py adds functionality for a bar with multiple thumbs. Designed to be as easy to use as possible, it includes a thoroughly-documented Creator-Defined Screen Language (CDSL) statement for easy scripting in screens, alongside a Creator-Defined Displayable (CDD) to add this functionality.

While this multi-bar was initially conceived to complement my In-Depth Pronouns system, it can be used for many things, including:

• UI elements to display player stats, approval scores, character traits, and more.
• Easy visual allocation for character stats (e.g. players can allocate 30 points among Strength, Speed, Defence, and Magic)
• Schedules, including for systems with day/night cycles or with class and other daily activity scheduling.
• And more! If you find a cool use for this tool, I'd love to see it!

Description

The zip file contains four script files and three images. The script files are 01_multibar.rpy, multibar_examples.rpy, pronoun_multibar.rpy, and pronoun_screens.rpy.

01_multibar.rpy contains two new classes, MultiBar (a Displayable) and ThumbInfo (a helper class for MultiBar). It also includes a CDSL declaration that uses the keyword multi_bar, which allows for intuitive scripting in screens (no need to mess with Python if you don't want to!).

multibar_examples.rpy includes several multi_bar examples for different situations, and includes a thorough breakdown of all the properties a multi_bar takes.

pronoun_multibar.rpy includes some short code which will allow you to add a multi-bar to the pronoun screen code from In-Depth Pronouns for Ren'Py. You can either copy-and-paste the small multi_bar declaration into your pronouns screen yourself, or use the included pronoun_screens.rpy to overwrite the file of the same name from In-Depth Pronouns.

The three images are for demonstration, and can be safely removed if you no longer wish to see the included examples.

Instructions

Download multi_bar.zip and unzip it to get the multi_bar/ folder. Place the folder into your Ren'Py game folder. If you would like to see the included example multi_bars, include the line call screen multi_bar_examples() somewhere. You can remove the included image files if you are done with the example screen.

Otherwise, you can start adding multi_bar anywhere in your project! Follow the instructions in pronoun_multibar.rpy if you would like to include a multi_bar for my In-Depth Pronouns tool.

Use

Thanks to the Creator-Defined Screen Language, setup for a multi_bar looks like the following:

multi_bar 2:
    xysize (108, 1008)
    bar_range (neutral+paragon+renegade)
    start_values [neutral, paragon, renegade]
    sensitive False
    bars [ "neutral_bar", "paragon_bar", "renegade_bar" ]
    bar_vertical True bar_resizing False
    top_gutter 50 bottom_gutter 50

This creates the bar seen at the very left of the last example screenshot. You can also declare a MultiBar object if desired to add to the screen.

Compatibility

This code has been tested for compatibility with Ren'Py 7.5-7.6 and 8.0-8.2. It is expected to be compatible with earlier Ren'Py versions as well, and should remain compatible into the future (please leave a reply in the forums below if you encounter issues).

Terms of Use

You may:

• Use this code in commercial and noncommercial projects, provided it is packaged into an archived .rpa file. The code to do so is included in the code file.
• Modify and edit the code to suit your needs.

You may not:

• Resell all or part of this code as-is or sell it with modifications
• Release any projects created using this code without providing attribution

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

Final Notes

If you haven't already, take a look at my In-Depth Pronouns for Ren'Py code, which is completely free!

This tool is also part of a bundle alongside Colorize Tool Extras, both addons for my Colorize Tool which allows for in-depth colorizing in Ren'Py:

You can also check out my website, https://feniksdev.com for more Ren'Py tutorials, and subscribe to feniksdev.itch.io so you don't miss out on future Ren'Py tool releases!