diff options
author | Sean Whitton <spwhitton@spwhitton.name> | 2019-01-05 13:03:46 +0000 |
---|---|---|
committer | Sean Whitton <spwhitton@spwhitton.name> | 2019-01-05 13:09:36 +0000 |
commit | 96f73b110e59ec74e066770df6b37ebaac23123c (patch) | |
tree | 708d6f4f35b11c15febda2c80ba405c493f75701 | |
parent | fc02fbf4442869d63bd9c1d170db31e009d5122f (diff) | |
download | org-d20-96f73b110e59ec74e066770df6b37ebaac23123c.tar.gz |
improve README
Signed-off-by: Sean Whitton <spwhitton@spwhitton.name>
-rw-r--r-- | NEWS.md | 1 | ||||
-rw-r--r-- | README.md | 28 | ||||
-rw-r--r-- | TODO.md | 1 |
3 files changed, 26 insertions, 4 deletions
@@ -3,6 +3,7 @@ - New defcustom, `org-d20-letter-monsters` - New defcustom, `org-d20-continue-monster-numbering` +- Improve README for new users 0.2 (2018-12-31) ---------------- @@ -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 @@ -1,7 +1,6 @@ Soon ---- -- Much more detail in README.md for new users - Dice expression roller shows results for each die - [Submit to MELPA](https://github.com/melpa/melpa/blob/master/CONTRIBUTING.org#making-your-package-ready-for-inclusion) |