summaryrefslogtreecommitdiffhomepage
path: root/tech/code/org-d20.mdwn
blob: 92535e634e9063db813cfaf7b6b834c5cfc0a104 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
[![MELPA](https://melpa.org/packages/org-d20-badge.svg)](https://melpa.org/#/org-d20) [![MELPA Stable](https://stable.melpa.org/packages/org-d20-badge.svg)](https://stable.melpa.org/#/org-d20)

## Description ##

org-d20 is a minor mode for Emacs' [Org-mode](https://orgmode.org/)
for GMs running games whose rules centre around rolling d20s.  It
should be useful for *Dungeons and Dragons* 3rd, 4th and 5th editions,
Paizo's *Pathfinder*, and
[d20 System](https://en.wikipedia.org/wiki/D20_System) games like *d20
Modern*.

The idea is that you're already keeping your campaign notes in an
Org-mode file.  This minor mode does useful things for you while you
are visiting that buffer.  For example,

- rolling dice, with 5e's advantage and disadvantage displayed in case
  those are needed;

- tracking combat turns and rounds right next to your existing
  description of the monsters and the terrain.
  
The minor mode's defaults suit the way that I run D&D 5e.  Patches to
add `defcustoms` to make org-d20 more suitable for other games, and
other sets of house rules, are welcome.

## Screenshot ##

[[!img img/org-d20-0.3pre.png]]

## Installation ##

Manually, from git.

# Usage

Please see the included README.md.

# Source code

* Anonymous checkout with git:

        $ git clone https://git.spwhitton.name/org-d20

* [Browse source online](https://git.spwhitton.name/org-d20/)
* [GitHub mirror](https://github.com/spwhitton/org-d20)

# Bugs

Please report bugs and submit patches/pull requests [[by e-mail|contact]].