diff --git a/README.md b/README.md index 2e072686..e779206e 100644 --- a/README.md +++ b/README.md @@ -2,49 +2,58 @@ A compact, printable and browser-friendly quick reference sheet for Dungeons & Dragons 5th Edition — supporting both 2014 rules and a 2024 rules update. This project is a personalized fork that builds on top of earlier community work to provide a useful, easy-to-edit reference for players and GMs. -Live demos +## Live view + - [mfriik.github.io/dnd5e-quickref/](https://mfriik.github.io/dnd5e-quickref/) - [dnd.milobedzki.pl](https://dnd.milobedzki.pl/) -What this is +## What this is + - A single-page quick reference for common D&D 5e rules, actions, combat steps, conditions, and other frequently used information. - Lightweight, static HTML/CSS/JS — easy to host (GitHub Pages or any static host). - Customizable: the sheet content is stored in simple JavaScript data files so you can add or change entries without modifying markup. -Quick features +## Quick features + - Compact layout optimized for quick scanning at the table. Now with Collapsible sections - Toggles to enable homebrew rules and optional rules. - Dark mode enabled. - Easy Switch between 2024 and 2014 Rulesets -Editing the sheet +## Editing the sheet + - The content lives in the `js` folder. Edit the `data` files there to: - Add or change actions - Add custom notes or house rules - Add new sections - No build step required — changes in the `js` files are reflected immediately in the page. -Repository layout (high level) +## Repository layout (high level) + - index.html — main page - css/ — stylesheets - js/ — JavaScript and data files (edit these to customize) - img/ — icons and images -Contributing -- Found a layout issue or have an improvement idea? Please open an issue: https://github.com/mfriik/dnd5e-quickref/issues +## Contributing + +- Found a layout issue or have an improvement idea? Please open an issue: - Want to contribute a fix or enhancement? Fork the repo, make changes, and submit a pull request. When editing content, prefer small, focused commits and describe the change clearly in the PR. - If you want a minor personal tweak (e.g., add actions for a character), edit the `js/data` files in your fork or locally — that’s the fastest route. -Credits and acknowledgements -- Original project: https://github.com/crobi/dnd5e-quickref -- 2024 rules update source used: https://github.com/nico-713/dnd5e-quickref-2024 -- Icons: http://game-icons.net/ -- Favicon: https://iconduck.com/icons/21871/dragon +## Credits and acknowledgements + +- Original project: +- 2024 rules update source used: +- Icons: +- Favicon: + +## License -License - Check the repository LICENSE file for license terms. If there is no LICENSE file, assume upstream license applies or contact the maintainer for clarification. -Contact -- Issues: https://github.com/mfriik/dnd5e-quickref/issues +## Contact + +- Issues: -Thanks for using and improving this quick reference — may your rolls be high! +Thanks for using and improving this quick reference — May the dice be forever in your favour!