mirror of
https://github.com/PluralKit/PluralKit.git
synced 2026-02-07 06:17:55 +00:00
A lot more style/content changes
This commit is contained in:
parent
ead1ae4e7c
commit
3d7a6ec72f
18 changed files with 223 additions and 153 deletions
|
|
@ -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.
|
||||
:::
|
||||
|
|
@ -1,2 +1,45 @@
|
|||
# System and member IDs
|
||||
hi!
|
||||
# IDs
|
||||
Most "things" in PluralKit have a randomly assigned **5-character ID**. When you create a new system or a new member,
|
||||
an ID will be generated for that system or member.
|
||||
|
||||
The IDs are always lowercase letters, and will look something like this: `zxcvb`. They generally won't spell anything readable,
|
||||
but given their random nature, occasionally they'll produce a word. Consider it a bonus! (unless it's a slur or something rude, in which case [ask me to change it](../support-server.md))
|
||||
|
||||
## Finding your IDs
|
||||
To find your own system ID, look up your own system card using the <Cmd inline>system</Cmd> command. The system ID will display in the card's footer, like so:
|
||||
|
||||
TODO: insert example with highlighted ID
|
||||
|
||||
To find a member ID, you can similarly look up the member by name using the <Cmd inline>member <Arg>member-name</Arg></Cmd> command, like so:
|
||||
|
||||
TODO: insert example with highlighted ID (showing command invocation)
|
||||
|
||||
|
||||
You can also [look at your member list](./listing.md), and each member's ID will be shown on the left-hand side, like so:
|
||||
|
||||
TODO: insert example with highlighted ID (showing command invocation)
|
||||
|
||||
## Where can I use it?
|
||||
IDs are the universal way of uniquely referring to a system or member. Most commands will allow you to enter a relevant ID:
|
||||
|
||||
<CmdGroup>
|
||||
<Cmd>system <Arg>system-id</Arg></Cmd>
|
||||
<Cmd>system <Arg>system-id</Arg> list</Cmd>
|
||||
<Cmd>member <Arg>member-id</Arg></Cmd>
|
||||
<Cmd>switch <Arg>member-id-1</Arg> <Arg>member-id-2</Arg></Cmd>
|
||||
</CmdGroup>
|
||||
|
||||
**System IDs** can also be written as either an account `@mention` or a numeric [Discord user ID](https://support.discord.com/hc/en-us/articles/206346498-Where-can-I-find-my-User-Server-Message-ID-). This will refer to the system linked to that account.
|
||||
|
||||
**Member IDs** can be used instead of member names in most commands. This is especially useful if a member has spaces or symbols in the username; using the member ID lets you avoid messing with "quotes", emojis, special keyboards, etc.
|
||||
|
||||
::: details Example
|
||||
Take a member with the name `Myriad "Big Boss" Kit ✨`. This member has the ID `asdfg`.
|
||||
|
||||
When running a command on this member (eg. changing their description), both of these will work:
|
||||
|
||||
<CmdGroup>
|
||||
<Cmd>member <Arg>'Myriad "Big Boss" Kit ✨'</Arg> description <Arg>My new description!</Arg></Cmd>
|
||||
<Cmd>member <Arg>asdfg</Arg> description <Arg>My new description!</Arg></Cmd>
|
||||
</CmdGroup>
|
||||
:::
|
||||
1
docs/content/guide/listing.md
Normal file
1
docs/content/guide/listing.md
Normal file
|
|
@ -0,0 +1 @@
|
|||
# Listing members
|
||||
|
|
@ -8,10 +8,10 @@ A *system* is equivalent to an account. Every user of PluralKit must have a syst
|
|||
## System IDs
|
||||
Each system has a **system ID** - a randomly generated string of 5 letters. You can use this ID to unambiguously refer to a system in commands.
|
||||
|
||||
You can see your system ID by running <Cmd-inline>system</Cmd-inline> and looking at the embed footer (at the bottom of the response).
|
||||
You can see your system ID by running <Cmd inline>system</Cmd> and looking at the embed footer (at the bottom of the response).
|
||||
|
||||
## Creating a system
|
||||
To create a system, use the <Cmd-inline>system new</Cmd-inline> command with an optional system name:
|
||||
To create a system, use the <Cmd inline>system new</Cmd> command with an optional system name:
|
||||
|
||||
<CmdGroup>
|
||||
<Cmd>system new</Cmd>
|
||||
|
|
@ -37,7 +37,7 @@ Should you want to unlink an account, use the equivalent unlink account:
|
|||
|
||||
<Cmd>unlink <Arg>@NameOfAccount#1234</Arg></Cmd>
|
||||
|
||||
You can unlink your own account too (both by mentioning, or using <Cmd-inline>unlink</Cmd-inline> with no account). While you can't unlink the only linked account, be careful not to lock yourself out of your system by other means :slightly_smiling_face:
|
||||
You can unlink your own account too (both by mentioning, or using <Cmd inline>unlink</Cmd> with no account). While you can't unlink the only linked account, be careful not to lock yourself out of your system by other means :slightly_smiling_face:
|
||||
|
||||
::: tip
|
||||
On both of these commands, you can also supply a user ID. This is useful when you want to unlink an already-deleted account, for example.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue