PluralKit/docs/content/guide/ids.md
2020-06-12 15:18:51 +02:00

2.3 KiB

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)

Finding your IDs

To find your own system ID, look up your own system card using the system 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 member member-name command, like so:

TODO: insert example with highlighted ID (showing command invocation)

You can also look at your member list, 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:

system system-id system system-id list member member-id switch member-id-1 member-id-2

System IDs can also be written as either an account @mention or a numeric Discord user 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:

member 'Myriad "Big Boss" Kit ' description My new description! member asdfg description My new description! :::