From ab49ad7217a07ffd7342e3ecf01a1e0e9a80de5a Mon Sep 17 00:00:00 2001 From: Ske Date: Wed, 3 Jul 2019 11:44:57 +0200 Subject: [PATCH] Add command list and API documentation --- docs/1-user-guide.md | 38 ++++++++++++++++++++++++++++- docs/2-command-list.md | 46 +++++++++++++++++++++++++++++++++-- docs/3-api-documentation.md | 4 ++- docs/4-privacy-policy.md | 27 +++++++++++++++++++- docs/_config.yml | 3 +-- docs/_sass/custom/custom.scss | 1 + 6 files changed, 112 insertions(+), 7 deletions(-) create mode 100644 docs/_sass/custom/custom.scss diff --git a/docs/1-user-guide.md b/docs/1-user-guide.md index 06edbccd..c9ca3963 100644 --- a/docs/1-user-guide.md +++ b/docs/1-user-guide.md @@ -323,4 +323,40 @@ This requires you to have the *Manage Server* permission on the server. For exam pk;log #proxy-log -To disable logging, use the `pk;log` command with no channel name. \ No newline at end of file +To disable logging, use the `pk;log` command with no channel name. + +## Importing and exporting data +If you're a user of another proxy bot (eg. Tupperbox), or you want to import a saved system backup, you can use the importing and exporting commands. + +### Importing from Tupperbox +If you're a user of the *other proxying bot* Tupperbox, you can import system and member information from there. This is a fairly simple process: + +1. Export your data from Tupperbox: +``` +tul!export +``` +2. Copy the URL for the data file (or download it) +3. Import your data into PluralKit: +``` +pk;import https://link/to/the/data/file.json +``` +*(alternatively, run `pk;import` by itself and attach the .json file)* + +Note that while Tupperbox supports features such as multiple proxies per member, per-member system tags, and member groups, PluralKit does not. +PluralKit will warn you when you're importing a Tupperbox file that makes use of such features, as they will not carry over. + +### Importing from PluralKit +If you have an exported file from PluralKit, you can import system, member and switch information from there like so: +1. Export your data from PluralKit: +``` +pk;export +``` +2. Copy the URL for the data file (or download it) +3. Import your data into PluralKit: +``` +pk;import https://link/to/the/data/file.json +``` +*(alternatively, run `pk;import` by itself and attach the .json file)* + +### Exporting your PluralKit data +To export all the data associated with your system, run the `pk;export` command. This will send you a JSON file containing your system, member, and switch information. \ No newline at end of file diff --git a/docs/2-command-list.md b/docs/2-command-list.md index 22a6a453..1251bedb 100644 --- a/docs/2-command-list.md +++ b/docs/2-command-list.md @@ -5,9 +5,51 @@ permalink: /commands --- # How to read this +Words in are *required parameters*. Words in [square brackets] are *optional parameters*. Words with ellipses... indicate multiple repeating parameters. # Commands - ## System commands +- `pk;system [id]` - Shows information about a system. +- `pk;system new [name]` - Creates a new system registered to your account. +- `pk;system rename [new name]` - Changes the description of your system. +- `pk;system description [description]` - Changes the description of your system. +- `pk;system avatar [avatar url]` - Changes the avatar of your system. +- `pk;system tag [tag]` - Changes the system tag of your system. +- `pk;system timezone [location]` - Changes the time zone of your system. +- `pk;system delete` - Deletes your system. +- `pk;system [id] fronter` - Shows the current fronter of a system. +- `pk;system [id] fronthistory` - Shows the last 10 fronters of a system. +- `pk;system [id] frontpercent [timeframe]` - Shows the aggregated front history of a system within a given time frame. +- `pk;system [id] list` - Shows a paginated list of a system's members. +- `pk;system [id] list full` - Shows a paginated list of a system's members, with increased detail. +- `pk;link ` - Links this system to a different account. +- `pk;unlink [account]` - Unlinks an account from this system. ## Member commands -## whatever \ No newline at end of file +- `pk;member ` - Shows information about a member. +- `pk;member new ` - Creates a new system member. +- `pk;member rename ` - Changes the name of a member. +- `pk;member description [description` - Changes the description of a member. +- `pk;member avatar [avatar url]` - Changes the avatar of a member. +- `pk;member proxy [tags]` - Changes the proxy tags of a member. +- `pk;member pronouns [pronouns]` - Changes the pronouns of a member. +- `pk;member color [color]` - Changes the color of a member. +- `pk;member birthdate [birthdate]` - Changes the birthday of a member. +- `pk;member delete` - Deletes a member. +## Switching commands +- `pk;switch [member...]` - Registers a switch with the given members. +- `pk;switch move