This is Caption Tool, a simple tool for adding image and sound captions to your Ren'Py game. (For an example of a game using this tool, take a look atA YEAR OF SPRINGS.) It was originally made in Ren'Py 7.2.2.491 and updated to support up to Ren'Py 8.3.4.24120703. (It should work with newer versions of Ren'Py as well, but it has not been tested in them.)

Features:

• Image captions that work with Ren'Py's self-voicing option
• Sound captions for describing music and sound effects
• Dialogue on first run asking if users want to turn on captions
• Button to Ren'Py's built-in accessibility menu, which has options to change the font, font size and line spacing
• Guide to show how these functions work in-game

To use this tool, follow these steps:

1. Copy the file named captiontool.rpy from the game folder into the game folder of your own game.
2. Add the following textbutton a screen somewhere in your game, such as the Preferences screen in your game's screens.rpy file. (You can look at the screens.rpy file of this tool for an example.)
   textbutton _("Accessibility") action ShowMenu("accessibility")
3. Edit captiontool.rpy to add your own sound/music and sound/music captions and make any other changes as necessary.

You can also play the guide by launching the tool through Ren'Py if you put the folder into your Ren'Py project directory. It gives examples of how image and sound captions can be used.

The code in this tool can be used in any way you like! If you use this tool, I would appreciate it if you credit Caption Tool or npckc (https://npckc.net orhttps://npckc.itch.io) in some way, but it isn't required.

Recommendations:

Caption Tool was made back when Ren'Py was still in 7.2. It still works and is simple to use, but if you want more features for audio captions, I suggest taking a look at these tools other people have made:

• Background Description Function by Spiral Atlas Games, which adds a function for automatically describing the displayed background to Caption Tool
• Sound Disabler and Captions Tool for Ren'Py by Feniks and Alaric from Just Write Studios, which has been tested for compatibility in 8.2-8.4, has more features and also works with the default Ren'Py audio commands

~

Want to see more stuff like this? Sign up for my newsletter!

Join my Patreon for secret updates, a monthly digital postcard & early access to my games!

~

Updates:

• 2025/02/20 Added better translation support and removes need to separately define and initialise translated sound captions (thank you to Kinmoku for the code!) 
• 2021/08/30 Added support for queueing audio files & Ren'Py 7.4 relative volume
• 2021/08/29 Removed {fast} tag from captiontool.rpy & added explanation for config.descriptive_text_character
• 2021/03/07 Fixed issue where captions would sometimes show the caption for the previous music file when the stop music command was used with fadeout
• 2020/12/09 Added support for custom sound/music channels
• 2019/09/17 Added more support for sound captions
• 2019/07/07 Updated to ren'py 7.3.2 which includes new descriptive text options
• 2019/05/22 Full release with updated music, font & choice UI
• 2019/05/21 Early access for patrons with placeholder music

Click download now to get access to the following files:

Comments

Log in with itch.io to leave a comment.

textbutton "English" action Language(None), SetField(persistent, "lang", "english")textbutton "日本語" action  Language("japanese"), SetField(persistent, "lang", "japanese")