A 5th edition SRD5 reference for your terminal.
As a DM I find myself constantly looking up spells and monster stat blocks while running the game. As a programmer, the terminal is my most concise at-a-glance space for text information. After years of struggling to juggle browser windows and tabs, I decided to build this as a sort of quick reference and HUD for my most commonly referenced information.
NOTE: This is very much a work in progress.
Tiling in tmux turns out to be exactly what I wanted.
- Rust - this app is written in rust
- tuikit - leaned on this heavily for the terminal UI presentation
- 5e-database - SRD5 data is sourced from here
fuzzy5e is a terminal UI written in Rust. It has been tested on Mac OSX Catalina and Linux. YMMV on Windows.
Rust >=1.40 (if building from source)
- Download latest binary and index
- Extract locally
- Run the executable and point to index
fuzzy5e -i path/to/indexdir- Clone the repo
git clone https://github.com/cachance7/fuzzy5e- Build and run the executable
cd fuzzy5e && cargo run- Enjoy!
- Start the program with
fuzzy5ehelper script - Type to begin searching
Ctrl+N/Ctrl+P: select next / previous matchUp/Down/PgUp/PgDown: scroll the selected content up or downEnter: show the selected match full windowEsc: quit
If you'd like to contribute, feel free to open up a PR and let's make it work!
Distributed under the MIT License. See LICENSE for more information.
All searchable content is derived from SRD5 and is used courtesy of the OGL-1.0a
Project Link: https://github.com/cachance7/fuzzy5e
- dnd5api
- Gary Gygax
- Logo built using icons made by Flat Icons from www.flaticon.com