/fuzzy5e

🐉 A 5th edition SRD5 reference for your terminal

Primary LanguageRustMIT LicenseMIT

Contributors Issues


Logo

Fuzzy5e

A 5th edition SRD5 reference for your terminal.

Table of Contents

About The Project

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.

Screen Shot 2020-05-05 at 11 29 01 AM

Tiling in tmux turns out to be exactly what I wanted.

Built With

  • 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

Getting Started

fuzzy5e is a terminal UI written in Rust. It has been tested on Mac OSX Catalina and Linux. YMMV on Windows.

Prerequisites

Rust >=1.40 (if building from source)

Installation (from release)

  1. Download latest binary and index
  2. Extract locally
  3. Run the executable and point to index
fuzzy5e -i path/to/indexdir

Installation (from git repo)

  1. Clone the repo
git clone https://github.com/cachance7/fuzzy5e
  1. Build and run the executable
cd fuzzy5e && cargo run
  1. Enjoy!

Usage

  • Start the program with fuzzy5e helper script
  • Type to begin searching
  • Ctrl+N / Ctrl+P: select next / previous match
  • Up / Down / PgUp / PgDown: scroll the selected content up or down
  • Enter: show the selected match full window
  • Esc: quit

Contributing

If you'd like to contribute, feel free to open up a PR and let's make it work!

License

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

Contact

Casey Chance

Project Link: https://github.com/cachance7/fuzzy5e

Acknowledgements