eightball/PluralKit
1
0
Fork 0
mirror of https://github.com/PluralKit/PluralKit.git synced 2026-02-12 00:30:11 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add "data-based" command doc framework basics

Browse source
This commit is contained in:
Ske 2020-06-10 23:19:43 +02:00
parent cca287d3e3
commit 321f4d7d25
10 changed files with 166 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

21
docs/content/guide/commands.md
View file

@ -1 +1,20 @@
# Command list
# Command list
::: tip HOW TO READ THIS PAGE
Below is a list of all the commands the bot supports.
Highlighted spaces (eg. <Arg>system-name</Arg> ) are **arguments**, and you should **fill in the blank** with the relevant bit of text. The **Arguments** section below describes what to put in each blank.
When an argument asks for a **system ID**, you can either fill in a system's [5-character ID](./ids.md), **or** you can fill in a Discord account ID, or even a @mention. For example:
<CmdGroup>
<Cmd>system <Arg>exmpl</Arg></Cmd>
<Cmd>system <Arg>466378653216014359</Arg> list</Cmd>
<Cmd>system <Arg>@PluralKit#4020</Arg> fronter</Cmd>
</CmdGroup>
When an argument asks for a **member ID**, you can either fill in a member's [5-character ID](./ids.md), or, *if the member is in your own system*, their name. This means that to target a member in another system, you **must** use their ID.
:::
## System commands
<CommandInfo cmd="system-info"></CommandInfo>
<CommandInfo cmd="system-new"></CommandInfo>