docs: Update docs to detail join and quit messages

WiIIiam278 · Oct 17, 2023 · 7e04a37 · 7e04a37
1 parent 7f7bc93
commit 7e04a37
Show file tree

Hide file tree

Showing 5 changed files with 46 additions and 2 deletions.
diff --git a/docs/Config-Files.md b/docs/Config-Files.md
@@ -212,6 +212,19 @@ message_replacers:
       ':-(': '☹'
       ':fire:': '🔥'
 
+
+# Options for customizing player join and quit messages
+join_and_quit_messages:
+  join:
+    enabled: false
+    # Use the huskchat.join.[text] permission to override this per-group if needed
+    format: '&e%name% joined the network'
+  quit:
+    enabled: false
+    # Use the huskchat.quit.[text] permission to override this per-group if needed
+    format: '&e%name% left the network'
+  broadcast_scope: GLOBAL # Note that on Velocity/Bungee, PASSTHROUGH modes won't cancel local join/quit messages
+
 # Discord webhook options, which lets you send messages to a Discord channel
 discord:
   enabled: false

diff --git a/docs/Home.md b/docs/Home.md
@@ -13,6 +13,7 @@ Welcome! This is the plugin documentation for HuskChat&mdash;the no-frills chat
 * 🤫 [[Filters and Replacers]]
 * 🔎 [[Social and Local Spy]]
 * ⚙️ [[Backend Chat Entry]]
+* 📜 [[Join and Quit Messages]]
 * 🔵 [[Discord Hook]]
 
 ## Links

diff --git a/docs/Join-and-Quit-Messages.md b/docs/Join-and-Quit-Messages.md
@@ -0,0 +1,27 @@
+HuskChat supports displaying special **join and quit messages** whenever a player joins/leaves your network (or single-server setup when installing the plugin standalone).
+
+## Usage
+To enable this feature, set `join_and_quit_messages.join.enabled` and/or `join_and_quit_messages.quit.enabled` to `true` in your `config.yml` file. You can then modify the `format` of either, which accepts placeholders and standard MineDown formatting.
+
+### Broadcast scopes
+You can set the `broadcast_scope` of join and quit messages in a similar fashion to how you can do this for [[Channels]]. See [Broadcast Scopes](channels#channel-scope) for more details on the available scopes.
+
+Note that global, local and regular PASSTHROUGH scopes are only effective when running the plugin on a standalone Spigot/Paper server; when running HuskChat on a proxy (Velocity/Bungee) server, the _regular join/leave message won't be cancelled_. This is because the join/leave message is handled on the backend.
+
+<details>
+<summary>Example config.yml</summary>
+
+```yaml
+# Options for customizing player join and quit messages
+join_and_quit_messages:
+  join:
+    enabled: false
+    # Use the huskchat.join.[text] permission to override this per-group if needed
+    format: '&e%name% joined the network'
+  quit:
+    enabled: false
+    # Use the huskchat.quit.[text] permission to override this per-group if needed
+    format: '&e%name% left the network'
+  broadcast_scope: GLOBAL # Note that on Velocity/Bungee, PASSTHROUGH modes won't cancel local join/quit messages
+```
+</details>
diff --git a/docs/Setup.md b/docs/Setup.md
@@ -15,8 +15,10 @@ This will walk you through installing HuskChat on your Velocity or BungeeCord/Wa
 ### Velocity Installation
 1. Turn off your Velocity proxy
 2. Download the [latest version of HuskChat](https://github.com/WiIIiam278/HuskChat/releases/latest). 
-3. Download both the latest version of [UnsignedVelocity](https://modrinth.com/plugin/unsignedvelocity) and [VPacketEvents](https://modrinth.com/plugin/vpacketevents/)
-4. Add all three jar files to your Velocity proxy server's `~/plugins` folder
+3. Download the [latest version of SignedVelocity](https://modrinth.com/plugin/unsignedvelocity) for Velocity
+4. Add both jar files to your Velocity proxy server's `~/plugins` folder. 
+   1. Additionally, download [SignedVelocity](https://modrinth.com/plugin/unsignedvelocity) for your backend server add the plugin to your `/plugins/~` folders there. Restart your backend servers.
+   2. You may alternatively use UnsignedVelocity and VPacketEvents, which only need installing on your proxy if you are using Fabric for your backend servers.
 5. Start your Velocity proxy. Let HuskChat generate its config files, then stop the proxy again.
 6. Modify your HuskChat config files as needed, then start your Velocity proxy again.
 

diff --git a/docs/_Sidebar.md b/docs/_Sidebar.md
@@ -10,6 +10,7 @@
 * 🤫 [[Filters and Replacers]]
 * 🔎 [[Social and Local Spy]]
 * ⚙️ [[Backend Chat Entry]]
+* 📜 [[Join and Quit Messages]]
 * 🔵 [[Discord Hook]]
 
 ## Links