Fix default messages

SrBedrock · Jun 21, 2023 · c560e18 · c560e18
1 parent 5ca4d1f
commit c560e18
Show file tree

Hide file tree

Showing 2 changed files with 101 additions and 28 deletions.
diff --git a/README.md b/README.md
@@ -4,38 +4,111 @@
 
 This plugin allows you to control which plugins have to be enabled for the server continues running.
 
-Inspired by [this](https:/PaperMC/Paper/issues/8859#issuecomment-1435905791) and [this](https:/PaperMC/Paper/pull/8108#issuecomment-1419304955) comment and myself having the same problem.
+Inspired by [this](https:/PaperMC/Paper/issues/8859#issuecomment-1435905791)
+and [this](https:/PaperMC/Paper/pull/8108#issuecomment-1419304955) comment and myself having the same
+problem.
 
 ## Installation
 
-1. Download the plugin from [here](https:/SrBedrock/PluginControl/releases/).
-2. Put the plugin in the `plugins` folder of your server.
-3. Restart the server.
-4. Add plugins to the list with `/plugincontrol add <plugin>`.
-5. Enable the plugin with `/plugincontrol enable`.
+1. Download the PluginControl plugin from [here](https:/SrBedrock/PluginControl/releases/).
+2. Place the downloaded plugin file in the `plugins` folder of your server.
+3. Restart the server to load the PluginControl plugin.
+4. Use the command `/plugincontrol action <action-type>` to set the action to be taken if any of the listed plugins are not
+ enabled. See the [Actions](#actions) section for available actions.
+5. Add plugins to the list using the command `/plugincontrol add <plugin-name>`.
+6. Enable the PluginControl plugin by running the command `/plugincontrol enable`.
+7. Reload the PluginControl plugin configuration and language files with the command `/plugincontrol reload`.
+
+Please note that the `<action-type>` and `<plugin-name>` placeholders should be replaced with the specific action and plugin
+names as needed.
 
 ## Configuration
 
-| Option | Description |
-|-----------|-------------------------------------------------------|
-| `enabled` | Whether the plugin is enabled or not. |
-| `plugins` | List of plugins to be enabled when the server starts. |
+| Option | Description |
+|----------------|--------------------------------------------------------------------------------|
+| `enabled` | Whether the plugin is enabled or not. |
+| `action` | [Action to take if all listed plugins are not enabled.](#actions) |
+| `kick-message` | Message sent to the player when the `disallow-player-login` action is enabled. | 
+| `plugins` | List of plugins to be enabled when the server starts. |
+
+### Actions
+
+| Action Type | Description |
+|-------------------------|---------------------------------------------------------------------------------------|
+| `log-to-console` | Sends a warning (`log-to-console` inside lang.yaml) in the console. |
+| `disallow-player-login` | Block player from enter the server with a message (`kick-message` inside config.yml). |
+| `shutdown-server` | Shutdown the server with a warning (`disabling-server` inside lang.yml). |
+
+## Messages
+
+Change the message formatting using [MiniMessage](https://webui.advntr.dev/)
+
+### Placeholders
+
+| Placeholder | Usage |
+|------------------|-----------------------------------------------------------------------------------------------------------|
+| `<prefix>` | Plugin prefix - all messages accept this placeholder |
+| `<action>` | Plugin action used in `command.action-type` |
+| `<actions>` | List of actions used in `command.action-list` |
+| `<command>` | Command used in `command.command-not-found`, `command.plugin-add-error` and `command.plugin-remove-error` |
+| `<kick-message>` | Kick message used in `command.kick-message` and `command.kick-message-set` |
+| `<plugin>` | Plugin name used in `command.plugin-added`, `command.plugin-not-found` and `command.plugin-removed` |
+| `<plugins>` | List of plugins used in `console.disabling-server` and `command.plugin-list` |
+
+### Default
+
+```yaml
+prefix: '<dark_gray>[<red>PluginControl<dark_gray>]'
+console:
+ checking-plugins: '<prefix> <red>Checking plugins...'
+ disabling-server: '<prefix> <red>Disabling server because <yellow><plugins> <red>was not found or enabled successfully!'
+ finished-checking: '<prefix> <green>Plugins successfully verified!'
+ log-to-console: '<prefix> <red>Plugin <yellow><plugins> <red>not found or enabled successfully...'
+command:
+ action-list: '<prefix> <green>Actions available: <yellow><actions>'
+ action-set: '<prefix> <green>Action set to <yellow><action> <green>!'
+ action-type: '<prefix> <green>Action type: <yellow><action> <green>!'
+ command-not-found: '<red>Usage: <yellow>/<command> <add|remove [plugin-name]> | <toggle|on|off|list|reload>'
+ kick-message: '<prefix> <green>Kick message: <yellow><kick-message>'
+ kick-message-set: '<prefix> <green>Kick message set to <yellow><kick-message> <green>!'
+ no-permission-error: '<prefix> <red>You do not have permission to use this command'
+ plugin-add-error: '<red>Usage: <yellow>/<command> add [plugin-name]'
+ plugin-added: '<prefix> <green>Plugin <yellow><plugin> <green>added successfully!'
+ plugin-already-added: '<prefix> <red>Plugin already added!'
+ plugin-disabled: '<prefix> <red>Deactivating plugin features...'
+ plugin-enabled: '<prefix> <green>Activating plugin features...'
+ plugin-list: '<prefix> <green>Plugins added: <yellow><plugins>'
+ plugin-list-empty: '<prefix> <red>No plugins added!'
+ plugin-not-found: '<prefix> <red>Plugin <yellow><plugin> <red>not found in the list!'
+ plugin-reload: '<prefix> <green>Config and Language reloaded!'
+ plugin-remove-error: '<red>Usage: <yellow>/<command> remove <plugin-name>'
+ plugin-removed: '<prefix> <green>Plugin <yellow><plugin> <green>removed!'
+```
 
 ## Commands
 
-Main command aliases: `/pc` and `/pcontrol`.
+Main Command `/plugincontrol` - Aliases: `/pc` and `/pcontrol`
+
+| Command | Sub Command | Description |
+|------------------|--------------------------|----------------------------------------------|
+| `/plugincontrol` | `add <plugin-name>` | Add a plugin to the list. |
+| `/plugincontrol` | `remove <plugin-name>` | Remove a plugin from the list. |
+| `/plugincontrol` | `action` | Check the current action. |
+| `/plugincontrol` | `action <action-type>` | [Set the action to take.](#actions) |
+| `/plugincontrol` | `kick-message` | Check the current kick message. |
+| `/plugincontrol` | `kick-message <message>` | Set the kick message. |
+| `/plugincontrol` | `enable \| on` | Enable PluginControl. |
+| `/plugincontrol` | `disable \| off` | Disable PluginControl. |
+| `/plugincontrol` | `toggle` | Toggle PluginControl on or off. |
+| `/plugincontrol` | `list` | List all plugins in the list. |
+| `/plugincontrol` | `reload` | Reload the configuration and language files. |
 
-| Command | Sub Command | Description |
-|-------------------|-------------------|----------------------------------|
-| `/plugincontrol` | `add <plugin>` | Add a plugin to the list. |
-| `/plugincontrol` | `remove <plugin>` | Remove a plugin from the list. |
-| `/plugincontrol` | `enable \| on` | Enable PluginControl. |
-| `/plugincontrol` | `disable \| off` | Disable PluginControl. |
-| `/plugincontrol` | `toggle` | Enable or disable PluginControl. |
-| `/plugincontrol` | `list` | List all plugins in the list. |
+Please note that the `<plugin-name>`, `<action-type>` and `<message>` placeholders should be replaced with the specific
+plugin name and kick message, respectively, as required.
 
 ## Permissions
 
-| Permissions | Description |
-|----------------------|---------------------------------------------|
-| `plugincontrol.use` | Permission to use all [commands](#commands) |
+| Permissions | Description |
+|------------------------|------------------------------------------------|
+| `plugincontrol.use` | Permission to use all [commands](#commands) |
+| `plugincontrol.bypass` | Bypass the `disallow-player-login` in `action` |
diff --git a/src/main/resources/lang.yml b/src/main/resources/lang.yml
@@ -1,18 +1,18 @@
 prefix: '<dark_gray>[<red>PluginControl<dark_gray>]'
 console:
  checking-plugins: '<prefix> <red>Checking plugins...'
- disabling-server: '<prefix> <red>Disabling server because <yellow><plugins> <red>was not found or enabled successful!'
+ disabling-server: '<prefix> <red>Disabling server because <yellow><plugins> <red>was not found or enabled successfully!'
  finished-checking: '<prefix> <green>Plugins successfully verified!'
- log-to-console: '<prefix> <red>Plugin <yellow><plugins> <red>not found or enabled successful...'
+ log-to-console: '<prefix> <red>Plugin <yellow><plugins> <red>not found or enabled successfully...'
 command:
  action-list: '<prefix> <green>Actions available: <yellow><actions>'
  action-set: '<prefix> <green>Action set to <yellow><action> <green>!'
  action-type: '<prefix> <green>Action type: <yellow><action> <green>!'
- command-not-found: '<red>Use <yellow>/<command> <add|remove [plugin-name]> | <toggle|on|off|list|reload>'
+ command-not-found: '<red>Usage: <yellow>/<command> <add|remove [plugin-name]> | <toggle|on|off|list|reload>'
  kick-message: '<prefix> <green>Kick message: <yellow><kick-message>'
  kick-message-set: '<prefix> <green>Kick message set to <yellow><kick-message> <green>!'
  no-permission-error: '<prefix> <red>You do not have permission to use this command'
- plugin-add-error: '<red>Use <yellow>/<command> add [plugin-name]'
+ plugin-add-error: '<red>Usage: <yellow>/<command> add [plugin-name]'
  plugin-added: '<prefix> <green>Plugin <yellow><plugin> <green>added successfully!'
  plugin-already-added: '<prefix> <red>Plugin already added!'
  plugin-disabled: '<prefix> <red>Deactivating plugin features...'
@@ -21,5 +21,5 @@ command:
  plugin-list-empty: '<prefix> <red>No plugins added!'
  plugin-not-found: '<prefix> <red>Plugin <yellow><plugin> <red>not found in the list!'
  plugin-reload: '<prefix> <green>Config and Language reloaded!'
- plugin-remove-error: '<red>Use <yellow>/<command> remove <plugin-name>'
- plugin-removed: '<prefix> <green>Plugin <yellow><plugin> <green>removed!'
+ plugin-remove-error: '<red>Usage: <yellow>/<command> remove <plugin-name>'
+ plugin-removed: '<prefix> <green>Plugin <yellow><plugin> <green>removed!'