Skip to content

System Reference Document (SRD) 5 game rules cheatsheet (wip)

Notifications You must be signed in to change notification settings

bburns/dnd-rules

Repository files navigation

System Reference Document (SRD) 5 Rules

This is an unofficial summary of the SRD5 rules, starting with the most basic and moving to more complex rules.

https://dnd.pub

Goals

  • Make a compact and printable summary of the rules
  • Organize rules into basic, intermediate, and complex to aid in learning

Contribute

To update the rules, you can edit the rules directly. I'd like to keep the rules compact so they can be printed easily. See below for an explanation of the format.

To file an issue, see the Issues page.

Or send an email to [email protected].

Rule Format

The rules are located in rules/rules.nm - the rule name is offset by dashes, the rule contents are Markdown, with Wiki-like internal links to other rules, and properties marked with a hat (^), e.g.

    ---------------------------------------------------------------------------
    # Ability Score #
    ---------------------------------------------------------------------------

    Measures of different abilities: 

    * Strength
    * Dexterity
    * Constitution
    * Intelligence
    * Wisdom
    * Charisma

    Max 20 for characters, 30 for monsters/divines. 

    (*Intermediate*: Used to calculate [[Ability Modifier|Ability Modifiers]]. Each has associated [[Skill|Skills]], e.g. Strength has Athletics.)

    ^type: rule
    ^ref: ph12,173
    ^phase: character
    ^complexity: basic

About

The site itself is made with React, with Colcade to fit the rules into tiles, and Remark to convert Markdown to HTML.

The rules are converted to JSON with nm2json.js, which is then bundled into the final site. "nm" is for Neomem, which is another project I'm working on.

Setup

Clone the repository with git -

git clone https://github.com/bburns/dnd-rules.git

then grab the dependencies

cd dnd-rules
yarn

Develop

Run the app in the development mode -

yarn start

It will open http://localhost:3000 in the browser - the page will reload as you make edits, including to the rules file.

Print

Print the site to a pdf using Microsoft Edge and add it to the public/pdf folder, then update the link in src/components/app/index.jsx.

I've tried printing the site with Firefox, Chrome, and Microsoft Edge, all on Windows - Edge is the only one that works well - Firefox only prints one page, and Chrome doesn't do the page breaks.

So until I'm able to fix those issues (if ever?) I'll print the site to a pdf after changes made to the rules, using Edge.

Deploy

Deploy the site to the Firebase Hosting page, https://dnd-pub.web.app/ -

yarn deploy

License

This site is GPL. The rule contents are OGL (Open Game License) - see here.

About

System Reference Document (SRD) 5 game rules cheatsheet (wip)

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published