path: root/README.md
diff options
authorSean Whitton <spwhitton@spwhitton.name>2018-12-31 18:26:13 +0000
committerSean Whitton <spwhitton@spwhitton.name>2018-12-31 18:26:13 +0000
commit6bf86d9bbbed8085ffb8a73612c63a22bdd60d4f (patch)
tree4e8cbb32c0b234a887c33d8eed30d84bbac95750 /README.md
parentac3ea179149f755b5d123266775da8059c11ae75 (diff)
add a README
Signed-off-by: Sean Whitton <spwhitton@spwhitton.name>
Diffstat (limited to 'README.md')
1 files changed, 65 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..29e98ea
--- /dev/null
+++ b/README.md
@@ -0,0 +1,65 @@
+# 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
+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.
+## Usage ##
+It's useful to activate the mode automatically when you open the
+Org-mode file in which you are keeping your campaign notes. You can
+also specify the names of your party members, and their initiative
+modifiers, if you want to use org-d20's combat tracker.
+You can either end the Org-file with a footer like this:
+ # Local Variables:
+ # eval: (org-d20-mode 1)
+ # org-d20-party: (("Zahrat" . 2) ("Ennon" . 4) ("Artemis" . 5))
+ # End:
+or start it with a first line like this:
+ # -*- mode: org; mode: org-d20; org-d20-party: (("Zahrat" . 0) ("Anca" . 1)) -*-
+## Bugs/patches ##
+Please report bugs and submit patches by e-mail to
+## License ##
+Copyright (C) 2017-2018 Sean Whitton
+org-d20 is free software: you can redistribute it and/or modify it
+under the terms of the GNU General Public License as published by the
+Free Software Foundation, either version 3 of the License, or (at your
+option) any later version.
+org-d20 is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+for more details.
+You should have received a copy of the GNU General Public License
+along with org-d20. If not, see