mirror of
https://github.com/PluralKit/PluralKit.git
synced 2026-02-09 15:27:54 +00:00
Initial docs rewrite using Vuepress
This commit is contained in:
parent
e7191def02
commit
2b259869a0
47 changed files with 8276 additions and 1397 deletions
62
docs/content/guide/quick-start.md
Normal file
62
docs/content/guide/quick-start.md
Normal file
|
|
@ -0,0 +1,62 @@
|
|||
---
|
||||
defaultMember: Craig
|
||||
---
|
||||
|
||||
# Quick start
|
||||
|
||||
This page will get you started :zap: lightning-fast :zap: with the bot. You'll need to follow these steps:
|
||||
|
||||
## Create a system
|
||||
First, **create a system** with the following command:
|
||||
<Cmd>system new</Cmd>
|
||||
|
||||
You can also specify a system name if you want:
|
||||
<Cmd>system new <Arg>My System Name</Arg></Cmd>
|
||||
|
||||
## Create a member
|
||||
Second, **create a member** with the following command, inserting the member name:
|
||||
|
||||
<Cmd>member new <Arg>{{ $page.frontmatter.defaultMember }}</Arg></Cmd>
|
||||
|
||||
::: tip
|
||||
You can include spaces, punctuation, or symbols in the member name. However, you'll need to write them `"in quotes"` every time you refer to the member elsewhere.
|
||||
|
||||
Instead, you can give your member a simple, easy to type name, then set the member's [display name](./proxying.md#handling-names) to a more complex version. That'll get displayed when proxying, and then you can keep the following commands simple.
|
||||
:::
|
||||
|
||||
## Set some proxy tags
|
||||
Now, you'll need to tell PluralKit how you want to trigger the proxy using **proxy tags**. Often, these will be a pair of brackets, an emoji prefix, or something similar.
|
||||
|
||||
To set a member's proxy tags, you'll need to "pretend" you're proxying the word `text` - just the word itself, all-lowercase. This often gets a bit confusing, so here are a couple of examples with various patterns:
|
||||
|
||||
<CmdGroup>
|
||||
<Cmd>member <Arg>{{ $page.frontmatter.defaultMember }}</Arg> proxy <Arg>J:text</Arg></Cmd>
|
||||
<Cmd>member <Arg>{{ $page.frontmatter.defaultMember }}</Arg> proxy <Arg>[text]</Arg></Cmd>
|
||||
<Cmd>member <Arg>{{ $page.frontmatter.defaultMember }}</Arg> proxy <Arg>🌸text</Arg></Cmd>
|
||||
<Cmd>member <Arg>{{ $page.frontmatter.defaultMember }}</Arg> proxy <Arg>text -Q</Arg></Cmd>
|
||||
</CmdGroup>
|
||||
|
||||
::: tip
|
||||
You're not limited to the types of proxy tags shown above. You can put anything you'd like around the word `text` (before, after, or both), and PluralKit will look for that. Be creative!
|
||||
:::
|
||||
|
||||
## Set an avatar (optional)
|
||||
If you want an avatar displayed, use the following command:
|
||||
|
||||
<Cmd>member <Arg>{{ $page.frontmatter.defaultMember }}</Arg> avatar <Arg>https://link.to.your/avatar.png</Arg></Cmd>
|
||||
|
||||
::: tip
|
||||
If you don't have a link, you can leave that out entirely, and then **attach** the image to the command message itself. PluralKit will pick up on the attachment, and use that instead.
|
||||
:::
|
||||
|
||||
::: warning
|
||||
Avatars have some restrictions:
|
||||
- The image must be in **.jpg**, **.png**, or **.webp** format
|
||||
- The image must be under **1024 KB** in size
|
||||
- The image must be below **1024 x 1024 pixels** in resolution (along the smallest axis).
|
||||
- Animated GIFs are **not** supported (even if you have Nitro).
|
||||
:::
|
||||
|
||||
|
||||
## More information
|
||||
(TODO)
|
||||
Loading…
Add table
Add a link
Reference in a new issue