# About
---
Masquerade is a discord dice bot for the World of Darkness/Chronicles of Darkness systems. Both V5 and previous editions are currently supported, with plans for MET/BNS in the future.

Development is by StoneWolf18.

* [Invite link](https://discord.com/oauth2/authorize?client_id=478245356598198304&permissions=83968&scope=bot)
* Stone can be reached directly in the [discord server](https://discord.gg/HYM8jHa). Please let her know if you are having problems, or if Mask is down!
* Want to help keep Masquerade online? Consider donating [here](https://www.patreon.com/StoneWolf18)!

# Commands 

---
Below are the commands currently supported.
* `m.` is Masquerade's default prefix
* Commands are not case sensitive
* Parameters **must** be assigned in the correct order
* Optional parameters aren't required for the command to work

## Help
Gives an abridged version of the information on this page. Help with individual commands can be viewed with `m.help COMMAND`, and help with server-specific settings can be viewed with `m.settings SETTING`.

## Roll
* **Default Command:** `m.roll`
* **Alternate Name:** `m.r`
* **Parameters:** Pool, Difficulty, Comment (OPTIONAL)

Roll (`m.roll`) is for rolling with an old World of Darkness ruleset, such as revised or 20th anniversary.

__Pool__ is the amount of dice you're rolling.  
__Difficulty__ is the difficulty of the roll.  
__Comment__ is to add text and conditions to the roll.  

For example: `m.roll 5 6` would roll a pool of 5 dice against a difficulty of 6 without a text comment.

### Conditions
Conditions are words you can include in your comment to change how your roll is calculated.

The following conditions are currently supported. None of them are case sensitive:

* **Spec OR Specialty:** Roll with your current specialty rules applied.
  * __Example:__ `m.roll 5 6 spec` | `m.roll 5 6 specialty`
* **Wp OR Willpower:** Roll with willpower for an automatic success.
  * __Example:__ `m.roll 5 6 wp` | `m.roll 5 6 willpower`
* **Auto AMOUNT:** Add AMOUNT number of automatic successes to your roll.
  * __Example:__ `m.roll 5 6 auto 3`
* **Double:** Double the number of successes rolled.
  * __Example:__ `m.roll 5 6 double`
* **Ignore:** Ignore botches if one is rolled.
  * __Example:__ `m.roll 5 6 ignore`
* **Ovr OR Override:** Override the rule that subtracts 1s from successes rolled.
  * __Example:__ `m.roll 5 6 ovr`
  
#### Combining Conditions
Conditions can be combined should it be necessary for the roll.

***Example - Rolling with potence 2 and a boxing specialty:***  
`m.roll 5 6 spec boxing auto 2`

***Example - Rolling attack damage with potence 2:***  
`m.roll 3 6 punch auto 2 ignore`

## Roll5e
* **Default Command:** `m.roll5e`
* **Alternate Name:** `m.r5`
* **Parameters:** Pool, Hunger, Difficulty, Comment (OPTIONAL)

Roll (`m.roll5e`) is for rolling with a set of V5 dice instead of normal d10s. Because of this, your output will consist of the associated symbols rolled.

__Pool__ is the total amount of dice you're rolling.  
__Hunger__ is your current hunger level.  
__Difficulty__ is the difficulty of the roll. (Use 0 if unknown)   
__Comment__ is to add text to the roll.

For example: `m.roll5e 6 2 3 Shadowing` would roll a pool of 6 dice, with a hunger level of 2, against a difficulty of 3 with the comment 'shadowing'.

 An example output for that roll would be:  
 ![roll](https://i.imgur.com/pcYU9qL.png)

## Init
* **Default Command:** `m.init`
* **Alternate Name:** `m.i`
* **Parameters:** Rating, Comment (OPTIONAL)

Init (`m.init`) rolls initiative for old World of Darkness systems: a d10 + the value given.

__Rating__ is your initiative rating. This is normally Dexterity + Wits, though other traits could be added depending upon the specific game.

***Example - Rolling initiative with an initiative rating of 5:***  
`m.init 5`

## customRoll
* **Default Command:** `m.customRoll`
* **Alternate Name:** `m.cr`
* **Parameters:** Amount, Faces, Comment (OPTIONAL)

customRoll (`m.customRoll`) allows for the rolling of dice that aren't d10s against a given difficulty. Because this isn't the main purpose of Masquerade, it's rather basic, meaning arithmetic and rolling multiple sizes of dice at once are not supported.

__Amount__ is how many dice you want to roll.  
__Faces__ are how many faces/sides the dice have.

***Example - Rolling 5d6:***  
`m.customRoll 5 6`

***Example - Rolling 1d20:***  
`m.cr 1 20`

## Repeat
* **Default Command:** `m.repeat`
* **Alternate Name:** `m.re`
* **Parameters:** Times, Roll

Repeat (`m.repeat`) allows iterative rolling, that is: making the same roll more than once in a single command. This command is **not** available for V5 rolls (`m.roll5e`) because of how the results are outputted.

__Times__ is how many times you want to make the roll.  
__Roll__ is the actual roll you're making **without** the prefix. (`m.`)

***Example - Rolling a pool of 6 dice with a difficulty of 7 four times:***  
`m.repeat 4 roll 6 7`

***Example - Rolling a pool of 5 dice with a difficulty of 4 with specialty twice:***  
`m.re 2 roll 5 4 spec`

***Example - Rolling 4d8 three times:***  
`m.repeat 3 customRoll 4 8`

### Group Initiative
Group initiatives are rolled differently, as each character will have a different name and rating. You **must** provide name and rating pairings equal to NUMBER for this command to function. The names and ratings must also follow that order, with nothing separating them.

**Command:** `m.repeat NUMBER init NAME RATING NAME RATING`

__Number__ is how many are in the group you are rolling for.  
__Name__ is the name of a character.  
__Rating__ is the character's initiative rating.  

You are unable to add text comments to group initiatives because of how they are processed.

***Example - rolling for a group of three characters, the first with a rating of 3, the second with a rating of 5, and the third with a rating of 4:***  
`m.repeat 3 init Brujah 3 Toreador 5 Ventrue 4`

## Macros
Macros is a way to store commonly used rolls so they can be used with a single word or short phrase.

Note that **all** of the commands listed below are subcommands of macro (`m.macro`). This means all of them will require `m.macro` or `m.m` before them to function.

Like ever other command, macro names are **not** case sensitive. You won't be able to have a macro named 'Punch' and 'punch'.

The current roll types supported for macros are: roll, roll5e, customRoll, and repeat.

There are currently no limits imposed on macro amounts per user, and there aren't any plans to make any at this time.

### Create
* **Default Command:** `m.macro create`
* **Alternate Name:** `m.m create`
* **Parameters:** Name, Roll

A macro is created using the create (`m.macro create`) subcommand. All macros created are stored per user globally. This means any macros you make on one server will be able to be used on another, provided they also have Masquerade.

__Name__ is what you're naming the macro in order to use it. For names that are longer than a single word, surround it in "quotation marks".  
__Roll__ is the roll you want to assign to the macro. The roll should be written **exactly** as you would if you were using the separate command, but **without** the prefix. (`m.`)

***Example - A macro named 'Stealth', rolling a pool of 4 dice vs a difficulty of 6:***  
`m.macro create Stealth roll 4 6`

***Example - A macro named 'Paint Artwork', rolling  a pool of 8 dice vs a difficulty of 7 with a specialty:***  
`m.macro create "Paint Artwork" roll 8 7 spec`

***Example - A macro named '3d6', rolling 3 six sided dice:***  
`m.m create 3d6 cr 3 6`

### Delete
* **Default Command:** `m.macro delete`
* **Alternate Name:** `m.m delete`
* **Parameters:** Name

A macro is deleted using `m.macro delete` subcommand. This is irreversible, so please make sure you want to delete what you're deleting!

__Name__ is the name of the macro you intend to delete.

***Example - Deleting a macro named 'Stealth'***  
`m.macro delete stealth`

### Edit
* **Default Command:** `m.macro edit`
* **Alternate Name:** `m.m edit`
* **Parameters:** Name, New

A macro can be edited with `m.macro edit`. Editing a macro allows you to change the specifics of a roll (such as the pool and difficulty), **not** the type. To change the type, it's easier to delete the macro and make a new one.

__Name__ is the name of the macro you intend to edit. Names that are multiple words must be surrounded in "quotation marks".
__New__ is the new values for the roll. This is overwriting **everything except the type**.

***Example - Changing a macro named 'Punch' to roll 6 dice at a difficulty of 6:***  
`m.macro edit Punch 6 6`

### Rename
* **Default Command:** `m.macro rename`  
* **Alternate Name:** `m.m rename`  
* **Parameters:** Old Name, New Name  

Macros are renamed with `m.macro rename`. Like when making a macro, replacement names for macros must be unique, so you'll be unable to change a macro's name to one you have that already exists.

Names that are multiple words must be surrounded in "quotation marks".

__Old Name__ is the macro's current name.  
__New Name__ is what you are wanting to change it to.  

***Example - Renaming a macro from 'Kick' to 'Lunge':***  
`m.m rename kick lunge`

### Show
* **Default Command:** `m.macro show`  
* **Alternate Name:** `m.m show`  
* **Parameters:** Name  

You can view a single macro with `m.show`. This is only for viewing your own macros, not those others have.

__Name__ is the macro you want to view.

***Example - Viewing a macro named 'dodge':***  
`m.show dodge`

### showAll
* **Default Command:** `m.macro showAll`  
* **Alternate Name:** `m.m showAll`  
* **Parameters:** Name, User (OPTIONAL)

You can view all of your current macros with `m.showAll`. If you want to view a list someone else has, simply tag them at the end of the command.

***Example - Viewing your macros:***  
`m.macro showAll`

***Example - Viewing @StoneWolf18's macros:***  
`m.m showAll @StoneWolf18`


## mroll
* **Default Command:** `m.mroll`  
* **Alternate Name:** `m.mr`  
* **Parameters:** Name

mroll (`m.roll`) is how you roll set macros. Macros **cannot** contain variables at this time, so they will be rolled exactly as they were originally assigned.

__Name__ is the name of the macro.

***Example - Using a macro named 'leg Sweep':***  
`m.mroll leg sweep`

## Mail
Mail is a pair of commands that allow you to send feedback without joining the discord server.

Note that **all** of the commands listed below are subcommands of mail (`m.mail`). This means all of them will require `m.mail` before them to function.

These are **not** anonymous, so Stone can contact you for further information if necessary.

For more direct feedback, please join the [discord server](https://discord.gg/HYM8jHa). Discussing bugs and potential features with Stone directly is the fastest way to get her to notice!

### Report
* **Default Command:** `m.mail report`  
* **Alternate Name:** None
* **Parameters:** Info

Sending reports (`m.mail report`) sends a bug report directly to the #bug-reports channel on the discord server.

__Info__ is the bug you want to report. Please be as specific as possible!

### Request
* **Default Command:** `m.mail request`  
* **Alternate Name:** None
* **Parameters:** Info

Sending a request (`m.mail request`) sends a feature request directly to the #feature-request channel on the discord server.

__Info__ is the feature you want to request. Please be as specific as possible!

Masquerade

Masquerade is a discord dice bot for the World of Darkness/Chronicles of Darkness and other White Wolf game systems.

Voting for Masquerade

Do you want to support us?