Ren'Py Visual Novel Engine Logo 8.3.8 Documentation

Getting Started

  • Quickstart
  • GUI Customization Guide

The Ren'Py Language

  • Language Basics
  • Labels & Control Flow
  • Dialogue and Narration
  • Displaying Images
  • In-Game Menus
  • Python Statements
  • Conditional Statements
  • Audio
  • Audio Filters
  • Movie
  • Voice

Text, Displayables, Transforms, and Transitions

  • Text
  • Translation
  • Displayables
  • Transforms
  • Transform Properties
  • Transitions
  • Matrixcolor
  • Layered Images
  • 3D Stage
  • Live2D Cubism

Customizing Ren'Py

  • Styles
  • Style Properties
  • Screens and Screen Language
  • Screen Actions, Values, and Functions
  • Special Screen Names
  • Screen Language Optimization
  • Configuration Variables
  • Preference Variables
  • Store Variables
  • Custom Mouse Cursors
  • Text Shaders

Tools

  • Launcher
  • Developer Tools
  • Interactive Director

Other Functionality

  • NVL-Mode Tutorial
  • Speech Bubbles
  • Text Input
  • Side Images
  • Image Gallery, Music Room, and Replay Actions
  • Drag and Drop
  • Sprites
  • Customizing the Keymap
  • Achievements
  • Dialogue History
  • Multiple Character Dialogue
  • Splashscreen and Presplash
  • Lifecycle of a Ren'Py game

Python and Ren'Py

  • Statement Equivalents
  • Saving, Loading, and Rollback
  • Persistent Data
  • Advanced GUI
  • Screens and Python
  • Creator-Defined Displayables
  • Creator-Defined Statements
  • Custom Text Tags
  • Character Callbacks
  • File Access
  • Color Class
  • Matrix
  • Model-Based Rendering
  • Other Functions and Variables
  • _ren.py Files - Ren'Py in Python
  • HTTPS/HTTP Fetch
  • Screenshots

Building, Updating, and Other Platforms

  • Building Distributions
  • Android
  • iOS
  • Web / HTML5
  • Chrome OS/Chromebook
  • Raspberry Pi
  • In-App Purchasing
  • HTTPS/HTTP Updater
  • Downloader for Large Games on Mobile
  • Gestures

End-User Documentation

  • Security
  • Dealing with Problems
  • Environment Variables
  • Self-Voicing

Library and Tool Developer Documentation

  • Template Projects
  • Command Line Interface

Engine Developer Documentation

  • Text Editor Integration
  • Skins
  • Translating Ren'Py

Changes, License, and Credits

  • Changelog (Ren'Py 7.x-)
  • Changelog (Ren'Py 6.11 - 6.99)
  • Incompatible Changes
  • License
  • Credits
  • Ren'Py Development Sponsors
Ren'Py Visual Novel Engine
  • Search

Built with Sphinx using a theme provided by Read the Docs.