aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorSean Whitton <spwhitton@spwhitton.name>2019-01-05 13:03:46 +0000
committerSean Whitton <spwhitton@spwhitton.name>2019-01-05 13:09:36 +0000
commit96f73b110e59ec74e066770df6b37ebaac23123c (patch)
tree708d6f4f35b11c15febda2c80ba405c493f75701 /README.md
parentfc02fbf4442869d63bd9c1d170db31e009d5122f (diff)
downloadorg-d20-96f73b110e59ec74e066770df6b37ebaac23123c.tar.gz
improve README
Signed-off-by: Sean Whitton <spwhitton@spwhitton.name>
Diffstat (limited to 'README.md')
-rw-r--r--README.md28
1 files changed, 25 insertions, 3 deletions
diff --git a/README.md b/README.md
index 0f7791a..e733646 100644
--- a/README.md
+++ b/README.md
@@ -20,8 +20,13 @@ are visiting that buffer. For example,
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.
+add `defcustoms` to make org-d20 more suitable for other games, and
+other sets of house rules, are welcome.
+
+## Installation ##
+
+Presently manual. I hope to make org-d20 available from a popular
+online repository soon.
## Usage ##
@@ -33,7 +38,8 @@ 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)
+ # mode: org
+ # mode: org-d20
# org-d20-party: (("Zahrat" . 2) ("Ennon" . 4) ("Artemis" . 5))
# End:
@@ -41,6 +47,22 @@ or start it with a first line like this:
# -*- mode: org; mode: org-d20; org-d20-party: (("Zahrat" . 0) ("Anca" . 1)) -*-
+Then close and reopen the file. Emacs will probably ask you to
+confirm that the value for org-d20-party that you've supplied is safe.
+
+The following bindings should then be available:
+
+- <kbd><f9></kbd> -- start a combat, or advance the turn/round counter
+ for an existing combat, depending on point
+- <kbd>S-<f9></kbd> -- add new monsters to an existing combat
+- <kbd><f10></kbd> -- apply damage to the monster at point
+- <kbd>S-<f10></kbd> -- evaluate the dice expression (e.g. `4d10`) at
+ point
+- <kbd><f11></kbd> -- prompt for dice expression and evaluate it
+- <kbd>S-<f11></kbd> -- roll the last dice expression again
+- <kbd><f12></kbd> -- roll d20, with advantage and disadvantage shown
+- <kbd>S-<f12></kbd> -- roll percentile dice
+
## Bugs/patches ##
Please report bugs and submit patches by e-mail to