Open-source project
renpy/renpy avatar
renpy/renpy

Ren'Py from source: nightlies, Cython modules and branch policy

The Ren'Py Visual Novel Engine

7,049 stars972 forksRen'PyLicense varies

At a glance

What is it?
This is the engine repository rather than a game template. pyproject.toml pins Python to a single 3.12 release line and reports version 8.99.99, compiling needs Cython and C modules plus a long apt dependency list, and every patch release is cut from a branch that also serves the documentation site.
Who is it for?
Adopt this checkout if you are changing the engine itself, adding a Cython module, or building documentation for Ren'Py; use the launcher and SDK from renpy.org if you only want to write a game. On Windows, set up llvm-mingw and a windev archive for run.ps1 first, and check whether a nightly build already covers a Python-only change before you install the full apt dependency list.
Can I use it commercially?
Not without permission. GitHub finds no licence file in the repository, and without a licence all rights are reserved by default: you may read the code but not reuse it. Check the README, or ask the authors, before using it.
Is it still maintained?
Yes. The repository received new commits within the last day.
What is it written in?
Mainly Ren'Py, according to GitHub's language statistics.

Answers come from the project's GitHub data, last synced on November 22, 2026, and from our analysis. They are not legal advice.

From daily snapshots

Star history

  • renpy/renpy7,049 ★ · +195
Star history
Repository2026-09-232026-11-22
renpy/renpy6.9k7k

195 Stars in the last 60 days, measured from the daily GitHub snapshot. Compare with other projects

Editorial analysis

Master carries 8.99.99 while releases ship 8.5.x

Ren'Py's pyproject.toml declares version = 8.99.99, a number you will never download. The three recent GitHub releases are 8.5.3 dated 2026-05-16, 8.5.2 dated 2026-01-04 and 8.5.1 dated 2026-01-01. The placeholder on master tells you which tree you are holding: master is where the next feature release is assembled, while the fix branch is what produces the versions people actually install.

The gap also decides which branch to read. Someone debugging a shipped game wants fix, not master, because master may already hold incompatible internals. Someone adding a feature has no choice but master.

Two more entries in the same file shape your tooling. The project name is renpy with readme = README.rst, and requires-python is >=3.12.8,<3.13, so neither 3.11 nor 3.13 is a supported interpreter. GitHub reports no licence for this repository, while pyproject.toml sets license = "MIT" and setup.py carries an MIT permission grant.

The fix branch publishes the site and owns every patch release

Ren'Py runs four kinds of branch, and the split matters more than it sounds. The fix branch takes fixes to the current version that do not require dangerous changes, and it is also the source of the documentation served at renpy.org. It is merged into master on a regular basis. Feature releases come out of master, and when one is made, going from 8.6.x to 8.7.0 for example, master is copied into fix. Later fix releases are cut from there.

That copy step has a consequence for anyone who assumes a patch lands on master. It lands on fix first and reaches master through the regular merge. A pull request carrying new features, incompatible changes or major changes to Ren'Py's internals is meant for master instead.

Work branches are named rather than free form. They must start with work/<username>/, or work/shared/ for work several contributors share equally, and a GitHub rule enforces that prefix. Branches beginning with history/ hold commits kept out of the GitHub interface on purpose.

Link a nightly, or compile the Cython modules

Ren'Py depends on Python modules written in Cython and C, and that single fact decides how you install. If your change only involves Python modules, you can use the modules from the latest nightly build and skip compiling. Anything deeper means compiling them yourself.

Nightly builds are downloaded from nightly.renpy.org, where the newest build sits at the bottom of the list. Unpack it, change into the repository, and point the checkout at that path:

bash
./after_checkout.sh <path-to-nightly>

Once the script completes you can run Ren'Py with renpy.sh, renpy.app or renpy.exe, whichever matches your platform. Set one expectation first: the doc symlink dangles until the documentation has been built, so a fresh checkout looks incomplete before you do that work.

If a nightly build misbehaves, the advice in the file is to wait 24 hours for the next build before suspecting your own setup. If that one fails too, it points you at Tom Rothamel.

SDL_image 2.6 is the hard floor in the apt line

Compiling needs a long dependency list, given as a single apt command on Ubuntu and Debian:

bash
sudo apt install python3-dev libassimp-dev libavcodec-dev libavformat-dev libavutil-dev \
    libswresample-dev libswscale-dev libharfbuzz-dev libfreetype-dev libfribidi-dev \
    libsdl3-dev libsdl3-image-dev libpng-dev pkg-config

Read it as three groups. Codec and imaging libraries, libavcodec, libavformat, libavutil, libswresample, libswscale and libpng, cover media decoding. Text layout comes from harfbuzz, freetype and fribidi. SDL3 appears twice: the base library and image. Assimp handles 3D model import, and pkg-config is present so setup.py can locate include directories.

After that, the README suggests `uv sync` to create a virtual environment and install dependencies, then `./run.sh` to compile the extension modules and run Ren'Py.

No build backend, and seventeen runtime dependencies

Two decisions in pyproject.toml shape a contributor's setup. The first is requires-python = >=3.12.8,<3.13, a pin to one minor version rather than a minimum. The second is the absence of a build system: the file says outright that Ren'Py is not using one because build isolation makes building too slow, so the build-system table is commented out and setup.py drives the work directly.

The dependency list is what lands in the environment: future, six, pefile, requests, rsa, chardet>=7.7.0, websockets>=17.3, pysocks>=1.7.1, certifi, jinja2 and truststore. Eleven entries in all.

Type checking is configured but relaxed. pyright runs with typeCheckingMode = "basic", adds runtime to extraPaths, and switches off a batch of reports including reportOptionalSubscript, reportOptionalMemberAccess, reportOptionalCall and reportMissingModuleSource.

setup.py refuses cross-compiling and hands mobile to renpy-build

setup.py does not support cross-compiling, and the README does not pretend otherwise: it sends you to the renpy-build repository for software that cross-compiles Ren'Py for many platforms. That build system also includes runtime components for Android, iOS and web. A question about putting a game on a phone therefore lands outside this checkout by design.

Paths on the current platform are found with pkg-config where it is supported. When pkg-config is missing, include and library paths come from CFLAGS and LDFLAGS. A rename-through layer sits on top: if RENPY_CFLAGS is set and CFLAGS is not, setup.py copies RENPY_CFLAGS into CFLAGS, and the same holds for RENPY_LDFLAGS, RENPY_CC, RENPY_CXX and RENPY_LD. Anything exported under those RENPY_ prefixed names reaches the compiler, but only while the unprefixed variable is unset.

scripts/setuplib.py is where that logic lives, and setup.py imports it alongside scripts/generate_styles.py. The build changes directory to the file's own location, then takes a lock at tmp/.cython.lock before generating styles, so two concurrent builds do not race the same generated files. Optimization level against debugging level is one of the compile arguments setuplib exposes.

The doc symlink dangles until build.sh runs

Building the documentation needs a working Ren'Py first, which means either linking a nightly build into the checkout or compiling the modules, plus the Sphinx generator:

bash
pip install -U sphinx sphinx_rtd_theme sphinx_rtd_dark_mode sphinx-tabs

After that you change into the sphinx directory inside the checkout and run build.sh. That step is also what stops the doc symlink from dangling.

The output is assembled from two places: reStructuredText files in sphinx/source, and docstrings scattered through the code. Files under sphinx/source/inc are generated and get overwritten, so editing them by hand loses the work. Docstrings steer the generator with three tags on their first lines. :doc: names the include file plus the kind of object, one of function, method or class, and the kind is auto-detected when you leave it out. :name: overrides the name of a function that has several aliases, and :args: overrides the detected argument list, which is how a deprecated argument gets hidden from the generated page.

MSYS on Windows, an issue before a large pull request

The development scripts run on Linux, macOS and Windows. On Windows, run.ps1 does the same job as run.sh, after you install llvm-mingw and extract a windev archive from the nightly builds for your branch.

Pull requests with fixes or documentation improvements go to the fix branch, while new features, incompatible changes and major changes to Ren'Py's internals go to master.

Translation has its own written path, because the launcher and the template game both carry translated strings. TRANSLATORS.rst sits at the repository root, and the file points translators to a specific topic on the Lemmasoft forums for current best practices instead of restating them. The repository also keeps testcases/, the_question/ and tutorial/ directories.

Editorial conclusion

Adopt this checkout if you are changing the engine itself, adding a Cython module, or building documentation for Ren'Py; use the launcher and SDK from renpy.org if you only want to write a game. On Windows, set up llvm-mingw and a windev archive for run.ps1 first, and check whether a nightly build already covers a Python-only change before you install the full apt dependency list.

Frequently asked questions

Is Ren'Py just Python?

Partly. The engine depends on Python modules written in Cython and C, so changes to those modules have to be compiled and setup.py drives that work. For changes that only involve Python modules, the project says you can use the modules from the latest nightly build instead.

What is Ren'Py usually used for?

Visual novels and games in that style. This repository holds the engine sources together with launcher/, gui/, tutorial/ and sdk-fonts/ directories.

How do I run Ren'Py on iOS?

Through another repository. setup.py does not support cross-compiling, and the project points you to renpy-build for software that cross-compiles Ren'Py for many platforms. That build system also includes runtime components for Android, iOS and web.

How do I install Ren'Py from this repository?

Download a nightly build from nightly.renpy.org, unpack it, change into the repository and run ./after_checkout.sh with the path to that nightly. Once it completes you can start the engine with renpy.sh, renpy.app or renpy.exe. Compiling the modules instead requires the full apt dependency list and Python 3.12.

Official sources

  1. Issues
  2. Project website
  3. README
  4. Releases
  5. renpy/renpy on GitHub
Add this badge to your README

If you maintain this project, the badge below links readers to this analysis and shows its maintenance status from the daily GitHub snapshot. Paste the markdown into your README; add ?metric=license or ?metric=stars to the image URL for a different field.

Add this badge to your README

markdown
[![Hysen Labs](https://hysenlabs.com/badge/renpy-renpy.svg)](https://hysenlabs.com/projects/renpy-renpy)

Star history chart for your README

markdown
[![Star history](https://hysenlabs.com/chart/renpy-renpy.svg)](https://hysenlabs.com/projects/renpy-renpy)

Was this useful?