Skip to content
This repository was archived by the owner on Mar 28, 2024. It is now read-only.

Commit 30dc320

Browse files
Merge pull request #105 from elenirotsides/readme-update
readme edits to explain sub commands
2 parents 274e610 + fd34dcc commit 30dc320

File tree

1 file changed

+33
-8
lines changed

1 file changed

+33
-8
lines changed

README.md

Lines changed: 33 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -34,20 +34,45 @@ You can also append any of the commands to `help` to learn more about the differ
3434

3535
- `!help tfchill` Will give more detail about this specific game mode, for example.
3636

37-
_In the very near future, I will be implementing customizable time limits for the game modes, so stay tuned for that! Additionally, more work will be done to allow the bot to respond to customizable game requests, like allowing the user to select how many questions they want, which category, and which difficulty._
37+
## Sub Commands
38+
39+
**Trivia Bot now supports optional sub commands!**
40+
41+
So...what does this mean for you? Trivia Bot can now take `time [seconds]` as an optional sub command so that you can extend the time limit per question in a Trivia round! This was done to make the game more accessible for those that can't read as quickly as others, or simply, for those that just want to take their time playing!
42+
43+
_Please note: This option is only available for chill modes of gameplay. This is due to the nature of chill modes; competitive modes are meant to be quick, rapid-fire rounds which is why this option was not applied to competitive modes._
44+
45+
_Please note part 2: There will be more optional sub commands added in the future such as selecting more than 10 questions, specific category selection, and difficulty selection, to name a few. **Please stay tuned for these!**_
46+
47+
### How to use the Sub Commands
48+
49+
#### time [seconds]
50+
51+
Let's say you want to play a round of `tfchill` but want to make each question have a time limit of 20 seconds:
52+
53+
All you need to do is type the following: `!tfchill time 20`
54+
55+
By default, Trivia Bot will give you 10 seconds per question. So, if you don't provide `time [seconds]`, then the bot will default to 10.
56+
57+
**Limits:**
58+
_Minimum: 10 seconds
59+
Maximum: 180 seconds
60+
Can only be applied to `tfchill` or `mcchill` game modes_
3861

3962
## Command Aliases
4063

41-
- You can use `!halp`, `!hwlp`, `!hrlp` instead of `!help`
42-
- You can use `!mchill` instead of `!mcchill`
43-
- You can use `!mcompetitive`, `!mccomp`, `!mcomp` instead of `!mccompetitive`
44-
- You can use `!pong` instead of `!ping`
45-
- You can use `!rewuest`, `!bug` instead of `!request`
46-
- You can use `!tfcomp` instead of `!tfcompetitive`
64+
Sometimes you'll mispell something and sometimes you'll want a quicker way to interact with the bot. Below are a list of aliases you can use in place of the original command names:
65+
66+
- You can use `!halp`, `!hwlp`, `!hrlp` instead of `!help`
67+
- You can use `!mchill` instead of `!mcchill`
68+
- You can use `!mcompetitive`, `!mccomp`, `!mcomp` instead of `!mccompetitive`
69+
- You can use `!pong` instead of `!ping`
70+
- You can use `!rewuest`, `!bug` instead of `!request`
71+
- You can use `!tfcomp` instead of `!tfcompetitive`
4772

4873
## Contributing
4974

50-
Please see [CONTRIBUTING.md](https://github.com/elenirotsides/Trivia-Bot/blob/main/CONTRIBUTING.MD) for instructions on how you can contribute to the development of this bot.
75+
Please see [CONTRIBUTING.md](https://github.com/elenirotsides/Trivia-Bot/blob/main/CONTRIBUTING.MD) for instructions on how you can contribute to the development of this bot. Trivia Bot always welcomes PRs!
5176

5277
## Discussions
5378

0 commit comments

Comments
 (0)