Skip to content

dungeon-revealer/game-system-notes

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

dungeon-revealer Game System Notes

A repository of notes ready to import into dungeon-revealer. The main purpose of this repository is to host system reference documents of role playing games.

Contributing

Pull requests are welcome! We will only accept content released under permissive licenses such as OGL, CC, etc.

  1. Clone this repository: git clone https://github.com/dungeon-revealer/game-system-notes.git
  2. Add your document files in an appropriate folder. For example: notes/game/document/.
  • Make sure the files you add have appropriate headers for dungeon-revealer.
  • You must also include the license of your document.
  • Do not add zip files. We have a workflow that generates the zip files.
  1. Add metadata for your document in documents.yml using the following template:
  game:
    document:
      name: Document Title
      path: path/to/folder
      zip: game-document.zip
  1. Add your document and links to the README. For example:
- [Dungeons and Dragons](notes/Dungeons%20and%20Dragons)
  - [5e SRD][dnd-5e-srd]

[dnd-5e-srd]: https://github.com/dungeon-revealer/game-system-notes/releases/download/v0.2.0/dnd-5e-srd.zip
  1. Submit a pull request.

TODO

  • Lint documents in PRs.
  • Automatically generate the link tree in the README.
  • Add more SRDs.