Ren'Py Ripple Transition

Overview

A custom transition for Ren'Py using a shader and a custom Transition class which displaces the screen and creates a ripple effect. Useful for dream sequences, underwater or rain effects, magic, and more.

Features

The transition has several variables you can use to modify appearance, including:

• Length of transition
• Center of ripples
  • A set position (as (x, y) coordinates)
  • Begin at last mouse position
  • Follow cursor during transition
  • Provide a function to adjust the center of the ripple over the course of the transition
• Aspect ratio of ripples (adjust for screen size or provide your own multiplier)
• Number of ripples
• Ripple density and jitter
• Fade origin

Works everywhere Ren'Py can use transitions, such as transitioning between screens, when showing an image, or using the With() screen action. Suits all screen sizes and orientations. 

Instructions

Download ripple.zip and unzip it to get ripple.rpy. Drop ripple.rpy into your game folder and try some of the presets or provide your own arguments e.g. show bg sky with Ripple(2.0). An example label is provided with some demo transitions, which you can try out by jumping to the label ripple_test.

Compatibility

This tool requires Ren'Py 7.4+ and config.gl2 to be True. It has been tested for compatibility with Ren'Py 7.5-7.6 and 8.0-8.2. If you have any issues, please make a post in the forums below.

Terms of Use

You may:

• Use this code in commercial and noncommercial projects, provided you package the code into an rpa file for release - the code to do so is included in the files.
• Modify and edit this 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.

Credits

Credits sequence with mirror transition from Reanimation Scheme by Wind Chimes Games.

Example puddle images were sourced from Pexels.com here and here. Animated cloud backgrounds were created by me as used in my Mysterious Messenger side project.

Final Notes

Next week I'll be posting another tutorial in my series on screen language, this one on images and text. I'll make a general update post on itch.io here when it's available, and you'll be able to find it on feniksdev.com!

Speaking of screen language, consider picking up my free Easy Ren'Py GUI template, which simplifies Ren'Py's default project template to make it easier to modify:

See you next week!