Managing and Securing Ren'Py Save Data with Encryption

The Challenge of Save Data Integrity

By default, Ren'Py save files are Python pickle dumps compressed with zlib. While efficient for storing game state variables and displayable metadata, these files are essentially open books to any user with basic Python knowledge. If your game relies on hidden flags for achievements or prevents sequence-breaking through save-file manipulation, standard saves are insufficient.

The primary takeaway is that while Ren'Py provides a built-in AES-256 encryption toggle, it is a destructive security measure: if the encryption key is lost or changed, existing save files become permanently unrecoverable.

Prerequisites

• A Ren'Py project (compatible with versions 7.x or 8.x).
• Access to the options.rpy or script.rpy file for configuration changes.
• A basic understanding of how the config object handles engine-level settings.

Implementing Save File Encryption

To prevent users from editing save files with external tools, you can enable the encrypt_save_files configuration. This wraps the compressed pickle data in an AES-256 encrypted layer.

Add the following line to your options.rpy file:

# Enable encryption for all save files
define config.encrypt_save_files = True

When this is set to True, Ren'Py will prompt the developer for a passphrase during the build process or use a predefined key to secure the data. Once enabled, any file written to the save directory will be encrypted before being written to disk.

Comparing Save States: Standard vs. Encrypted

Verifying the Encryption State

To ensure the encryption is functioning and to understand the risk of data loss, perform the following diagnostic check:

1. Launch your game and create a new save slot via the in-game menu.
2. Navigate to the game's save directory (typically /game/saves or the OS-specific appdata folder).
3. Open the .save file in a hex editor or a text editor.
4. Check: If config.encrypt_save_files = False, you will see zlib headers or recognizable strings of your game variables. If True, the file will appear as high-entropy random data with no discernible patterns.

Handling Version Compatibility

Ren'Py 7.x (Python 2) and 8.x (Python 3) handle pickle protocols differently. If you are migrating a project from 7.x to 8.x, be aware that save files are generally not cross-compatible due to the change in the underlying Python version. Encryption adds another layer of complexity; if you change the encryption key during a version migration, users will be unable to load their old progress regardless of the Python version.

Rollback and Recovery

Because encryption changes the state of the files written to the disk, you cannot simply toggle the setting back to False to "decrypt" existing files.

To revert to unencrypted saves:

1. Set define config.encrypt_save_files = False.
2. Delete the existing save folder or instruct users to clear their save data.
3. The engine will begin writing standard zlib pickle files again.

Warning: There is no built-in recovery mechanism for encrypted saves. If the passphrase is lost, the data is permanently inaccessible.