zappyzep/backend/src/plugins/RoleButtons/info.ts
Tiago R 06877e90cc
Update djs & knub (#395)
* update pkgs

Signed-off-by: GitHub <noreply@github.com>

* new knub typings

Signed-off-by: GitHub <noreply@github.com>

* more pkg updates

Signed-off-by: GitHub <noreply@github.com>

* more fixes

Signed-off-by: GitHub <noreply@github.com>

* channel typings

Signed-off-by: GitHub <noreply@github.com>

* more message utils typings fixes

Signed-off-by: GitHub <noreply@github.com>

* migrate permissions

Signed-off-by: GitHub <noreply@github.com>

* fix: InternalPoster webhookables

Signed-off-by: GitHub <noreply@github.com>

* djs typings: Attachment & Util

Signed-off-by: GitHub <noreply@github.com>

* more typings

Signed-off-by: GitHub <noreply@github.com>

* fix: rename permissionNames

Signed-off-by: GitHub <noreply@github.com>

* more fixes

Signed-off-by: GitHub <noreply@github.com>

* half the number of errors

* knub commands => messageCommands

Signed-off-by: GitHub <noreply@github.com>

* configPreprocessor => configParser

Signed-off-by: GitHub <noreply@github.com>

* fix channel.messages

Signed-off-by: GitHub <noreply@github.com>

* revert automod any typing

Signed-off-by: GitHub <noreply@github.com>

* more configParser typings

Signed-off-by: GitHub <noreply@github.com>

* revert

Signed-off-by: GitHub <noreply@github.com>

* remove knub type params

Signed-off-by: GitHub <noreply@github.com>

* fix more MessageEmbed / MessageOptions

Signed-off-by: GitHub <noreply@github.com>

* dumb commit for @almeidx to see why this is stupid

Signed-off-by: GitHub <noreply@github.com>

* temp disable custom_events

Signed-off-by: GitHub <noreply@github.com>

* more minor typings fixes - 23 err left

Signed-off-by: GitHub <noreply@github.com>

* update djs dep

* +debug build method (revert this)

Signed-off-by: GitHub <noreply@github.com>

* Revert "+debug build method (revert this)"

This reverts commit a80af1e729b742d1aad1097df538d224fbd32ce7.

* Redo +debug build (Revert this)

Signed-off-by: GitHub <noreply@github.com>

* uniform before/after Load shorthands

Signed-off-by: GitHub <noreply@github.com>

* remove unused imports & add prettier plugin

Signed-off-by: GitHub <noreply@github.com>

* env fixes for web platform hosting

Signed-off-by: GitHub <noreply@github.com>

* feat: knub v32-next; related fixes

* fix: allow legacy keys in change_perms action

* fix: request Message Content intent

* fix: use Knub's config validation logic in API

* fix(dashboard): fix error when there are no message and/or slash commands in a plugin

* fix(automod): start_thread action thread options

* fix(CustomEvents): message command types

* chore: remove unneeded type annotation

* feat: add forum channel icon; use thread icon for news threads

* chore: make tslint happy

* chore: fix formatting

---------

Signed-off-by: GitHub <noreply@github.com>
Co-authored-by: almeidx <almeidx@pm.me>
Co-authored-by: Dragory <2606411+Dragory@users.noreply.github.com>
2023-04-01 14:58:17 +03:00

82 lines
2.9 KiB
TypeScript

import { trimPluginDescription } from "../../utils";
import { ZeppelinGuildPluginBlueprint } from "../ZeppelinPluginBlueprint";
import { ConfigSchema } from "./types";
export const pluginInfo: ZeppelinGuildPluginBlueprint["info"] = {
prettyName: "Role buttons",
description: trimPluginDescription(`
Allow users to pick roles by clicking on buttons
`),
configurationGuide: trimPluginDescription(`
Button roles are entirely config-based; this is in contrast to the old reaction roles. They can either be added to an existing message posted by Zeppelin or posted as a new message.
## Basic role buttons
~~~yml
role_buttons:
config:
buttons:
my_roles: # You can use any name you want here, but make sure not to change it afterwards
message:
channel_id: "967407495544983552"
content: "Click the reactions below to get roles! Click again to remove the role."
options:
- role_id: "878339100015489044"
label: "Role 1"
- role_id: "967410091571703808"
emoji: "😁" # Default emoji as a unicode emoji
label: "Role 2"
- role_id: "967410091571703234"
emoji: "967412591683047445" # Custom emoji ID
- role_id: "967410091571703567"
label: "Role 4"
style: DANGER # Button style (in all caps), see https://discord.com/developers/docs/interactions/message-components#button-object-button-styles
~~~
### Or with an embed:
~~~yml
role_buttons:
config:
buttons:
my_roles:
message:
channel_id: "967407495544983552"
content:
embeds:
- title: "Pick your role below!"
color: 0x0088FF
description: "You can pick any role you want by clicking the buttons below."
options:
... # See above for examples for options
~~~
## Role buttons for an existing message
This message must be posted by Zeppelin.
~~~yml
role_buttons:
config:
buttons:
my_roles:
message:
channel_id: "967407495544983552"
message_id: "967407554412040193"
options:
... # See above for examples for options
~~~
## Limiting to one role ("exclusive" roles)
When the \`exclusive\` option is enabled, only one role can be selected at a time.
~~~yml
role_buttons:
config:
buttons:
my_roles:
message:
channel_id: "967407495544983552"
message_id: "967407554412040193"
exclusive: true # With this option set, only one role can be selected at a time
options:
... # See above for examples for options
~~~
`),
configSchema: ConfigSchema,
};