Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
edg-l authored Dec 6, 2017
1 parent 07d90df commit afcbfb4
Showing 1 changed file with 14 additions and 9 deletions.
23 changes: 14 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,25 @@
# HelperBot
A TShock plugin

## Commands
- /hb \<command>
A bot with multiple utilities, such as a Q&A system.

Current /hb commands:
- None, WIP (please tell ideas if you have)
# Commands:
**Command** | **Permission** | **Arguments** | **Description**
--- | --- | --- | ---
hb | helperbot.cmds | subcommand | Base command to use subcommands

**SubCommand** | **Permission** | **Arguments** | **Description**
--- | --- | --- | ---
reload | helperbot.admin | | Reloads the configuration settings.

## Permissions
- helperbot.cmds
To use the bot reminder utility you need the permission: **helperbot.remind**

![Reminder utility](https://i.imgur.com/BtPHycH.png)

## Question & Answer system
You can add as many questions with their answers as you want, check the generated file (after first run) called HelperBot.json

Note: Questions are matched case insensitive.
_Note: Questions are matched case insensitive._

You can use regex on the questions, don't know what regex is? See [here](https://en.wikipedia.org/wiki/Regular_expression)

Expand All @@ -22,5 +28,4 @@ Here you can find a regex tutorial: [link](https://regexone.com/)
Here you can test regex patterns: [link](https://regex101.com/)

## Builtin calcultor
If you ask in chat "how much is 2+2? (with or without ? and lowercase or not)
it will answer the result
If you ask in chat "how much is 2+2? (with or without ? and lowercase or not) it will answer the result.

0 comments on commit afcbfb4

Please sign in to comment.