Encyclopaedia Framework for Ren’Py

Build status https://coveralls.io/repos/github/jsfehler/renpy-encyclopaedia/badge.svg?branch=master

A plugin for the Ren’py Visual Novel engine

Use it to create an encyclopaedia, bestiary, glossary, codex or similar system.

Features

  • Sort entries by Number, Alphabetically, Reverse Alphabetically, by Subject, or by Unread status.

  • Filter entries by Subject.

  • Sub-page system for nesting entries. Allows an entry to be unlocked progressively.

  • Locking/unlocking allows you to decide when entries should be accessible.

  • Locked entries can be displayed with customizable placeholders or outright hidden.

  • Entry Unlocks can be tied to individual save games or universal (using Ren’py persistent data).

  • Default visual template is provided, but can be completely customized or replaced using Ren’py Screen Language.

Documentation

Documentation is available at https://renpy-encyclopaedia.readthedocs.io/

Contributing

For filing bugs or feature requests, please use the GitHub issue tracker