Skip to content

Commit

Permalink
Adding creature_list and creature_text to README & NEWS
Browse files Browse the repository at this point in the history
  • Loading branch information
njlyon0 committed Apr 17, 2024
1 parent 6e74bef commit 4a5a163
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 0 deletions.
2 changes: 2 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

Development version of `dndR`. The following changes were made from the preceding version:

- New function: `creature_list` -- identifies Dungeons & Dragons creatures based on user specifications of various criteria (e.g., creature type, experience point value, size, etc.)
- New function: `creature_text` -- retrieves full description text of creature(s) specified by user
- Adding support for re-rolling of 1s in `roll` result
- Streamlined internal mechanics of `roll` such that dice with any number (integer) of faces can be rolled (e.g., "2d57", "d13", etc.)
- Adding 5 spells to `spell_list` and `spell_text` (Antagonize, Gate Seal, Spirit of Death, Spray of Cards, and Warp Sense)
Expand Down
4 changes: 4 additions & 0 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,10 @@ devtools::install_github("njlyon0/dndR")

- **`spell_text`** -- Retrieve full information and description text for specified spell(s)

- **`creature_list`** -- Identify all creatures that fit certain criteria (e.g., experience point value, creature type, size, etc.)

- **`creature_text`** -- Retrieve full information and ability/action information text for specified creature(s)

- **`probability_plot`** -- Generate a `ggplot2` plot of the frequency of roll outcomes for the specified type and number of dice. You can also specify the number of times to roll those dice to inform the plot

- **`pc_level_calc`** -- Identify the current level of a player character based on earned experience points (XP). Also returns the proficiency modifier to be used at that level
Expand Down
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,12 @@ devtools::install_github("njlyon0/dndR")
- **`spell_text`** – Retrieve full information and description text for
specified spell(s)

- **`creature_list`** – Identify all creatures that fit certain criteria
(e.g., experience point value, creature type, size, etc.)

- **`creature_text`** – Retrieve full information and ability/action
information text for specified creature(s)

- **`probability_plot`** – Generate a `ggplot2` plot of the frequency of
roll outcomes for the specified type and number of dice. You can also
specify the number of times to roll those dice to inform the plot
Expand Down

0 comments on commit 4a5a163

Please sign in to comment.