PK[qProx]

1. What is this tool for?
2. How do I use this tool?

What is this tool for?

PK[qProx] is short for PluralKit[Quick Proxy].

This tool allows you to quickly set member proxy tags depending on their name, display name, or ID.

You must already have created the member(s) in PluralKit in order to use this tool. This tool does not create new members.

How do I use this tool?

First, enter your 64 alphanumeric character PluralKit API Token, and 5 or 6 letter PluralKit System ID (Allowed formats are abcde, abcdef, abc-def with or without capital letters) in the boxes below. You can get your system's API token by running the command pk;token in the PluralKit bot. When copying the token, make sure that you have exactly 64 alphanumeric (letters and numbers only) characters copied, with no spaces before or after. Some devices may add a space around the text and the tool will not work if these are included in the box below.

Once you've entered those details, you can enter the template for the proxy tag you wish to add. You can find example templates below.

How do I tell the tool to use the name/display name/ID?

The tool recognises "aliases" in the format of ${alias_name}. When you run the tool, it looks for aliases in the template field and will replace it with the correct information.

For the below examples, lets pretend that we have a member with a base name of "Alice", a display name of "Alice 🌸✨" and an id of "gaznz".

The standard aliases are:

• ${base_name}
• ${display_name}
• ${id}

• ${dn_emoji} to use emojis found in the display name
• ${api_index} to use the index number of the member from the API. This almost guarantees you won't have a duplicate proxy tag, but it can change if you run this tool again after making other changes to your members.
• ${first_of...} to use the first character found in some other alias:
  • ${first_of_base_name} such as "A" from "Alice"
  • ${first_of_display_name} such as "A" from "Alice 🌸✨"
  • ${first_of_id} such as "g" from "gaznz"
  • ${first_of_dn_emoji} such as "🌸" from "Alice 🌸✨"
• ${last_of...} to use the last character found in some other alias:
  • ${last_of_base_name} such as "e" from "Alice"
  • ${last_of_display_name} such as "✨" from "Alice 🌸✨"
  • ${last_of_id} such as "z" from "gaznz"
  • ${last_of_dn_emoji} such as "✨" from "Alice 🌸✨"

What if I want to set the proxy tags to use the "${}" format as part of the actual proxy?

Some people may want to use ${} as part of their proxy on purpose, for example to have a proxy tag of ${Alice} text. The tool can do this, but you have to use the escape character \ in your template.

If you want your proxy tags to use ${} itself as part of the proxy, use $\{} in the template instead (for example: $\{${base_name}} text to get ${Alice} text). The tool will recognise this and change it to ${} when setting the proxy tag.

This is kind of a power user feature. If you don't understand, don't worry.

What are some examples?

Like the other examples, lets pretend that we have a member with a base name of "Alice", a display name of "Alice 🌸✨", and an id of "gaznz".

Some example templates are:

• ${base_name}: text results in tags like "Alice: text"
• text -${display_name} results in tags like "text -Alice 🌸✨"
• text -${dn_emoji} results in tags like "text -🌸✨"
• text (${id}) results in tags like "text (gaznz)"

PK[qProx]

Status: Not running.