A lot more style/content changes

This commit is contained in:
Ske 2020-06-12 15:18:51 +02:00
parent ead1ae4e7c
commit 3d7a6ec72f
18 changed files with 223 additions and 153 deletions

View file

@ -1,24 +1,53 @@
# Command list
This page shows a list of all commands PluralKit supports.
::: tip HOW TO READ THIS PAGE
Below is a list of all the commands the bot supports.
## How to read this page
The first block for each command, **Usage**, shows the format of each command. This is essentially a "template" you'll need to fill in.
The parts you can change are called **arguments**, and they're highlighted.
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 each command describes how to fill it in, and what type of value goes there.
### Arguments
The command's **Arguments** section will describe how to fill them in, and what you need to put there.
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:
::: details Example of a command with an argument
Here's an example of a command with an argument:
<Cmd>some-command <Arg>this-is-an-argument</Arg></Cmd>
When running this command, fill in the argument like so:
<Cmd>some-command <Arg>My cool text</Arg></Cmd>
:::
### Systems and members
Some commands accept a **target system or member**:
For **systems**, this can either be a [5-character ID](./ids.md), a `@mention`, or a [Discord user ID](https://support.discord.com/hc/en-us/articles/206346498-Where-can-I-find-my-User-Server-Message-ID-).
In many cases you can leave the system out entirely. Instead, it'll just use your own system.
For **members**, this can be the member's name or their [5-character ID](./ids).
::: details Example of referring to systems
<CmdGroup>
<Cmd comment="Looks up a system with the ID 'exmpl'">system <Arg>exmpl</Arg></Cmd>
<Cmd>system <Arg>466378653216014359</Arg> list</Cmd>
<Cmd>system <Arg>@PluralKit#4020</Arg> fronter</Cmd>
<Cmd comment="Own system">system list</Cmd>
<Cmd comment="By ID">system <Arg>abcde</Arg> list</Cmd>
<Cmd comment="By @mention">system <Arg>@Myriad#1234</Arg> list</Cmd>
<Cmd comment="By Discord user ID">system <Arg>466378653216014359</Arg> list</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.
::: details Example of referring to members
<CmdGroup>
<Cmd comment="By name">member <Arg>Myriad</Arg> info</Cmd>
<Cmd comment="By name (with spaces)">member <Arg>"Myriad Kit"</Arg></Cmd>
<Cmd comment="By ID">member <Arg>zxcvb</Arg> info</Cmd>
</CmdGroup>
:::
::: warning
If you're trying to refer to a member with **spaces or emojis** in their name, you'll need to wrap the name in either 'single' or "double" quotes. Alternatively, you can use the [member ID](./ids).
:::
## System commands
::: tip
You can use <CmdInline>s</CmdInline> instead of <CmdInline>system</CmdInline> as a short-hand.
You can use <Cmd inline>s</Cmd> instead of <Cmd inline>system</Cmd> as a short-hand.
:::
<CommandInfo cmd="systemInfo"></CommandInfo>
@ -28,10 +57,10 @@ You can use <CmdInline>s</CmdInline> instead of <CmdInline>system</CmdInline> as
## Member commands
::: tip
You can use <CmdInline>m</CmdInline> instead of <CmdInline>member</CmdInline> as a short-hand.
You can use <Cmd inline>m</Cmd> instead of <Cmd inline>member</Cmd> as a short-hand.
:::
## Switch commands
::: tip
You can use <CmdInline>sw</CmdInline> instead of <CmdInline>switch</CmdInline> as a short-hand.
You can use <Cmd inline>sw</Cmd> instead of <Cmd inline>switch</Cmd> as a short-hand.
:::