eightball/PluralKit
1
0
Fork 0
mirror of https://github.com/PluralKit/PluralKit.git synced 2026-02-10 15:57:53 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Improve Docs (#151)

Browse source 
* Added configurable command prefix

* Added getting started, renamed files

* Add nav order, add assests, add system example

* Added a lot

* Update Emojis

* Add guide links to bot

* Added Images
This commit is contained in:
BeeFox-sys 2020-02-10 00:17:26 +11:00 • committed by GitHub
parent f618bc2403
commit 9e47f98a23
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
15 changed files with 153 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

36
docs/6-tips-and-tricks.md
View file

@ -1,36 +0,0 @@
---
layout: default
title: Tips and Tricks
permalink: /tips
---
# Tips and Tricks
## Use command shorthands
PluralKit has a couple of useful command shorthands to reduce the typing:
|Original|Shorthand|
|---|---|
|pk;system|pk;s|
|pk;system list|pk;s l|
|pk;system list full|pk;s l f|
|pk;system fronter|pk;s f|
|pk;system fronthistory|pk;s fh|
|pk;system frontpercent|pk;s fp|
|pk;member|pk;m|
|pk;member new|pk;m n|
|pk;switch|pk;sw|
|pk;message|pk;msg|
|pk;autoproxy|pk;ap|
## Permission checker command
If you're having issues with PluralKit not proxying, it may be an issue with your server's channel permission setup.
PluralKit needs the *Read Messages*, *Manage Messages* and *Manage Webhooks* permission to function.
To quickly check if PluralKit is missing channel permissions, you can use the `pk;permcheck` command in the server
in question. It'll return a list of channels on the server with missing permissions. This may include channels
you don't want PluralKit to have access to for one reason or another (eg. admin channels).
If you want to check permissions in DMs, you'll need to add a server ID, and run the command with that.
For example: `pk;permcheck 466707357099884544`. You can find this ID
[by enabling Developer Mode and right-clicking (or long-pressing) on the server icon](https://discordia.me/developer-mode).