.. Renpy-Encyclopaedia documentation master file, created by
   sphinx-quickstart on Sat Nov 18 13:25:26 2017.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Encyclopaedia Framework for Ren'Py
==================================

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

Simplifies creating an encyclopaedia, bestiary, glossary, or similar system.

Compatible Ren'Py Version: 6.99.12.3 and higher

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
-------------
The :ref:`Documentation <documentation>` section has installation instructions and tutorials.

The :ref:`Module Index <modindex>` has in-depth information on the Encyclopaedia's classes and functions.

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