-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* add addon packets & betterperspective integration * apply reformat of the addon packets * add snapshot disclaimer, update overview
- Loading branch information
1 parent
8258b5b
commit 16edf42
Showing
5 changed files
with
336 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,104 @@ | ||
| The BetterPerspective integration provides the unlock camera permission. | ||
|
|
||
| ## Adding the Dependency | ||
|
|
||
| The BetterPerspective integration is shipped with all official [server platform integration artifacts](/pages/server/#adding-the-labymod-4-server-api-as-a-dependency). If you are using the `core` artifact, you can add the following dependency to your project: | ||
|
|
||
| ???+ danger "Important Note" | ||
|
|
||
| For the examples below, `VERSION` with the version you want to use. The latest version can be found here: <a href="https://github.com/LabyMod/labymod4-server-api-integrations/releases" target="_blank" style="display: inline-flex;-ms-transform: translateY(25%);transform: translateY(25%);"></a> | ||
|
|
||
| === ":octicons-file-code-16: Gradle (Kotlin DSL)" | ||
|
|
||
| ```kotlin | ||
| dependencies { | ||
| compileOnly("net.labymod.serverapi.integration:betterperspective:VERSION") | ||
| } | ||
| ``` | ||
|
|
||
| === ":octicons-file-code-16: Gradle (Groovy)" | ||
|
|
||
| ```groovy | ||
| dependencies { | ||
| compileOnly "net.labymod.serverapi.integration:betterperspective:VERSION" | ||
| } | ||
| ``` | ||
|
|
||
| === ":octicons-file-code-16: Maven" | ||
|
|
||
| ```xml | ||
| <dependencies> | ||
| <dependency> | ||
| <groupId>net.labymod.serverapi.integration</groupId> | ||
| <artifactId>betterperspective</artifactId> | ||
| <version>VERSION</version> | ||
| </dependency> | ||
| </dependencies> | ||
| ``` | ||
|
|
||
| ## Unlock Camera Permission | ||
|
|
||
| While not necessary to use, the integration provides a constant for the unlock camera permission methods to toggle the permission easily. | ||
|
|
||
| ???+ tip "Note" | ||
|
|
||
| The Unlock Camera permission is enabled by default. | ||
|
|
||
| ### Via BetterPerspectivePlayer | ||
|
|
||
| === ":octicons-file-code-16: Disable Unlock Camera" | ||
|
|
||
| ```java | ||
| // Get the LabyModPlayer | ||
| LabyModPlayer labyModPlayer = LabyModProtocolService.get().getPlayer(uniqueId); | ||
|
|
||
| // Get the BetterPerspectivePlayer | ||
| BetterPerspectivePlayer betterPerspectivePlayer = labyModPlayer.getIntegrationPlayer( | ||
| BetterPerspectivePlayer.class | ||
| ); | ||
|
|
||
| // Disable the permission | ||
| betterPerspectivePlayer.denyUnlockCamera(); | ||
| ``` | ||
|
|
||
| === ":octicons-file-code-16: Enable Unlock Camera" | ||
|
|
||
| ```java | ||
| // Get the LabyModPlayer | ||
| LabyModPlayer labyModPlayer = LabyModProtocolService.get().getPlayer(uniqueId); | ||
|
|
||
| // Get the BetterPerspectivePlayer | ||
| BetterPerspectivePlayer betterPerspectivePlayer = labyModPlayer.getIntegrationPlayer( | ||
| BetterPerspectivePlayer.class | ||
| ); | ||
|
|
||
| // Enable the permission | ||
| betterPerspectivePlayer.allowUnlockCamera(); | ||
| ``` | ||
|
|
||
| ### Via the LabyModProtocol | ||
|
|
||
| === ":octicons-file-code-16: Disable Unlock Camera" | ||
|
|
||
| ```java | ||
| // Get the LabyModProtocol | ||
| LabyModProtocol labyModProtocol = LabyModProtocolService.get().labyModProtocol(); | ||
|
|
||
| // Send the packet | ||
| labyModProtocol.sendPacket(uniqueId, new PermissionPacket( | ||
| BetterPerspectiveIntegration.UNLOCK_CAMERA_PERMISSION.deny() | ||
| )); | ||
| ``` | ||
|
|
||
| === ":octicons-file-code-16: Enable Unlock Camera" | ||
|
|
||
| ```java | ||
| // Get the LabyModProtocol | ||
| LabyModProtocol labyModProtocol = LabyModProtocolService.get().labyModProtocol(); | ||
|
|
||
| // Send the packet | ||
| labyModProtocol.sendPacket(uniqueId, new PermissionPacket( | ||
| BetterPerspectiveIntegration.UNLOCK_CAMERA_PERMISSION.allow() | ||
| )); | ||
| ``` | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,95 @@ | ||
| ???+ warning "Only available on Snapshot" | ||
| This feature was added in LabyMod 4.2.33 (currently only available on the snapshot release channel). | ||
|
|
||
| The `AddonDisablePacket` is a client-bound packet that forcefully disables the specified addons for the player. | ||
| Reverting the forced disabled state is also possible via the same packet. | ||
|
|
||
| ???+ warning | ||
| While this should work with all addons that can also be disabled by the user, this cannot be guaranteed. Especially for addons that are not in the addon store. | ||
|
|
||
| ## Disabling Addons | ||
|
|
||
| ???+ danger "Note" | ||
| Some addons also provide special permissions to disable certain features. For user experience sake, please consider disabling these permissions instead of the whole addon (f.e. [BetterPerspective](#)). | ||
|
|
||
| ### Via LabyModPlayer (Recommended) | ||
|
|
||
| ```java | ||
| // Create or get a List of addons to disable | ||
| List<String> addonsToDisable = new ArrayList<>(); | ||
|
|
||
| // Add the namespace of all addons that you want to disable | ||
| addonsToDisable.add("voicechat"); | ||
| addonsToDisable.add("clearwater"); | ||
|
|
||
| // Get the LabyModPlayer | ||
| LabyModPlayer labyModPlayer = LabyModProtocolService.get().getPlayer(uniqueId); | ||
|
|
||
| // Send the addons to disable | ||
| labyModPlayer.disableAddons(addons); | ||
| ``` | ||
|
|
||
| ### Via the LabyModProtocol | ||
|
|
||
| ```java | ||
| // Create or get a List of addons to disable (array is also possible) | ||
| List<String> addonsToDisable = new ArrayList<>(); | ||
|
|
||
| // Add the namespace of all addons that you want to disable | ||
| addonsToDisable.add("voicechat"); | ||
| addonsToDisable.add("clearwater"); | ||
|
|
||
| // Get the LabyModProtocol | ||
| LabyModProtocol labyModProtocol = LabyModProtocolService.get().labyModProtocol(); | ||
|
|
||
| // Send the packet | ||
| labyModProtocol.sendPacket(uniqueId, AddonDisablePacket.disable(addonsToDisable)); | ||
| ``` | ||
|
|
||
| ## Reverting the Disable State | ||
|
|
||
| ### Via LabyModPlayer (Recommended) | ||
|
|
||
| When disabling addons [via LabyModPlayer](#via-labymodplayer-recommended), all disabled addons are stored in the player's object. This allows you to either revert the disable state for all disabled addons or only for specific ones. | ||
|
|
||
| === ":octicons-file-code-16: All Disabled Addons" | ||
|
|
||
| ```java | ||
| // Get the LabyModPlayer | ||
| LabyModPlayer labyModPlayer = LabyModProtocolService.get().getPlayer(uniqueId); | ||
|
|
||
| // Revert the disabled state of all disabled addons | ||
| labyModPlayer.revertDisabledAddons(); | ||
| ``` | ||
|
|
||
| === ":octicons-file-code-16: Specific Addons" | ||
|
|
||
| ```java | ||
| // Create or get a List of addons to enable | ||
| List<String> addonsToRevert = new ArrayList<>(); | ||
|
|
||
| // Add the namespace of all addons that you want to enable | ||
| addonsToRevert.add("voicechat"); | ||
|
|
||
| // Get the LabyModPlayer | ||
| LabyModPlayer labyModPlayer = LabyModProtocolService.get().getPlayer(uniqueId); | ||
|
|
||
| // Send the addons to revert | ||
| labyModPlayer.revertDisabledAddons(addonsToRevert); | ||
| ``` | ||
|
|
||
| ### Via the LabyModProtocol | ||
|
|
||
| ```java | ||
| // Create or get a List of addons to enable (array is also possible) | ||
| List<String> addonsToRevert = new ArrayList<>(); | ||
|
|
||
| // Add the namespace of all addons that you want to enable | ||
| addonsToRevert.add("voicechat"); | ||
|
|
||
| // Get the LabyModProtocol | ||
| LabyModProtocol labyModProtocol = LabyModProtocolService.get().labyModProtocol(); | ||
|
|
||
| // Send the packet | ||
| labyModProtocol.sendPacket(uniqueId, AddonDisablePacket.revert(addonsToRevert)); | ||
| ``` |
132 changes: 132 additions & 0 deletions
132
docs/pages/server/labymod/moderation/installed-addons.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,132 @@ | ||
| ???+ warning "Only available on Snapshot" | ||
| This feature was added in LabyMod 4.2.33 (currently only available on the snapshot release channel). | ||
|
|
||
| There are multiple packets related to the installed addons of your players. But all rely on the client-bound packet | ||
| `InstalledAddonsRequestPacket`. | ||
| The workflow is as follows: | ||
|
|
||
| 1. You send the `InstalledAddonsRequestPacket` to the player containing the addons that you want to request. | ||
| 2. The client responds with the `InstalledAddonsResponsePacket` containing all requested addons that are installed. | ||
| 3. If the enabled state of a requested addon changes (or it was installed), the client will send the | ||
| `AddonStateChangedPacket` to the server. | ||
|
|
||
| ## Get Installed Addons | ||
|
|
||
| `LabyModPlayer#installedAddons` gets an object of the class `InstalledAddonsResponse`, this object is created with the `LabyModPlayer` BUT does not contain any addons until you request them. You can check this by calling `#hasResponse` on the object. | ||
|
|
||
| This object is also used as response when using the `LabyModPlayer#requestInstalledAddons` method (with callback). | ||
|
|
||
| ???+ danger "Important Note" | ||
| Installed addons are not sent to the server by default. You need to request them first, see [Requesting Installed Addons](#requesting-installed-addons). | ||
|
|
||
| The `InstalledAddonsResponse` class contains the following methods: | ||
|
|
||
| - `#hasResponse` - Whether the client has responded with the installed addons. | ||
| - `#hasRequested` - Whether the installed addons were requested | ||
| - `#getRequested` - Gets the requested addons. If `#hasRequested` is true and the list is empty, all addons were requested. | ||
| - `#isInstalled` - Whether the addon is installed | ||
| - `#isEnabled` - Whether the addon is enabled | ||
| - `#isDisabled` - Whether the addon is disabled | ||
| - `#isLocal` - Returns `true` if the addon is installed locally (`false` if it's from the addon store) | ||
| - `#getVersion` - Gets the version of the addon | ||
|
|
||
| ## Requesting Installed Addons | ||
|
|
||
| As mentioned above **ALL** packets related to installed addons **RELY** on this packet and it's contents. The client **DOES NOT** send the installed addons to the server automatically. | ||
|
|
||
| ???+ danger "Important Note" | ||
| Requesting **all** installed addons is not recommended as it can lead to unnecessary traffic and processing. Only request the addons that you really need to know about. | ||
|
|
||
| ### Via LabyModPlayer (Recommended) | ||
|
|
||
| The `LabyModPlayer` object provides the `#installedAddons` method to get the installed addons of the player at any time. Check `InstalledAddonsResponse#hasResponse` before handling it though, to ensure that the data is valid. | ||
|
|
||
| ???+ warning "Note" | ||
| Using the `LabyModPlayer` for this process is recommended as it keeps track of the installed and enabled addons for you. If you're not using the `LabyModPlayer`, you need to keep track of the installed (and enabled/disabled) addons yourself by [handling the server-bound packets](/pages/server/protocols/#registering-handlers). | ||
|
|
||
| === ":octicons-file-code-16: Specific Addons" | ||
|
|
||
| ```java | ||
| // Create or get a List of addons to request | ||
| List<String> addonsToRequest = new ArrayList<>(); | ||
|
|
||
| // Add the namespace of all addons that you want to request | ||
| // Keeping the List empty requests all addons (not recommended) | ||
| addonsToRequest.add("voicechat"); | ||
|
|
||
| // Get the LabyModPlayer | ||
| LabyModPlayer labyModPlayer = LabyModProtocolService.get().getPlayer(uniqueId); | ||
|
|
||
| // Request the installed addons and optionally handle the response | ||
| labyModPlayer.requestInstalledAddons(addonsToRequest, response -> { | ||
| if (response.isEnabled("voicechat")) { | ||
| // VoiceChat is enabled | ||
| } else if (response.isDisabled("voicechat")) { | ||
| // VoiceChat is disabled | ||
| } else { | ||
| // VoiceChat is not installed | ||
| } | ||
| }); | ||
| ``` | ||
|
|
||
| === ":octicons-file-code-16: All Addons (Not Recommended)" | ||
|
|
||
| ```java | ||
| // Get the LabyModPlayer | ||
| LabyModPlayer labyModPlayer = LabyModProtocolService.get().getPlayer(uniqueId); | ||
|
|
||
| // Request all installed addons and optionally handle the response | ||
| labyModPlayer.requestInstalledAddons(response -> { | ||
| List<InstalledAddon> installedAddons = response.getInstalledAddons(); | ||
| // Handle the response | ||
| }); | ||
| ``` | ||
|
|
||
| ### Via the LabyModProtocol | ||
|
|
||
| === ":octicons-file-code-16: #sendPacket(UUID, Packet)" | ||
|
|
||
| ```java | ||
| // Create or get a List of addons to request (array is also possible) | ||
| List<String> addonsToRequest = new ArrayList<>(); | ||
|
|
||
| // Add the namespace of all addons that you want to request | ||
| // Keeping the List empty requests all addons (not recommended) | ||
| addonsToRequest.add("voicechat"); | ||
|
|
||
| // Get the LabyModProtocol | ||
| LabyModProtocol labyModProtocol = LabyModProtocolService.get().labyModProtocol(); | ||
|
|
||
| // Send the packet | ||
| labyModProtocol.sendPacket(uniqueId, new InstalledAddonsRequestPacket(addonsToRequest)); | ||
|
|
||
| // To handle the response, you need to register a PacketHandler for the | ||
| // InstalledAddonsResponsePacket yourself! | ||
| ``` | ||
|
|
||
| === ":octicons-file-code-16: #sendPacket(UUID, IdentifiablePacket, Class, Predicate)" | ||
|
|
||
| ```java | ||
| // Create or get a List of addons to request (array is also possible) | ||
| List<String> addonsToRequest = new ArrayList<>(); | ||
|
|
||
| // Add the namespace of all addons that you want to request | ||
| // Keeping the List empty requests all addons (not recommended) | ||
| addonsToRequest.add("voicechat"); | ||
|
|
||
| // Get the LabyModProtocol | ||
| LabyModProtocol labyModProtocol = LabyModProtocolService.get().labyModProtocol(); | ||
|
|
||
| // Send the packet and handle the response | ||
| labyModProtocol.sendPacket( | ||
| uniqueId, | ||
| new InstalledAddonsRequestPacket(recommendations), | ||
| InstalledAddonsResponsePacket.class, | ||
| response -> { | ||
| List<InstalledAddon> installedAddons = response.getInstalledAddons(); | ||
| // Handle the response | ||
|
|
||
| return false; // return false because no other response is expected | ||
| } | ||
| ); | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters