https://github.com/jsfehler/renpy-encyclopaedia

A Ren'Py plugin for creating an Encyclopaedia/Glossary/Bestiary or similar system.
https://github.com/jsfehler/renpy-encyclopaedia

python renpy

Last synced: about 1 year ago
JSON representation

A Ren'Py plugin for creating an Encyclopaedia/Glossary/Bestiary or similar system.

• Host: GitHub
• URL: https://github.com/jsfehler/renpy-encyclopaedia
• Owner: jsfehler
• License: mit
• Created: 2015-03-01T04:56:55.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2025-01-19T14:58:33.000Z (over 1 year ago)
• Last Synced: 2025-03-30T03:11:01.742Z (about 1 year ago)
• Topics: python, renpy
• Language: Python
• Homepage: https://renpy-encyclopaedia.readthedocs.io/
• Size: 7.01 MB
• Stars: 61
• Watchers: 8
• Forks: 6
• Open Issues: 5
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md

Awesome Lists containing this project

README

          
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 `_

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 `_