dnd-sourcebook-template/README.md

58 lines
No EOL
2.7 KiB
Markdown

# D&D Sourcebook Template
![](screenshot.png)
[![License: CC BY 4.0](https://img.shields.io/badge/License-CC%20BY%204.0-lightgrey.svg)](https://creativecommons.org/licenses/by/4.0/)
[![D&D 5e 2024](https://img.shields.io/badge/D%26D%205e-2024%20(5.2.1)-red.svg)](https://www.dndbeyond.com/)
[![Format](https://img.shields.io/badge/format-markdown-blue.svg)](https://commonmark.org/)
This Obsidian project with templates you copy or use the built-in system to write your creatures, spells, or whatever for creating your own [sourcebook](https://en.wikipedia.org/wiki/Sourcebook) to use in campaign setting or supplementary rulebook for later.
Included are basic character creation and gameplay guides with one species, class, and subclass as examples taken from [Markdown version](https://github.com/downfallx/dnd-5e-srd-markdown) of the SRD. (Which I also *highly* recommend you contribute to.) Although this is mostly just to give a sense of what you can do and good practice, I highly recommend keeping the guides.
## Recommendations
- Any Markdown-supported text editor
- [Obsidian](https://obsidian.md/) or VSCode
- [mdBook](https://rust-lang.github.io/mdBook/)
- [Harper](https://writewithharper.com/) spellcheck
## How To
- Add a chapter to the Summary
- See [mdBook documentation](https://rust-lang.github.io/mdBook/)
- Insert or paste the contents from `/templates`
- Write whatever you want down
- Test your book with `mdbook serve` (Optional)
### Tips
- When making a subclass, I would recommend copying the base class for reference.
- You can convert Animals to Monsters or vice versa. They follow the structure.
- If you want to make 5E's magic more fallible, I highly recommended watching [this video](https://youtu.be/eyb4FDvzLeE).
- If 4E or 3E are released under the CC-By, then you could potentially merge the two systems.
## Contributing
If you want to contribute this template, feel free to lend a hand.
### How to Contribute
1. Fork this repository
2. Create a feature branch (`git checkout -b fix/spell-formatting`)
3. Make your changes
4. Ensure Markdown is properly formatted (use a linter like `markdownlint`)
5. Submit a pull request
### Guidelines
- Maintain consistent Markdown formatting
- Use tables for stat blocks and data
- Add links between related sections where helpful
- Follow the existing heading hierarchy
## Legal Declaimer
This work contains material from the System Reference Document 5.2 by Wizards of the Coast LLC, available [here](https://www.dndbeyond.com/srd). The SRD 5.2 is licensed under [Creative Commons Attribution 4.0 International](copyright.md) License.
Dungeons & Dragons, D&D, and their respective logos are trademarks of Wizards of the Coast LLC.