Skip to content

Ren’Py

plugin_id: renpy · Engine family: Ren’Py

Upstream: renpy/renpy. Adaptation fork: Project-Shinkirou/renpy, shinki branch.

This core embeds the official Ren’Py runtime rather than translating its scripts to a new VM. Script execution, Screen Language, ATL, GL2 composition, media and saves keep their official behavior. The integration pins the official SDK, CPython 3.12.7, Cython 3.2.4 and SDL 2.0.20; runtime checksums and sources are recorded in shinki/sdk.json.

Android uses a static adapter for arm64-v8a and x86_64. The pinned official source recipes build CPython 3.12.8, Ren’Py, SDL2 and codecs; desktop SDK binaries and RAPT shared libraries are not target inputs. shinki/android_runtime.py requires Ubuntu 24.04, the NDK r29 Linux archive and the Cubism 4-r.6.2 header SDK listed in shinki/sdk.json. Cubism Core is game-supplied and is not bundled.

Manager sets the extracted cores/renpy/Resources path before registering the provider. The compiled display module remains a builtin, rendering through a private SDL2 EGL pbuffer and GLES while Manager owns presentation. C/C++ dependency symbols are isolated from other cores. Python resources use the inventoried pure Python artifacts, not host-native wheels. Source packages preserve native recipes, patches, Python sources and full Manager/fork sources for LGPL relinking. APK build, resource, native-closure and signature gates are separate from device/game acceptance.

The adapter preserves Ren’Py 8.5.3 save-location behavior. With a config.save_directory, the runtime synchronizes the game-local <game>/game/saves directory with %APPDATA%/RenPy/<config.save_directory>; when it is unset, saves use <game>/game/saves. Save tokens and backups follow the same upstream resolver. No Shinki-specific data directory is required.

Beta.3 imports the former default %LOCALAPPDATA%/ShinkiEMU/renpy/<game-hash>/saves once, before save tokens and persistent data load. Missing save files are copied byte-for-byte into the native save directories; an existing file in either native directory wins. Tokens and backups go through the upstream resolvers. The old files remain, and a completion marker prevents deleted saves from being imported again. A failed import leaves no completion marker and reports a warning; the runtime still uses its normal locations, with no writable-directory fallback.

If you chose a custom data_directory in beta.1/beta.2, close the game and copy missing files from <old-directory>/<game-hash>/saves into <game>/game/saves. Copy its tokens and backups subdirectories into the corresponding upstream Ren’Py directories, not into the game save directory. Do not replace existing files. Existing native security keys are retained; Ren’Py may ask you to trust an imported save signed by a different key. The Manager shows the retired path once so you can locate it. Logs and generated caches use upstream locations; Python interpreter bytecode writes remain disabled.

Storage comparison base: upstream 39895c1e017f0b36ffea2447d97eccd69d76ee1c (the fork’s merge base). renpy.py, savelocation.py, loader.py, script.py and translation output paths are unchanged. The five added lines in main.py only invoke the one-time import before the native token/persistent loaders.

Directory probing validates UTF-8 in native C++ before inspecting .rpy, .rpyc and .rpa paths. It does not call Python or start CPython; interpreter creation remains in the module-owner lifecycle. Invalid UTF-8, embedded NULs and invalid directory paths still return INVALID_ARGUMENT.

Windows builds generate MSVC import libraries from the official SDK DLLs in the Rust build helper, then link those SDK libraries into both the display extension and the core. The package includes the SDK-generated renpy/vc_version.py.

Linux builds use the official SDK’s combined librenpython.so and a native display.so extension. Both resolve the runtime relative to the installed core. cargo xtask deps --core renpy --target x86_64-unknown-linux-gnu builds a task-owned CPython/Cython interpreter from pinned sources; it does not require Windows DLLs or an interpreter from a developer’s environment.

The runtime bridge remains part of the embedded interpreter. Native build output includes the display extension and real shared core, while the package also needs matching SDK DLLs and Resources/. Session close and cross-game reopening retain interpreter/native cleanup responsibilities; copying only the core DLL is insufficient.

The desktop adapter targets Windows x64/MSVC and Linux x64/GNU. Other targets remain blocked until their native runtime and packaging gates pass. Upstream Ren’Py platform support does not imply the adapter is ported to those platforms. Official standard archive readers remain unchanged; edition-specific offline transformations belong in reviewed recipes. No Steam, Cubism, Bink, nvdrs or redistributable D3DCompiler DLL is bundled.

The runtime includes multiple licenses, including LGPL dependencies with corresponding-source and relinking obligations. Preserve official notices rather than labeling the whole runtime MIT.

See the core directory for build/release status and compatibility reports for specific releases. See also Core ABI and User guide.