marcus/dsabot
1
0
Fork 0
Code Issues Pull Requests 10 Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Marcus Netz
2020-11-26 21:56:28 +01:00
committed by GitHub
parent fa60f89e36
commit 0ac4fe4d04
1 changed files with 29 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -9,19 +9,35 @@ It can roll dice and even compare results with your characters attributes.
# Commands # Commands
### !help
Send the user a simple command list with things to do.
## Dice Rolling ## Dice Rolling
### !roll *x* W/D *y* ### !roll *x* W/D *y*
This command can be used to roll dice. To use it one has to put in the number of dice to use as the *x* and the number of sides as the *y* in between those Numbers stands W/D which simply means dice(D) or the german word "Würfel" (W). Theoretically it doesn't matter what Letter is in between but for roleplay gamers this should feel natural. This command can be used to roll dice. To use it one has to put in the number of dice to use as the *x* and the number of sides as the *y* in between those Numbers stands W/D which simply means dice(D) or the german word "Würfel" (W). Theoretically it doesn't matter what Letter is in between but for roleplay gamers this should feel natural.
### !heads
Throw a coin. Heads or Tails?
## Tracking System ## Tracking System
As this Bot should help with tracking your character, simply attach your .tda file in a private message. As this Bot should help with tracking your character, simply attach your .tda file in a private message.
### !ep / !ap [Value]
Probes on your attributes.
Rolls 1 dice and compares it with the given value. Rolls another, if returned number is 1 or 20.
ie `!ep 11`
### !ep / !ap [Attribute or Abbreviation]
Does the same as above. You don't need to remember your stats (if you sent a `tdc`-File, that is.)
ie. `!ep Mut` or `!ep KK`
### !skill [skillname] ### !skill [skillname]
Returns the current level of the desired skill. Returns the current level of the desired skill.
### !talent [skillname] ([-Disadvantages/+Advantages]) ### !talent [skillname] ([-Disadvantages/+Advantages])
Rolls 3 dice and compares the results with your current level of character attributes including your bonus on that particular skill. Rolls 3 dice and compares the results with your current level of character attributes including your bonus on that particular skill.
`caution`: It does not yet make use of any benefits or disadvantages your character has (at the moment). `caution`: It does not yet make use of any benefits or disadvantages your character has (at the moment).
@ -32,10 +48,22 @@ ie. `!talent klettern -2`
Deine Werte für MU, GE, KK sind 12, 13, 12. (Bonus: 6) Deine Werte für MU, GE, KK sind 12, 13, 12. (Bonus: 6)
Das waren deine 🎲: 1, 16, 2. Damit hast du 3/3 Proben bestanden. Dein Bonus: 3/6. Das waren deine 🎲: 1, 16, 2. Damit hast du 3/3 Proben bestanden. Dein Bonus: 3/6.
``` ```
### !talents
Sends the User a list of talents to use on the `!talent` command.
### !tp [attribute1] [attribute2] [attribute3] ([bonus] [-Disadvantage/+Advantages]) ### !tp [attribute1] [attribute2] [attribute3] ([bonus] [-Disadvantage/+Advantages])
This command also rolls 3 dice and compares their values with entered arguments. This command also rolls 3 dice and compares their values with entered arguments.
This one is better suited for people, who did not provide a `.tda`-File or if one of the other numerous Advantages and/or Disadvantages need to be considered aswell. This one is better suited for people, who did not provide a `.tda`-File or if one of the other numerous Advantages and/or Disadvantages need to be considered aswell.
Roll with no Bonus:
`!tp 11 11 13`
Roll with a set Bonus of 4:
`!tp 12 10 11 4`
Roll with a Benefit given by the GM:
`!tp 11 10 11 0 +2`
# How to use # How to use
To connect the script to a Bot, you need to create a Bot using the Discord Developer Portal. To do this you can follow a guide like [this](https://discordpy.readthedocs.io/en/latest/discord.html). To connect the script to a Bot, you need to create a Bot using the Discord Developer Portal. To do this you can follow a guide like [this](https://discordpy.readthedocs.io/en/latest/discord.html).
## Docker ## Docker