Installation

The framework must be placed somewhere inside your project’s game/ directory. Ren’Py is able to detect any valid code inside that directory.

Using Pip

As of version 3.0 the renpy-encyclopaedia project can be installed using pip. pip is included with python. If your machine has python installed, pip is installed as well.

Warning

Although it uses many parts of the Python ecosystem, renpy-encyclopaedia is not a stand-alone python package and is not designed to work outside of a Ren’Py project.

From the console, navigate into your project’s root directory.

Note

pip’s --target argument can be given any path inside your project’s game/ directory.

From PyPi

To install the latest version from PyPi, run the following command:

pip install --no-compile --target game renpy-encyclopaedia

From Github

To install from Github run the following command, replacing <VERSION_NUMBER> with the version of the framework you want to install:

pip install --no-compile --target game git+https://github.com/jsfehler/renpy-encyclopaedia.git@<VERSION_NUMBER>

Manual

  1. Download the version you want to install at: https://github.com/jsfehler/renpy-encyclopaedia/releases

  2. Place the encyclopaedia folder inside your project’s game directory.

Compatibility With Ren’Py

Version 2.x of the Encyclopaedia is compatible with Ren'Py 6.99.12.3 and up.

Version 3.x of the Encyclopaedia is compatible with Ren'Py 8.1.0 and up.

Generally, you should use the latest version of the Encyclopaedia with the latest version of Ren’Py. Version 2 of the Encyclopaedia is no longer developed and only useful for games that are stuck on older versions of Ren’py.