Skip to content

Commit

Permalink
Update CHANGELOG and README
Browse files Browse the repository at this point in the history
  • Loading branch information
Kumodatsu committed Jun 1, 2022
1 parent ac257c4 commit 87d7003
Show file tree
Hide file tree
Showing 2 changed files with 51 additions and 36 deletions.
15 changes: 12 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,21 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to
[Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## Unreleased
## [0.6.0][] - 2022-06-01
### Changed
- Updated for World of Warcraft 9.2.5.
- All of the addon's functionality is now accessible through the UI. All the
slash commands still work and exist, but they are no longer essential.

### Added
- Minimap button. This can be used to toggle the UI frames as well as the
settings menu.
- Minimap button. This can be used to access the settings menu, to toggle the UI
frames and pet UI, and to access the resource menu.
- Resource menu. It's used to customize or disable your resource bar.
- Command `/cs toggle resource` that toggles the resource menu.

### Fixed
- Fixed a bug where the stats frame was sometimes too short to contain the pet
UI.

## [0.5.11][] - 2022-04-02
### Removed
Expand Down Expand Up @@ -321,6 +329,7 @@ when attempting to set a stat to something nonsensical such as
commands.
- (Code) Table utilities. Includes functions to operate on tables.

[0.6.0]: <https://github.com/Kumodatsu/CharacterSheet/releases/tag/v0.6.0>
[0.5.11]: <https://github.com/Kumodatsu/CharacterSheet/releases/tag/v0.5.11>
[0.5.10]: <https://github.com/Kumodatsu/CharacterSheet/releases/tag/v0.5.10>
[0.5.9]: <https://github.com/Kumodatsu/CharacterSheet/releases/tag/v0.5.9>
Expand Down
72 changes: 39 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,47 +34,53 @@ To make a backup of your data, copy this file somewhere safe. To restore the
data, copy the backup file back to the aforementioned location.

## Usage (latest version)
At the moment, most of the functionality of the addon can be used through the
UI. All of the functionality can be accessed through slash commands. All
commands provided by the addon start with `/cs`. Use the command `/cs help` to
view a listing of all available commands, and `/cs help <command>` to see an
explanation of the given command. The most important use cases of the addon are
described below. See the [wiki][2] for more detailed information.
All of the functionality can be used either through the UI or slash commands.
All commands provided by the addon start with `/cs`.
Use the command `/cs help` to view a listing of all available commands, and
`/cs help <command>` to see an explanation of the given command.
The most important use cases of the addon are described below.

### Editing your stat block
Use the edit frame to edit your stat block. The frame can be toggled on and off
with the command `/cs toggle edit`. Use the arrow buttons to add or remove
points from a stat. Click the power level in the top of the frame to change your
power level. At the bottom of the frame, the number of skill points you have
left are displayed, as well as values that are derived from your stats (HP and
heal modifier). It is impossible to create invalid stat blocks.
Use the edit frame to edit your stat block.
The frame can be toggled on and off through the minimap menu, or with the
command `/cs toggle edit`.
Use the arrow buttons to add or remove points from a stat.
Click the power level in the top of the frame to change your power level.
At the bottom of the frame, the number of skill points you have left are
displayed, as well as values that are derived from your stats (HP and heal
modifier).
It is impossible to create invalid stat blocks.

### Using your stats
Click a stat in your stat frame to roll with that stat's modifier. The stat
frame can be toggled on and off with the command `/cs toggle stats`. You can
also use `/cs roll <stat>` to roll with the given stat modifier. For example,
use `/cs roll str` to roll for Strength (1d20 + STR).
Use the stat frame to perform rolls and modify you and your pet's health.
The stat frame can be toggled on and off through the minimap menu, or with the
command `/cs toggle stats`.
Click a stat in your stat frame to roll with that stat's modifier.
You can also use `/cs roll <stat>` to roll with the given stat modifier.
For example, use `/cs roll str` to roll for Strength (1d20 + STR).

Use `/cs heal` to roll for healing in combat (1d10 + heal mod) and
`/cs heal safe` to roll for healing out of combat (1d14 + heal mod). The heal
button will perform a heal roll. The combat icon next to the heal button
determines whether the heal roll is an in combat or out of combat heal roll.
Click the icon to switch between the two. The minus and plus buttons next to the
HP bar can be used to set your HP.
The heal button will perform a heal roll.
Click the combat icon next to the button to switch between out of combat
("safe") and in combat heals.
The minus and plus buttons next to the HP bar can be used to set your HP.

Use `/cs addresource <name> <min> <max> <bar color> <text color>` to add an
extra resource bar to your stats frame. For example, use
`/cs addresource Sanity 0 10 purple white`
to add a purple Sanity bar that ranges from the values 0 through 10. Use
`/cs removeresource` to remove it again.
You can add a custom resource, such as Sanity or anything else, to your stats
frame.
Click the "Manage resource" option in the minimap menu, or use the command
`/cs toggle resource`.
Enter a name, minimum and maximum value, and colors for the display bar.
The resource bar will then appear in your stats frame under your health bar.
Click the "Disable resource" button to remove the resource.

### Using pets
At the moment, adding and removing pets can not yet be done with the UI. Use
`/cs pet` to toggle the pet health bar and attack button on/off in the stat
frame. Click the pet attack button to perform a pet attack roll. The total
damage value of the attack is displayed in the chat. Use `/cs setpetatk <stat>`
to set the stat used to calculate pet attack damage to something other than
Charisma. You should only do this with permission of the game master!
You can toggle a pet using the minimap menu.
This will add the pet UI to your stats frame.
Click the pet attack button to perform a pet attack roll.
The total damage value of the attack is displayed in the chat.

Use `/cs setpetatk <stat>` to set the stat used to calculate pet attack damage
to something other than Charisma.
You should only do this with permission of the game master!

### TRP3 interoperation
You can optionally give the addon permission to interact with TRP3 if you have
Expand Down

0 comments on commit 87d7003

Please sign in to comment.