# AFK

A cog for being afk and responding when idiots ping you.

## \[p]afk

Set yourself as AFK with an optional message.<br>

* Usage: `[p]afk [message]`
* Checks: `server_only`

### \[p]afk togglenick

\[Admin/Mod] Toggle the afk nickname identifier of your server.<br>

* Usage: `[p]afk togglenick`
* Restricted to: `ADMIN`
* Cooldown: `1 per 30.0 seconds`
* Checks: `server_only`

### \[p]afk block

Block of unblock users from triggering your ping list.<br>

`<add_or_remove>` should be either `add` to add or `remove` to remove users.<br>

* Usage: `[p]afk block <add_or_remove> [users=None]`
* Cooldown: `1 per 30.0 seconds`

### \[p]afk settings

Shows the settings for the server.<br>

* Usage: `[p]afk settings`
* Restricted to: `ADMIN`

### \[p]afk nickname

\[Admin/Mod] change the afk nickname identifier of your server.<br>

* Usage: `[p]afk nickname [text]`
* Restricted to: `MOD`
* Aliases: `nick`
* Cooldown: `1 per 30.0 seconds`

### \[p]afk reset

\[Admin/Mod] Reset member's custom afk message.<br>

* Usage: `[p]afk reset <member>`
* Restricted to: `MOD`

### \[p]afk list

List users who are AFK and their duration.<br>

* Usage: `[p]afk list`

#### \[p]afk list ignored

Lists the ignored channels for AFK.<br>

* Usage: `[p]afk list ignored`
* Restricted to: `ADMIN`

#### \[p]afk list blocked

List your blocked users.<br>

* Usage: `[p]afk list blocked`
* Aliases: `block`

### \[p]afk clear

\[Admin/Mod] Reset member's AFK.<br>

* Usage: `[p]afk clear <member>`
* Restricted to: `MOD`
* Cooldown: `1 per 30.0 seconds`

### \[p]afk ignore

\[Admin/Mod] Add or remove channels for your server.<br>

`<add_or_remove>` should be either `add` to add channels or `remove` to remove channels.<br>

* Usage: `[p]afk ignore <add_or_remove> [channels=None]`
* Restricted to: `ADMIN`

### \[p]afk custom

Change the message sent when someone pings you while you're afk.<br>

(Supports Tagscript)<br>

**Blocks:**<br>

* [Embed](https://cogs.melonbot.io/tags/parsings/#embed-block)<br>
* [If](https://cogs.melonbot.io/tags/blocks/#if-block)<br>
* [Assignement](https://cogs.melonbot.io/tags/blocks/#assignment-block)<br>

**Variable:**<br>

* `{server}` - [The server you're afk in](https://cogs.melonbot.io/tags/variables/#server-block)<br>
* `{author}` - [You (command author)](https://cogs.melonbot.io/tags/variables/#author-block)<br>
* `{time}` - The time you're afk from.<br>
* `{reason}` - The reason you're afk for.<br>
* `{color}` - Hoist color of people who ping you.<br>

**Example:**<br>

```
[p]afk custom {embed(description):
{author(mention)} is currently AFK ({time})
**Message:**
{reason}
}
{embed(color):{color}}
{embed(thumbnail):{author(avatar)}}
```

* Usage: `[p]afk custom [message]`
* Cooldown: `1 per 30.0 seconds`