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

1.7 KiB

systemName
My System Name

Systems

A system is equivalent to an account. Every user of PluralKit must have a system registered to use the bot.

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 system and looking at the embed footer (at the bottom of the response).

Creating a system

To create a system, use the system new command with an optional system name:

system new system new My System Name

Editing your system

System description

You can set your system description using the following command: system description My cool system description goes here.

Linking accounts

A system isn't necessarily tied to a single account. A system can be linked to another account, and all linked accounts can run commands on behalf of the system.

To link your system to another account, use the following command:

link @NameOfAccount#1234

The other account will need to confirm the link by pressing a reaction within five minutes.

Should you want to unlink an account, use the equivalent unlink account:

unlink @NameOfAccount#1234

You can unlink your own account too (both by mentioning, or using unlink 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 🙂

::: 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. :::