{"id":13714548,"url":"https://github.com/cachance7/fuzzy5e","last_synced_at":"2025-05-07T03:30:48.228Z","repository":{"id":147200961,"uuid":"257975092","full_name":"cachance7/fuzzy5e","owner":"cachance7","description":"🐉 A 5th edition SRD5 reference for your terminal","archived":false,"fork":false,"pushed_at":"2020-05-12T22:36:15.000Z","size":2971,"stargazers_count":30,"open_issues_count":4,"forks_count":2,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-11-14T03:34:07.137Z","etag":null,"topics":["cli","dnd5e","rust","terminal"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cachance7.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-04-22T17:40:11.000Z","updated_at":"2024-11-12T20:25:55.000Z","dependencies_parsed_at":null,"dependency_job_id":"27b66118-1ad8-4f56-b3f4-e1e22bf3f68b","html_url":"https://github.com/cachance7/fuzzy5e","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cachance7%2Ffuzzy5e","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cachance7%2Ffuzzy5e/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cachance7%2Ffuzzy5e/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cachance7%2Ffuzzy5e/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cachance7","download_url":"https://codeload.github.com/cachance7/fuzzy5e/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252806358,"owners_count":21807193,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","dnd5e","rust","terminal"],"created_at":"2024-08-03T00:00:27.976Z","updated_at":"2025-05-07T03:30:48.209Z","avatar_url":"https://github.com/cachance7.png","language":"Rust","funding_links":[],"categories":["Applications"],"sub_categories":["Command Line"],"readme":"[![Contributors][contributors-shield]][contributors-url]\n[![Issues][issues-shield]][issues-url]\n\n\n\n\u003cbr /\u003e\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/cachance7/fuzzy5e\"\u003e\n    \u003cimg src=\"logo.png\" alt=\"Logo\" width=\"160\"\u003e\n  \u003c/a\u003e\n\n  \u003ch3 align=\"center\"\u003eFuzzy5e\u003c/h3\u003e\n\n  \u003cp align=\"center\"\u003e\n    A 5th edition SRD5 reference for your terminal.\n  \u003c/p\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n\u003cimg src=\"fuzzy5e.gif\" height=\"400\" width=\"600\"/\u003e\n\u003c/p\u003e\n\n\n\u003c!-- TABLE OF CONTENTS --\u003e\n## Table of Contents\n\n* [About the Project](#about-the-project)\n  * [Built With](#built-with)\n* [Getting Started](#getting-started)\n  * [Prerequisites](#prerequisites)\n  * [Installation](#installation)\n  * [Usage](#usage)\n* [Contributing](#contributing)\n* [License](#license)\n* [Contact](#contact)\n* [Acknowledgements](#acknowledgements)\n\n\n\n\u003c!-- ABOUT THE PROJECT --\u003e\n## About The Project\n\nAs 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.\n\nNOTE: This is very much a **_work in progress_**.\n\n\u003cimg width=\"1440\" alt=\"Screen Shot 2020-05-05 at 11 29 01 AM\" src=\"https://user-images.githubusercontent.com/1068829/81101928-aec2f280-8ec3-11ea-8138-387630ecd843.png\"\u003e\n\n_Tiling in tmux turns out to be exactly what I wanted._\n\n\n\n### Built With\n\n* [Rust](https://www.rust-lang.org/) - this app is written in rust\n* [tuikit](https://github.com/lotabout/tuikit) - leaned on this heavily for the terminal UI presentation\n* [5e-database](https://github.com/bagelbits/5e-database) - SRD5 data is sourced from here\n\n\n\u003c!-- GETTING STARTED --\u003e\n## Getting Started\n\nfuzzy5e is a terminal UI written in Rust. It has been tested on Mac OSX Catalina and Linux. YMMV on Windows.\n\n### Prerequisites\n\n[Rust \u003e=1.40](https://www.rust-lang.org/tools/install) (if building from source)\n\n### Installation (from release)\n\n1. Download [latest binary and index](https://github.com/cachance7/fuzzy5e/releases/latest)\n2. Extract locally\n3. Run the executable and point to index\n\n```sh\nfuzzy5e -i path/to/indexdir\n```\n\n### Installation (from git repo)\n\n1. Clone the repo\n```sh\ngit clone https://github.com/cachance7/fuzzy5e\n```\n2. Build and run the executable\n```sh\ncd fuzzy5e \u0026\u0026 cargo run\n```\n3. Enjoy!\n\n\n### Usage\n\n- Start the program with `fuzzy5e` helper script\n- Type to begin searching\n- `Ctrl+N` / `Ctrl+P`: select next / previous match\n- `Up` / `Down` / `PgUp` / `PgDown`: scroll the selected content up or down\n- `Enter`: show the selected match full window\n- `Esc`: quit\n\n\u003c!-- CONTRIBUTING --\u003e\n## Contributing\n\nIf you'd like to contribute, feel free to open up a PR and let's make it work!\n\n\n\n\u003c!-- LICENSE --\u003e\n## License\n\nDistributed under the MIT License. See `LICENSE` for more information.\n\nAll searchable content is derived from SRD5 and is used courtesy of the [OGL-1.0a](https://github.com/cachance7/fuzzy5e/blob/master/OGL-1.0a.txt)\n\n\n\u003c!-- CONTACT --\u003e\n## Contact\n\n[Casey Chance](mailto:casey@chance.email?subject=fuzzy5e)\n\nProject Link: [https://github.com/cachance7/fuzzy5e](https://github.com/cachance7/fuzzy5e)\n\n\n## Acknowledgements\n* [dnd5api](http://dnd5eapi.co/)\n* [Gary Gygax](https://en.wikipedia.org/wiki/Gary_Gygax)\n* Logo built using icons made by Flat Icons from www.flaticon.com\n\n\n\u003c!-- MARKDOWN LINKS \u0026 IMAGES --\u003e\n\u003c!-- https://www.markdownguide.org/basic-syntax/#reference-style-links --\u003e\n[contributors-shield]: https://img.shields.io/github/contributors/cachance7/fuzzy5e.svg?style=flat-square\n[contributors-url]: https://github.com/cachance7/fuzzy5e/graphs/contributors\n[forks-shield]: https://img.shields.io/github/forks/cachance7/fuzzy5e.svg?style=flat-square\n[forks-url]: https://github.com/cachance7/fuzzy5e/network/members\n[stars-shield]: https://img.shields.io/github/stars/cachance7/fuzzy5e.svg?style=flat-square\n[stars-url]: https://github.com/cachance7/fuzzy5e/stargazers\n[issues-shield]: https://img.shields.io/github/issues/cachance7/fuzzy5e.svg?style=flat-square\n[issues-url]: https://github.com/cachance7/fuzzy5e/issues\n[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=flat-square\u0026logo=linkedin\u0026colorB=555\n[linkedin-url]: https://linkedin.com/in/casey-chance-9ba0b6a\n[product-screenshot]: images/screenshot.png\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcachance7%2Ffuzzy5e","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcachance7%2Ffuzzy5e","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcachance7%2Ffuzzy5e/lists"}