Update compatibility page and add section to placeholders regarding i…

…ntegrations Supersedes GH-82
DiscordSRV · Feb 23, 2025 · 8eea69e · 8eea69e
1 parent 4050675
commit 8eea69e
Show file tree

Hide file tree

Showing 3 changed files with 55 additions and 12 deletions.
diff --git a/config/sidebars.js b/config/sidebars.js
@@ -148,7 +148,7 @@ const sidebars = {
     'ascension/performance',
     'ascension/security',
     'ascension/placeholders',
-    {
+    /*{
       type: 'category',
       collapsed: false,
       label: 'Troubleshooting',
@@ -169,7 +169,7 @@ const sidebars = {
           label: 'Ask for support'
         },
       ],
-    },
+    },*/
   ],
 
   // But you can create a sidebar manually

diff --git a/docs/ascension/compatibility.mdx b/docs/ascension/compatibility.mdx
@@ -11,25 +11,30 @@ DiscordSRV requires Java 8 or newer
 
 ## Server Software compatibility
 
-| Server software       | Supported versions                                   |
-|-----------------------|------------------------------------------------------|
+| Server software             | Supported versions                                   |
+|-----------------------------|------------------------------------------------------|
 | [Bukkit], [Spigot], [Paper] | ✅ Minecraft 1.8.8 and up<br/>⚠️ Minecraft 1.7.10[^1] |
-| [BungeeCord], [Waterfall] | ✅ Minecraft 1.7.10 and up                            |
-| [Velocity]              | ✅ 3.0.0 and up<br/>❌ 2.0.0 and below                 |
+| [Fabric]                    | ✅ Minecraft 1.21.4 and up                            |
+
+Only testable software listed. BungeeCord & Velocity are planned, but not yet testable.
+{/*
+| [BungeeCord], [Waterfall]   | ✅ Minecraft 1.7.10 and up                            |
+| [Velocity]                  | ✅ 3.0.0 and up                                       |
+*/}
 
 [^1]: Requires [updating ASM](#) <!-- TODO: fix anchor (faq#asm-update) -->
 
-## Plugin integrations and compatibility
+## Plugin/mod integrations and compatibility
 
 <Tabs>
 
-<TabItem value='server' label='Bukkit, Spigot, Paper'>
+<TabItem value='bukkit' label='Bukkit, Spigot, Paper'>
 **Plugin integrations**
 
 | Plugin | Version | Support added by |                                  Note                                  |
 | --- | --- | --- |:----------------------------------------------------------------------:|
 | [LuckPerms] | `5.0+` | DiscordSRV |                                                                        |
-| [PlaceholderAPI] | `2.11.1+` | DiscordSRV |                                                                        |
+| [PlaceholderAPI] | `2.11.1+` | DiscordSRV | [See Placeholders page](placeholders#bukkit-placeholderapi)                                                                       |
 | [Vault] | `1.7+` | DiscordSRV |                                                                        |
 | [Chatty] | `2.19.13+` | DiscordSRV |                                                                        |
 | [GriefPrevention] | `16.18.1+` | DiscordSRV |                    For blocking soft-muted players                     |
@@ -50,6 +55,16 @@ DiscordSRV requires Java 8 or newer
 | ❌ | [NoChatReports]                   | Cancels all chat events |
 </TabItem>
 
+<TabItem value='fabric' label='Fabric'>
+**Mod integrations**
+
+| Plugin | Support added by | Version | Note |
+|---|---|---|---|
+| [LuckPerms] | DiscordSRV | `5.0+` | |
+| [Text Placeholder API] | DiscordSRV | `2.5.0+` | [See Placeholder page](placeholders#fabric-text-placeholder-api) |
+</TabItem>
+
+{/*
 <TabItem value='bungee' label='BungeeCord, Waterfall'>
 **Plugin integrations**
 
@@ -65,12 +80,14 @@ DiscordSRV requires Java 8 or newer
 |---|---|---|
 | [LuckPerms] | DiscordSRV | `5.0+` |
 </TabItem>
+*/}
 
 </Tabs>
 
 [Bukkit]: https://dev.bukkit.org/
 [Spigot]: https://www.spigotmc.org/
 [Paper]: https://papermc.io/
+[Fabric]: https://fabricmc.net/
 [BungeeCord]: https://github.com/SpigotMC/BungeeCord/
 [Waterfall]: https://github.com/PaperMC/Waterfall/
 [Velocity]: https://github.com/PaperMC/Velocity/
@@ -90,3 +107,4 @@ DiscordSRV requires Java 8 or newer
 [FreedomChat]: https://modrinth.com/plugin/freedomchat/
 [AntiPopup]: https://modrinth.com/plugin/antipopup/
 [NoChatReports]: https://www.spigotmc.org/resources/102931/
+[Text Placeholder API]: https://modrinth.com/mod/placeholder-api
diff --git a/docs/ascension/placeholders.md b/docs/ascension/placeholders.md
@@ -201,10 +201,10 @@ Example usages: `%player_skin_texture_id%`, `%player_skin_model%`
 #### `%player_avatar_url%`
 The avatar url of the Minecraft player (the API used for this can be changed in the config (`avatar-provider.avatar-url-template`))
 
-### `%player_prefix%`
+#### `%player_prefix%`
 Equivalent of `%player_meta_prefix|player_permission_prefix%`
 
-### `%player_suffix%`
+#### `%player_suffix%`
 Equivalent of `%player_meta_suffix|player_permission_suffix%`
 
 #### `%player_meta_prefix%`
@@ -334,4 +334,29 @@ Example usages: `%log_time:'timestamp'%` or `%log_time:'timestamp:t'%`
 
 [Source](https://discord.com/developers/docs/reference#message-formatting-timestamp-styles)
 
-[LuckPerms meta]: https://luckperms.net/wiki/Prefixes,-Suffixes-&-Meta#meta/
+## Integrations
+
+### Bukkit: PlaceholderAPI
+
+#### Using DiscordSRV placeholders in other plugins
+
+You can use DiscordSRV's global and Player related placeholders (when a Player is provided) by prefixing the placeholder with `discordsrv_`, for example `%discordsrv_discord_invite%`
+
+#### Using placeholders in DiscordSRV
+
+List of [PlaceholderAPI placeholders], please note many of these require the respective [expansion to be installed before they can be used](https://wiki.placeholderapi.com/users/using-placeholders/#downloadget-expansion).
+
+You can use PlaceholderAPI placeholders directly in DiscordSRV or by explicitly prefixing the placeholder with `placeholderapi_`, for example:
+```
+%server_online%
+%placeholderapi_server_online%
+```
+
+### Fabric: Text Placeholder API
+
+#### Using placeholders in DiscordSRV
+
+You can use Text Placeholder API placeholders directly in DiscordSRV or by explicitly prefixing the placeholder with `textplaceholders_`
+
+[LuckPerms meta]: https://luckperms.net/wiki/Prefixes,-Suffixes-&-Meta#meta/
+[PlaceholderAPI placeholders]: https://wiki.placeholderapi.com/users/placeholder-list/