Encyclopaedia Framework for Ren'Py

.. image:: https://github.com/jsfehler/renpy-encyclopaedia/workflows/CI/badge.svg :target: https://github.com/jsfehler/renpy-encyclopaedia/actions/workflows/test.yml :alt: Build status

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

A plugin for the Ren'py Visual Novel engine <https://www.renpy.org/>_

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 <https://www.renpy.org/doc/html/screens.html>_.

Documentation

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

Contributing

For filing bugs or feature requests, please use the GitHub issue tracker <https://github.com/jsfehler/renpy-encyclopaedia/issues>_