---
tags: discord
---

**[Out of Date]**

# Discord bot - Shiki Natsume Command list

[TOC]

---

## Meanings of symbols
**[arg]**
the argument is optional

**\<arg\>**
the argument is necessary

<b> * [arg]</b>
no or multiple arguments

<b>* \<arg\></b>
at least one or multiple arguments

---

## Commands

#### $ping

sent a signal to the host for requesting a response of delay time

#### $repeat * \<message\>

let the bot repeat the message you sent
:::warning
*(require at least moderator role)*
:::

#### $clear [cnt = 1]
> aliases: $cls

delete *cnt* (default = 1) lines of message
:::warning
*(require at least moderator role)*
:::

#### $now

return system time (UTC+8)

#### $rand_squad [squad_cnt = 1] [each_cnt = 1]

random pick *squad_cnt* $\times$ *each_cnt* online members and divide into *squad_cnt* teams

#### $vote \<title\> \<options\>

launch a vote
title can contain whitespace by adding underline: `_`
each option should be seperated by character: `|`
> beware that you cannot submit more than 10 options

e.g.

`$vote 3/13晚餐吃什麼 小川|裸湯|壹之穴|重熙|崇燈|墨洋|極匠|真劍`

result:

:::warning
*(require at least moderator role)*
:::

#### $help
get help

#### $picture

modify pictures

[>details](#Pictures)

---

## Events

#### (on member join)

send message when new member join the server

#### (picture)

send picture when identify specific words

[>details](#Pictures)

---

## Roles

#### $op * <member>

give *member* *@Moderator* role

:::warning
*(require at least moderator role)*
:::

#### $deop * <member>
remove *member* from *@Moderator* role

:::warning
*(require at least moderator role)*
:::

#### $ban * <member>
ban *member*

:::warning
*(require at least moderator role)*
:::

#### $unban * <member>
unban *member*

:::warning
*(require at least moderator role)*
:::

#### $mute * <member>
mute *member*

:::warning
*(require at least moderator role)*
:::

#### $unmute * <member>

:::warning
*(require at least moderator role)*
:::

---

## Pictures

:::info
This part of commands require the prefix of `picture`, `pic`, or `p`
:::

#### (on_message)

send message when identify specific words

#### $print <filename>
> aliases: p

print a picture with the filename

#### $key_list [page = 1]
> aliases: k, key, keys

print all the keys divided in pages

#### $search_by_key <key> [page = 1]
> aliases: s, f, sk, fk, find_by_key

print all the pictures bonded to the key in pages

#### $search_by_picture <filename> [page = 1]
> aliases: sp, fp, find_by_picture

print all the keys bonded to the filename in pages

#### $upload [url] {attachment}
> aliases: u

upload a image via url or attachment

:::warning
*(require at least moderator role)*
:::

#### $bond <key> <file>
> aliases: b

bond a image of which filename is `file` to `key`

:::warning
*(require at least moderator role)*
:::

#### $disconnect <key> <file>
> aliases: split

disconnect a image of which filename is `file` to `key`

:::warning
*(require at least moderator role)*
:::

#### $remove_by_key <key>
> aliases: rk, kr

disconnect the key with all the pictures

:::warning
*(require at least moderator role)*
:::

#### $remove_by_picture <file>

disconnect the picture with all the keys

:::warning
*(require at least moderator role)*
:::

## Market

:::info
This part of commands require a prefix of `market`, or `m`
:::

#### $sell [description]

:::warning
you can only use this command in `#market-chatting` channel
:::

post a product description on `products` channel

beware that you can delete any product directly in the `products` channel without any command or requirement

#### $upload {attachment}

:::warning
you can only use this command in `#market-chatting` channel
:::

upload image for your product
the image will instantly show up in `products` channel