From Ren'Py Visual Novel Engine

Ren'Py Cookbook

Welcome to the Ren'Py cookbook. Here, you will be able to find user-contributed recipes that allow you to accomplish common (and not-so-common) tasks with Ren'Py.

Please also take a look at the frameworks, which contain more complicated code to allow specific styles of games.

Note that many of these are meant to accomplish specific tasks, and aren't very good examples of Ren'Py code that is used to write games.

Existing Recipes

Special Effects

• Springy movement - Adding bouncy motion to your Moves. (6.6.3)
• Showing and Hiding the Window (2007-12-19)
• Setting Fullscreen
• Showing a Quick Splashscreen While Ren'Py is Loading
• Showing a Fancy Splashscreen After Ren'Py has Loaded
• A Simple Flash (Light Saturation) Effect
• Using a "Noise" Image Dissolve
• Implementing a Double Vision Effect
• Shake Effect
• Animate Character Lip Movement (Lip Flap)
• Animate Character Blinking And Lip Flap
• Showing layered sprites with different emotions
• Particle Burst
• Creating a TV-static effect for background
• Creating a more realistic snow effect (6.9.0)

User Interface

• Adding On-Screen Buttons
• Quick Save and Load
• Repositioning Elements in the Main Menu or Game Menu
• Setting Auto-Read Automatically
• Setting the Default Text Speed
• RPG frame
• Tile Engine for Tile-Based Maps and Unit Engine for Turn-Based Games
• Making adult scenes optional, by adding "Hentai Enabled/Disabled" to preferences
• Center the main program window on startup
• Placing the speaking character's name above the text window

Localization

• Supporting Chinese or Japanese in Your Game (6.3.2)
• Multiple Language Support (6.9.3)
• Translating Ren'Py Menus, Buttons, etc.
• Inputting information in a language other than English
• Convert text strings to kana
• Korean Inputter(like Princess Maker series)

Packaging/Space Saving

• JCC - Jpeg Compression of Character Art (6.6.3)
• Single-Directory Mac Application
• NSIS - Building a Windows installer using NSIS

Miscellaneous

• Music Room (6.8.1)
• New CG Gallery (6.6.0)
• Good Looking Italics
• Inventory and Money Systems (6.9.3)
• Tips menu
• Unarchiving files from rpa
• Who's that? Changing character names during the game
• Conditional Hyperlinks
• Timed menus
• Custom text tags
• About this game - How to add a simple readme into the game
• Additional basic move profiles - A collection of extra basic motion profiles to spice up your Moves.
• Konami Code - Add the Konami Code to your game. Fairly easily adapted to other secret codes.
• In-game Splashscreen - Create an in game skippable movie using images.
• Runtime init blocks - Initialize variables outside of init blocks in all files
• SVG color names - access more colors by name (more than 140 instead of just black)
• renpy/doc/cookbook/Initializing_Images_Mini-Engine - initialize .png and .jpg files automatically in the main game directory.

Sound and music

• Ambience generator

Create a new Recipe

You can create a new recipe by filling out this form with the title of the recipe you want. You'll need to be able to edit wikicode. See Help:Editing for details on that, and Wiki:Style Guide for a list of things specific to this wiki.

When done, add this to this page by adding the wikicode:

*[[../New Recipe Name/]]

to one of the categories above.

If someone forgot to add a cookbook page, it will show up in the Cookbook Index. Please add it here.