# Commands

## Using Command parameters

{% hint style="warning" %}
Do not literally type out <> \[] | etc
{% endhint %}

**Optional**: \[foo] means that this argument can be ignored.\
**Required**: \<foo> means that you *must* use this argument for the command to work\
**Prefix**: `!vt`, the default prefix, should be replaced with whatever prefix you've set

## Public Commands

### !vt \[ban\_index]

The most straight-forward command. When used, the bot will reply with the how long the server has gone without saying their banned words.

```
>>> !vt
1, 'fdsa': 2 hours, 1 minute, and 18 seconds.
2, 'asdf': 5 minutes, and 25 seconds.

>>> !vt 1
'fdsa': 2 hours, 1 minute, and 18 seconds.
```

### !vtct \[ban\_index]

Similar to `!vt`, this command will reply with the length of the server's cool-down, and the cool-down status of the banned words.

```
>>> !vtct
The cooldown period is 1 minute and 10 seconds.
I'll be able to issue another alert for 'fdsa' in 1 minute and 7 seconds.
I'm ready to issue another warning for 'asdf' now.

>>> !vtct 2
The cooldown period is 1 minute and 10 seconds.
I'm ready to issue another warning for 'asdf' now.
```

### !vtr \[ban\_index]

Much like `!vt` and `!vtct`, this command will reply with the number of times each banned word has been said, as well as the longest streak without saying it.

```
>>> !vtr
The server has said 'bonkers' 0 times.
The server's currently on its longest streak without saying 'bonkers': 55 days, 14 hours, 17 minutes, and 47 seconds.

The server has said 'queue' 0 times.
The server's currently on its longest streak without saying 'queue': 62 days, 11 hours, 41 minutes, and 17 seconds.

>>> !vtr 2
The server has said 'te' 1 time.
The server's currently on its longest streak without saying 'te': 29 days, 16 hours, 51 minutes, and 27 seconds.
```

### !vthelp

Pretty self-explanatory, this command will let you know how to use the various import commands. Notably, it will tell you what the server's prefix is.

{% hint style="info" %}
This command works both as the literal `!vthelp`, as well as with whatever prefix you've set.
{% endhint %}

```
>>> !vthelp
You can ask me how long we've made it with '!vt'.
You can learn how long my timeout is set for, and when I can issue another warning with '!vtct'.
...
```

## Admin-only Commands

{% hint style="warning" %}
Like the name implies, to use these commands you'll have to be an administrator on the server you're on.
{% endhint %}

### !vtprefix \[new\_prefix]

This command is used to change what the bot uses for its prefix on the server. The new prefix must be between 1 and 10 characters.

```
>>> !vtprefix $test
Cool, from now on you'll need to start a message with '$test' for me to treat it as a command.

>>> $testct 2
The cooldown period is 1 minute and 10 seconds.
I'm ready to issue another warning for 'asdf' now.
```

### !vtdelay \[hours:]\[minutes:]\<seconds>

This command can be used to set how long the server will wait between calling out users in chat.

```
>>> !vtdelay 1:1:10
Cool, from now on I'll wait at least 1 hour, 1 minute, and 10 seconds between alerts.

>>> !vtdelay 70:35
Cool, from now on I'll wait at least 1 hour, 10 minutes, and 35 seconds between alerts.
```

### !vtswapban \<target\_index> \<word\_to\_ban>

Use this command to change a word banned by the server. This should be used as part of setting up the bot on the server, to change from the default banned word.

```
>>> !vtswapban 1 asdf
Ok @admin, 'asdf' has replaced 'test' as a forbidden word.
```

### !vtban \<word\_to\_ban>

Use this command to ban an additional word on the server. Only three words may be banned at a time.

```
>>> !vtban asdf
Ok @admin, 'asdf' is now considered a forbidden word.
```

### !vtunban \<target\_index>

Use this command to remove one of the words banned by the server. The index should be one of the numbers seen when using `!vt.` There must be at least one word banned at all times, so the last ban can't be removed.

```
>>> !vtunban 3
Ok @admin, 'asdf' is no longer considered a forbidden word.
```

### !vtsilence

The opposite of `!vtalert`, after this command is used, the bot will silently record infractions instead of calling out users in the chat.

```
>>> !vtsilence
Ok @admin, I'll be quiet now. use '!vtalert' to wake me back up!
```

### !vtalert

The opposite of `!vtsilence`, this command will re-enable call-outs from the bot.

```
>>> !vtalert
Ok @admin, I'm scanning now.
```

###