From c830eb165b0f2989103ce74ca093ae5bffd6d8d2 Mon Sep 17 00:00:00 2001 From: evilchili Date: Fri, 29 Dec 2023 22:15:16 -0800 Subject: [PATCH] updating docs --- README.md | 48 ++++++++++++++---------------------------------- 1 file changed, 14 insertions(+), 34 deletions(-) diff --git a/README.md b/README.md index 9da7794..1888f32 100644 --- a/README.md +++ b/README.md @@ -2,48 +2,28 @@ **WIP!** -This package includes a library and CLI for generating randomized weapons, items, and loot for -Dungeons & Dragons, 5th edition. +This package includes a library and CLI for generating randomized weapons, items, and loot for Dungeons & Dragons, 5th edition. ## Usage The `dnd-item` command-line utility supports several comments: -* **item**: Generate a random item (the default) -* **weapon**: Generate a basic, non-magical weapon -* **magical-weapon**: Generate a weapon with an added magical damage type +* **weapon**: Generate weapons +* **roll-table**: Generate roll tables of random items ### Examples: ```shell % dnd-item weapon -Pike - * type.category: martial - * type.damage: Piercing - * type.die: 1d10 - * type.properties: heavy, reach, two-handed - * type.range: None - * type.reload: - * type.type: Martial - * type.value: 500 - * type.weight: 18 +**Freezing +3 Longbow Of Mighty Strikes** + * very rare martial weapon (ammunition, enchanted, heavy, magical, two-handed) + * +3 to hit, 150/600 ft., 1 tgts. 1d8+3 Piercing + 1d8 cold + +**Ammunition.** You can use a weapon that has the ammunition property to make a ranged attack only if you have ammunition to fire from the weapon. Each time you attack with the weapon, you expend one piece of ammunition. +Drawing the ammunition from a quiver, case, or other container is part of the attack (you need a free hand to load a one-handed weapon). +**Enchanted.** Attacks made with this magical weapon do an extra 1d8 cold damage. +**Heavy.** Small creatures have disadvantage on attack rolls with heavy weapons. A heavy weapon’s size and bulk make it too large for a Small creature to use effectively. +**Magical.** This magical weapon grants +3 to attack and damage rolls. +**Two-Handed.** This weapon requires two hands when you attack with it. + ``` - -```shell -% dnd-item magic-weapon -Shortsword Of Thunder - * magic.adjective: booming - * magic.die: 1d4 - * magic.noun: thunder - * type.category: martial - * type.damage: Piercing - * type.die: 1d6 - * type.properties: finesse, light - * type.range: None - * type.reload: - * type.type: Martial - * type.value: 1000 - * type.weight: 2 -``` - -