Ren'Py Encyclopaedia Framework
This is a live demo for the Ren'Py Encyclopaedia framework. To demonstrate what It can do, the framework's own documentation is put inside a Ren'Py project, along with a small game used to test various features. This demo is also available below as a download for Windows and Linux.
To use this framework in your own project, the online documentation provides a full usage guide.
Support
To support this project, consider rating it on itch.io and starring it on Github. This helps other people discover it.
Financial donations help keep me alive but are not necessary to use this software. Donations can be made by paying for a download of the demo or on Ko-fi.
Source Code: https://github.com/jsfehler/renpy-encyclopaedia
Latest Release: https://github.com/jsfehler/renpy-encyclopaedia/releases/
Online Documentation: https://renpy-encyclopaedia.readthedocs.io/
Download
Click download now to get access to the following files:
Development log
- Version 3.6.0 released12 days ago
- Version 3.4.1 released60 days ago
- Version 3.4.0 released67 days ago
Comments
Log in with itch.io to leave a comment.
Is it possible to, say, completely hide unlocked entries from the interface so that there's no way to tell the total amount of entries?
Edit: Sorry! I just figured out about show_locked_buttons
Hi, I'm VERY new to Ren'py, and have taken your amazing framework into my current game project. I've been reworking it into a sort of quest guide, and I had a couple questions:
1. Is it possible to have entries into the encyclopaedia added onto the same page, updating the info on that page rather than having to move on to a new one, I can't find any reference to this in the doc, so I have no idea if this is even possible.
2. How do I go about changing text size and colour, I can't seem to find these in any of the .rpy files, I may just be blind tho so sorry if I missed it completely.
Once again, you've done an amazing job with this framework, and letting the community use it, is all in all something that you should be incredibly proud of.
1. You can change the value of an EncEntry's `text` attribute, for example:
2. All visual aspects are handled by Ren'Py's Styles system. The styles used by the Encyclopaedia's UI are located at the bottom of `screens.rpy`.
I think I understand the answer to 1., although I am having some trouble with it, it currently makes all of the text in the entry align vertically and go down the page, and I have no idea how to fix it, I used the code almost exactly as you did in the example.
Hello, thank you for this framework! The usage guide is really helpful.
Sorry for being out of topic, but recently I also had taken interest in your other repo, the doomfire effect in renpy. It was written for python 2.7, so I tried porting it to Python3, only to find that I cannot make it work in my machine owing to a bunch of deprecated pygame-sdl2 libraries and…I think x32 library vs. x64 machine…? Just asking if you have any interest in revisiting the project, because the effect is really cool.
Off the top of my head, nothing in that project used python 2.7 exclusive code and pygame_sdl2 hasn't removed any functionality. I'm also able to run the pure python implementation inside Ren'Py 8, although I haven't tested the others. If you're trying to compile the code using cython 3 it's probably not going to work inside Ren'Py. Ren'py currently uses an old version of cython and you have to build against their target cython version. However, I haven't tried building cython code that's compatible with Ren'Py 8 so I can't say for sure. I can't give you any other advice without seeing the code you've modified and/or what you're trying to do to compile the code. Please open an issue in that project's github project with more information.
I actually managed to get it running. It was a very basic mistake, as you have probably figured. I used the wrong version of Cython. Thank you for your time!
this looks amazing
Best example (ref) to your own codex-system
Useful tool :)