+
Zeppelin is a private moderation bot for Discord, designed with large servers and reliability in mind.
-+
Since the bot is currently private, access to the bot is granted on a case by case basis.
There are plans to streamline this process in the future.
+
All Zeppelin configuration is done through the dashboard by editing a YAML config file. By default, only the server
owner has access to this, but they can give other users access as they see fit. See
+
Zeppelin is divided into plugins: grouped functionality that can be enabled/disabled as needed, and that have their own configurations.
-+
The commands for each plugin are listed on the plugin's page (see "Plugins" on the menu). On these pages, the command prefix is assumed to be !
but this can be changed on a per-server basis.
+
Permissions in Zeppelin are simply values in plugin configuration that are checked when the command is used.
These values can be changed with overrides (see
+
The simplest way to control access to bot commands and features is via permission levels. These levels are simply a number (usually between 0 and 100), based on the user's roles or user id, that can then be used in permission overrides. By default, several commands are "moderator only" (level 50 and up) or "admin only" (level 100 and up).
-+
Additionally, having a higher permission level means that certain commands (such as !ban) can't be used against you by users with a lower or equal permission level (so e.g. moderators can't ban each other or admins above them).
-+
Permission levels are defined in the config in the levels section. For example:
@@ -28,14 +28,14 @@ "172950000412655616": 50 # Example mod -+
For this example, let's assume we have a plugin called cats
which has a command !cat
locked behind the permission can_cat
.
Let's say that by default, the plugin allows anyone to use !cat
, but we want to restrict it to moderators only.
+
Here's what the configuration for this would look like:
@@ -51,7 +51,7 @@ can_cat: true -
In this example, let's assume you don't want to use the default permission levels of 50 and 100 for mods and admins respectively.
Let's say you're using various incremental levels instead: 10, 20, 30, 40, 50...
diff --git a/dashboard/src/components/docs/Plugin.vue b/dashboard/src/components/docs/Plugin.vue
index 3245a09d..1b082ea2 100644
--- a/dashboard/src/components/docs/Plugin.vue
+++ b/dashboard/src/components/docs/Plugin.vue
@@ -3,21 +3,19 @@
Loading...
{{ command.config.extra.requiredPermission }}
+ Permission: {{ command.config.extra.requiredPermission }}
{{ command.config.extra.info.basicUsage }}
+ Basic usage: {{ command.config.extra.info.basicUsage }}
!{{ alias }}
+ !{{ alias }}
Additional information
- -
!{{ command.trigger }}
@@ -70,7 +63,7 @@
Command arguments:
-
+
-
{{ renderParameter(param) }}
{{ param.type || 'string' }}
@@ -95,8 +88,8 @@
-
+
Name in config: {{ data.name }}
+
To enable this plugin with default configuration, add {{ data.name }}: {}
to the plugins
list in config
Click to expand
@@ -133,23 +126,27 @@