Ren'Py

fix The fix branch is used for fixes to the current version of Ren'Py that do not require dangerous changes. The fix branch is also the source of the documentation on This branch is automatically merged into master on a regular basis. Pull requests that contain fixes or documentation improvements should be made to the fix branch. When a feature release is made (for example, going from 8.6.x to 8.7.0), the master branch is copied to the fix branch. Fix releases are made from this branch. master The master branch is where the main focus of development is. This branch will eventually become the next release of Ren'Py. Pull requests that contain new features, that require incompatible changes, or major changes to Ren'Py's internals should be targeted at the master branch. Ren'Py depends on a number of Python modules written in Cython and C. For changes to Ren'Py that only involve Python modules, you can use the modules found in the latest nightly build. Otherwise, you'll have to compile the modules yourself. The development scripts assume a POSIX-like platform. The scripts should run on Linux or macOS, and can be made to run on Windows using an environment like MSYS. Note that the latest nightly build is at the bottom of the list. Once you've unpacked the nightly, change into this repository, and run:: Once this script completes, you should be able to run Ren'Py using renpy.sh, renpy.app, or renpy.exe, as appropriate for your platform. The doc symlink will dangle until documentation is built, as described below. Building the modules requires you have the many dependencies installed on your system. On Ubuntu and Debian, these dependencies can be installed with the command:: Ren'Py requires SDL image 2.6 or greater. If your distribution doesn't include that version, you'll need to download it from: We strongly suggest using a package manager to create virtual environment and manage dependencies. We have tested with uv but other package managers should work as well. To create a virtual environment and install dependencies, open a new terminal and run:: Where supported, Ren'Py will attempt to find include directories and library paths using pkg-config. If pkg-config is not present, include and library paths can be specified using CFLAGS and LDFLAGS. If RENPY CFLAGS is present in the environment and CFLAGS is not, setup.py will set CFLAGS to RENPY CFLAGS. The same is true for RENPY LDFLAGS, RENPY CC, RENPY CXX, and RENPY LD. Setup.py does not support cross-compiling. See for software that cross-compiles Ren'Py for many platforms. The renpy-build system also include some runtime components for Android, iOS, and web. Building the documentation requires Ren'Py to work. You'll either need to link in a nightly build, or compile the modules as described above. You'll also need the Sphinx documentation generator. If you have pip working, install Sphinx using:: Ren'Py's documentation consists of reStructuredText files found in sphinx/source, and generated documentation found in function docstrings scattered throughout the code. Do not edit the files in the sphinx/source/inc folder directly, as they will be overwritten. :doc: section kind Indicates that this function should be documented. section gives the name of the include file the function will be documented in, while kind indicates the kind of object to be documented (one of function , method or class . If omitted, kind will be auto-detected. :name: name The name of the function to be documented. Function names are usually detected, so this is only necessary when a function has multiple aliases. :args: args This overrides the detected argument list. It can be used if some arguments to the function are deprecated. def warp speed(factor, transwarp=False): """ :doc: warp :name: renpy.warp speed :args: (factor) transwarp If True, use transwarp. This does not work on all platforms. """ For bug fixes, documentation improvements, and simple changes, just make a pull request. F