diff --git a/api/src/main/java/com/lunarclient/apollo/ApolloPlatform.java b/api/src/main/java/com/lunarclient/apollo/ApolloPlatform.java index f63d6cf4..4679d873 100644 --- a/api/src/main/java/com/lunarclient/apollo/ApolloPlatform.java +++ b/api/src/main/java/com/lunarclient/apollo/ApolloPlatform.java @@ -25,6 +25,7 @@ import com.lunarclient.apollo.option.Options; import com.lunarclient.apollo.stats.ApolloStats; +import java.util.concurrent.TimeUnit; import java.util.logging.Logger; import org.jetbrains.annotations.ApiStatus; @@ -92,6 +93,14 @@ public interface ApolloPlatform { */ Object getPlugin(); + /** + * Returns the platform {@link Scheduler}. + * + * @return the platform scheduler + * @since 1.2.9 + */ + Scheduler getScheduler(); + /** * Represents the kind of server a platform is. * @@ -115,4 +124,26 @@ enum Platform { VELOCITY } + /** + * Represents the platform scheduler, running tasks through the + * platform plugin's own scheduler. + * + * @since 1.2.9 + */ + interface Scheduler { + + /** + * Schedules a task to run asynchronously every period, first running + * after the given delay. + * + * @param task the task to run + * @param delay the delay before the first run + * @param period the period between runs + * @param unit the unit of the delay and period + * @since 1.2.9 + */ + void scheduleAsyncRepeating(Runnable task, long delay, long period, TimeUnit unit); + + } + } diff --git a/api/src/main/java/com/lunarclient/apollo/common/button/ApolloButton.java b/api/src/main/java/com/lunarclient/apollo/common/button/ApolloButton.java new file mode 100644 index 00000000..3dbe830e --- /dev/null +++ b/api/src/main/java/com/lunarclient/apollo/common/button/ApolloButton.java @@ -0,0 +1,169 @@ +/* + * This file is part of Apollo, licensed under the MIT License. + * + * Copyright (c) 2026 Moonsworth + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +package com.lunarclient.apollo.common.button; + +import com.lunarclient.apollo.common.button.action.ApolloButtonAction; +import com.lunarclient.apollo.common.button.action.ApolloButtonClientAction; +import com.lunarclient.apollo.common.button.content.ApolloButtonContent; +import com.lunarclient.apollo.common.location.HudPosition; +import java.awt.Color; +import lombok.Builder; +import lombok.Getter; +import lombok.experimental.SuperBuilder; +import org.jetbrains.annotations.ApiStatus; +import org.jetbrains.annotations.NotNull; +import org.jetbrains.annotations.Nullable; + +/** + * Represents a button which can be shown on the client. + * + * @since 1.2.9 + */ +@Getter +@SuperBuilder(toBuilder = true) +@ApiStatus.NonExtendable +public abstract class ApolloButton { + + /** + * Returns the button {@link String} id. + * + *

Displaying another button with the same id replaces the + * previous one.

+ * + * @return the button id + * @since 1.2.9 + */ + @NotNull String id; + + /** + * Returns the {@link HudPosition} of this button, relative to the + * top-left corner of the container it is placed in. + * + *

The button must fit inside the container: {@code 0 <= x}, + * {@code 0 <= y}, {@code x + width <= container width} and + * {@code y + height <= container height}. See the surface type for + * its container dimensions (e.g. {@code InventoryButton#BOX_WIDTH}).

+ * + * @return the button position + * @since 1.2.9 + */ + @NotNull HudPosition position; + + /** + * Returns the {@link ApolloButtonSize} of this button. + * + *

Use one of the surface's suggested sizes (e.g. + * {@code InventoryButton.SIZE_MEDIUM}) or a fully custom + * {@link ApolloButtonSize#of(float, float)}.

+ * + * @return the button size + * @since 1.2.9 + */ + @NotNull ApolloButtonSize size; + + /** + * Returns the {@link ApolloButtonShape} of this button. + * + * @return the button shape + * @since 1.2.9 + */ + @NotNull ApolloButtonShape shape; + + /** + * Returns the {@link ApolloButtonContent} rendered inside this button. + * + *

Built via {@code ApolloButtonContent.builder()}, appending static + * components, icons or live per-player parts that are re-resolved + * whenever the content is sent (see the owning module's live button + * broadcast option, e.g. {@code InventoryModule#BROADCAST_LIVE_BUTTONS}).

+ * + * @return the button content + * @since 1.2.9 + */ + @NotNull ApolloButtonContent content; + + /** + * Returns the {@link ApolloButtonTooltip} shown while this button is hovered. + * + *

Built via {@code ApolloButtonTooltip.of(...)} for static lines, + * or {@code ApolloButtonTooltip.live(...)} for per-player lines that + * are re-resolved whenever the button content is sent (see the owning + * module's live button broadcast option, e.g. + * {@code InventoryModule#BROADCAST_LIVE_BUTTONS}).

+ * + * @return the tooltip, or {@code null} for no tooltip + * @since 1.2.9 + */ + @Builder.Default + @Nullable ApolloButtonTooltip tooltip = null; + + /** + * Returns the {@link ApolloButtonAction} executed when this button + * is clicked. + * + *

Built via {@link ApolloButtonAction#runCommand(String)}, + * {@link ApolloButtonAction#openUrl(String)} or + * {@link ApolloButtonAction#clientAction(ApolloButtonClientAction)}.

+ * + * @return the click action, or {@code null} + * @since 1.2.9 + */ + @Builder.Default + @Nullable ApolloButtonAction onClick = null; + + /** + * Returns the background {@link Color} used while this button is hovered. + * + * @return the hovered background color, or {@code null} + * @since 1.2.9 + */ + @Builder.Default + @Nullable Color hoveredBackgroundColor = null; + + /** + * Returns the border {@link Color} used while this button is hovered. + * + * @return the hovered border color, or {@code null} + * @since 1.2.9 + */ + @Builder.Default + @Nullable Color hoveredBorderColor = null; + + /** + * Returns the background {@link Color} of this button. + * + * @return the background color + * @since 1.2.9 + */ + public abstract Color getBackgroundColor(); + + /** + * Returns the border {@link Color} of this button. + * + * @return the border color + * @since 1.2.9 + */ + public abstract Color getBorderColor(); + +} diff --git a/api/src/main/java/com/lunarclient/apollo/common/button/ApolloButtonShape.java b/api/src/main/java/com/lunarclient/apollo/common/button/ApolloButtonShape.java new file mode 100644 index 00000000..6ba14b6a --- /dev/null +++ b/api/src/main/java/com/lunarclient/apollo/common/button/ApolloButtonShape.java @@ -0,0 +1,35 @@ +/* + * This file is part of Apollo, licensed under the MIT License. + * + * Copyright (c) 2026 Moonsworth + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +package com.lunarclient.apollo.common.button; + +/** + * Represents the shape of a button. + * + * @since 1.2.9 + */ +public enum ApolloButtonShape { + ROUNDED_SQUARE, + CIRCLE + +} diff --git a/api/src/main/java/com/lunarclient/apollo/common/button/ApolloButtonSize.java b/api/src/main/java/com/lunarclient/apollo/common/button/ApolloButtonSize.java new file mode 100644 index 00000000..6ed3d954 --- /dev/null +++ b/api/src/main/java/com/lunarclient/apollo/common/button/ApolloButtonSize.java @@ -0,0 +1,86 @@ +/* + * This file is part of Apollo, licensed under the MIT License. + * + * Copyright (c) 2026 Moonsworth + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +package com.lunarclient.apollo.common.button; + +import lombok.AccessLevel; +import lombok.Getter; +import lombok.RequiredArgsConstructor; + +/** + * Represents the size of an {@link ApolloButton}, in GUI-scaled pixels. + * + *

Surface types ship suggested sizes tuned to their container + * dimensions (e.g. {@code InventoryButton.SIZE_MEDIUM}); use + * {@link #of(float, float)} for a fully custom size.

+ * + * @since 1.2.9 + */ +@Getter +@RequiredArgsConstructor(access = AccessLevel.PRIVATE) +public final class ApolloButtonSize { + + /** + * Creates a new {@link ApolloButtonSize} with the given dimensions. + * + * @param width the button width, must be finite and greater than 0 + * @param height the button height, must be finite and greater than 0 + * @return the button size + * @since 1.2.9 + */ + public static ApolloButtonSize of(float width, float height) { + if (!(width > 0.0F) || !(height > 0.0F) || !Float.isFinite(width) || !Float.isFinite(height)) { + throw new IllegalArgumentException("ApolloButtonSize dimensions must be finite and greater than 0"); + } + + return new ApolloButtonSize(width, height); + } + + /** + * Creates a new square {@link ApolloButtonSize}. + * + * @param size the button width and height, must be finite and greater than 0 + * @return the button size + * @since 1.2.9 + */ + public static ApolloButtonSize of(float size) { + return of(size, size); + } + + /** + * Returns the {@code float} button width. + * + * @return the button width + * @since 1.2.9 + */ + private final float width; + + /** + * Returns the {@code float} button height. + * + * @return the button height + * @since 1.2.9 + */ + private final float height; + +} diff --git a/api/src/main/java/com/lunarclient/apollo/common/button/ApolloButtonTooltip.java b/api/src/main/java/com/lunarclient/apollo/common/button/ApolloButtonTooltip.java new file mode 100644 index 00000000..4f5fb3a3 --- /dev/null +++ b/api/src/main/java/com/lunarclient/apollo/common/button/ApolloButtonTooltip.java @@ -0,0 +1,151 @@ +/* + * This file is part of Apollo, licensed under the MIT License. + * + * Copyright (c) 2026 Moonsworth + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +package com.lunarclient.apollo.common.button; + +import com.lunarclient.apollo.player.ApolloPlayer; +import java.time.Duration; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.Collections; +import java.util.List; +import java.util.function.Function; +import lombok.Getter; +import lombok.NonNull; +import net.kyori.adventure.text.Component; +import org.jetbrains.annotations.Nullable; + +/** + * Represents the tooltip of an {@link ApolloButton}, either a static + * list of lines or a live per-player resolver. + * + * @since 1.2.9 + */ +@Getter +public final class ApolloButtonTooltip { + + /** + * The maximum number of tooltip lines. + * + * @since 1.2.9 + */ + public static final int MAX_LINES = 100; + + /** + * Creates a static tooltip from the given lines. + * + * @param lines the tooltip lines + * @return the tooltip + * @since 1.2.9 + */ + public static ApolloButtonTooltip of(@NonNull Component... lines) { + return of(Arrays.asList(lines)); + } + + /** + * Creates a static tooltip from the given lines. + * + * @param lines the tooltip lines + * @return the tooltip + * @since 1.2.9 + */ + public static ApolloButtonTooltip of(@NonNull List lines) { + if (lines.size() > MAX_LINES) { + throw new IllegalArgumentException("ApolloButtonTooltip supports at most " + MAX_LINES + " lines"); + } + + for (Component line : lines) { + if (line == null) { + throw new IllegalArgumentException("ApolloButtonTooltip lines must not contain null"); + } + } + + return new ApolloButtonTooltip(lines, null, null); + } + + /** + * Creates a live tooltip, resolved into lines for each viewing + * {@link ApolloPlayer} and refreshed at the given interval. + * + *

The interval must be positive and is quantized to server ticks + * (50ms); anything below one tick refreshes every tick.

+ * + * @param resolver the per-player tooltip resolver + * @param updateInterval the refresh interval + * @return the tooltip + * @since 1.2.9 + */ + public static ApolloButtonTooltip live(@NonNull Function> resolver, + @NonNull Duration updateInterval) { + if (updateInterval.isNegative() || updateInterval.isZero()) { + throw new IllegalArgumentException("ApolloButtonTooltip#updateInterval must be positive"); + } + + return new ApolloButtonTooltip(null, resolver, updateInterval); + } + + /** + * Returns the static tooltip lines, or {@code null} if this tooltip is live. + * + * @return the tooltip lines, or {@code null} + * @since 1.2.9 + */ + private final @Nullable List lines; + + /** + * Returns the per-player live tooltip resolver, or {@code null} if this + * tooltip is static. + * + * @return the live tooltip resolver, or {@code null} + * @since 1.2.9 + */ + private final @Nullable Function> resolver; + + /** + * Returns the refresh interval of a live tooltip, or {@code null} if + * this tooltip is static. + * + * @return the update interval, or {@code null} + * @since 1.2.9 + */ + private final @Nullable Duration updateInterval; + + private ApolloButtonTooltip(@Nullable List lines, + @Nullable Function> resolver, + @Nullable Duration updateInterval) { + this.lines = lines == null ? null : Collections.unmodifiableList(new ArrayList<>(lines)); + this.resolver = resolver; + this.updateInterval = updateInterval; + } + + /** + * Returns whether this tooltip is live. + * + * @return whether this tooltip is live + * @since 1.2.9 + */ + public boolean isLive() { + return this.resolver != null; + } + +} diff --git a/api/src/main/java/com/lunarclient/apollo/common/button/action/ApolloButtonAction.java b/api/src/main/java/com/lunarclient/apollo/common/button/action/ApolloButtonAction.java new file mode 100644 index 00000000..1ec44ac0 --- /dev/null +++ b/api/src/main/java/com/lunarclient/apollo/common/button/action/ApolloButtonAction.java @@ -0,0 +1,81 @@ +/* + * This file is part of Apollo, licensed under the MIT License. + * + * Copyright (c) 2026 Moonsworth + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +package com.lunarclient.apollo.common.button.action; + +import com.lunarclient.apollo.common.button.ApolloButton; +import lombok.AccessLevel; +import lombok.NoArgsConstructor; +import lombok.NonNull; +import org.jetbrains.annotations.ApiStatus; + +/** + * The abstract base class for the action executed when an + * {@link ApolloButton} is clicked. + * + *

Each action is one of {@link RunCommandAction}, {@link OpenUrlAction} + * or {@link ClientAction}.

+ * + * @since 1.2.9 + */ +@NoArgsConstructor(access = AccessLevel.PACKAGE) +@ApiStatus.NonExtendable +public abstract class ApolloButtonAction { + + /** + * Creates an action that runs the given command as the player. + * + *

Must start with {@code /}.

+ * + * @param command the command to run + * @return the run command action + * @since 1.2.9 + */ + public static RunCommandAction runCommand(@NonNull String command) { + return new RunCommandAction(command); + } + + /** + * Creates an action that opens the given URL. + * + * @param url the url to open + * @return the open url action + * @since 1.2.9 + */ + public static OpenUrlAction openUrl(@NonNull String url) { + return new OpenUrlAction(url); + } + + /** + * Creates an action that executes a built-in + * {@link ApolloButtonClientAction}. + * + * @param action the client action to execute + * @return the client action + * @since 1.2.9 + */ + public static ClientAction clientAction(@NonNull ApolloButtonClientAction action) { + return new ClientAction(action); + } + +} diff --git a/api/src/main/java/com/lunarclient/apollo/common/button/action/ApolloButtonClientAction.java b/api/src/main/java/com/lunarclient/apollo/common/button/action/ApolloButtonClientAction.java new file mode 100644 index 00000000..76d8c57c --- /dev/null +++ b/api/src/main/java/com/lunarclient/apollo/common/button/action/ApolloButtonClientAction.java @@ -0,0 +1,49 @@ +/* + * This file is part of Apollo, licensed under the MIT License. + * + * Copyright (c) 2026 Moonsworth + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +package com.lunarclient.apollo.common.button.action; + +/** + * Represents a built-in client action executed when a button is clicked. + * + * @since 1.2.9 + */ +public enum ApolloButtonClientAction { + + /** + * Opens the fullscreen minimap view. + * + *

Does nothing when the player has the MiniMap mod disabled.

+ * + * @since 1.2.9 + */ + OPEN_MINIMAP_VIEW, + + /** + * Opens the waypoints menu. + * + * @since 1.2.9 + */ + OPEN_WAYPOINTS_MENU + +} diff --git a/api/src/main/java/com/lunarclient/apollo/common/button/action/ClientAction.java b/api/src/main/java/com/lunarclient/apollo/common/button/action/ClientAction.java new file mode 100644 index 00000000..c9049773 --- /dev/null +++ b/api/src/main/java/com/lunarclient/apollo/common/button/action/ClientAction.java @@ -0,0 +1,49 @@ +/* + * This file is part of Apollo, licensed under the MIT License. + * + * Copyright (c) 2026 Moonsworth + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +package com.lunarclient.apollo.common.button.action; + +import lombok.AccessLevel; +import lombok.Getter; +import lombok.RequiredArgsConstructor; + +/** + * Represents a button action that executes a built-in + * {@link ApolloButtonClientAction}. + * + * @since 1.2.9 + */ +@Getter +@RequiredArgsConstructor(access = AccessLevel.PACKAGE) +public final class ClientAction extends ApolloButtonAction { + + /** + * Returns the built-in client action executed when the button + * is clicked. + * + * @return the client action + * @since 1.2.9 + */ + private final ApolloButtonClientAction action; + +} diff --git a/api/src/main/java/com/lunarclient/apollo/common/button/action/OpenUrlAction.java b/api/src/main/java/com/lunarclient/apollo/common/button/action/OpenUrlAction.java new file mode 100644 index 00000000..d28e1d83 --- /dev/null +++ b/api/src/main/java/com/lunarclient/apollo/common/button/action/OpenUrlAction.java @@ -0,0 +1,47 @@ +/* + * This file is part of Apollo, licensed under the MIT License. + * + * Copyright (c) 2026 Moonsworth + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +package com.lunarclient.apollo.common.button.action; + +import lombok.AccessLevel; +import lombok.Getter; +import lombok.RequiredArgsConstructor; + +/** + * Represents a button action that opens a URL. + * + * @since 1.2.9 + */ +@Getter +@RequiredArgsConstructor(access = AccessLevel.PACKAGE) +public final class OpenUrlAction extends ApolloButtonAction { + + /** + * Returns the URL opened when the button is clicked. + * + * @return the url + * @since 1.2.9 + */ + private final String url; + +} diff --git a/api/src/main/java/com/lunarclient/apollo/common/button/action/RunCommandAction.java b/api/src/main/java/com/lunarclient/apollo/common/button/action/RunCommandAction.java new file mode 100644 index 00000000..65d4f709 --- /dev/null +++ b/api/src/main/java/com/lunarclient/apollo/common/button/action/RunCommandAction.java @@ -0,0 +1,47 @@ +/* + * This file is part of Apollo, licensed under the MIT License. + * + * Copyright (c) 2026 Moonsworth + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +package com.lunarclient.apollo.common.button.action; + +import lombok.AccessLevel; +import lombok.Getter; +import lombok.RequiredArgsConstructor; + +/** + * Represents a button action that runs a command as the player. + * + * @since 1.2.9 + */ +@Getter +@RequiredArgsConstructor(access = AccessLevel.PACKAGE) +public final class RunCommandAction extends ApolloButtonAction { + + /** + * Returns the command run as the player when the button is clicked. + * + * @return the command + * @since 1.2.9 + */ + private final String command; + +} diff --git a/api/src/main/java/com/lunarclient/apollo/common/button/content/ApolloButtonContent.java b/api/src/main/java/com/lunarclient/apollo/common/button/content/ApolloButtonContent.java new file mode 100644 index 00000000..edf468d8 --- /dev/null +++ b/api/src/main/java/com/lunarclient/apollo/common/button/content/ApolloButtonContent.java @@ -0,0 +1,210 @@ +/* + * This file is part of Apollo, licensed under the MIT License. + * + * Copyright (c) 2026 Moonsworth + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +package com.lunarclient.apollo.common.button.content; + +import com.lunarclient.apollo.common.button.ApolloButton; +import com.lunarclient.apollo.common.icon.Icon; +import com.lunarclient.apollo.player.ApolloPlayer; +import java.time.Duration; +import java.util.ArrayList; +import java.util.Collections; +import java.util.List; +import java.util.function.Function; +import lombok.Getter; +import lombok.NonNull; +import net.kyori.adventure.text.Component; + +/** + * Represents the content of an {@link ApolloButton}. + * + * @since 1.2.9 + */ +@Getter +public final class ApolloButtonContent { + + /** + * The maximum number of content parts per button. + * + * @since 1.2.9 + */ + public static final int MAX_PARTS = 30; + + /** + * The minimum content {@link #scale}. + * + * @since 1.2.9 + */ + public static final float MIN_SCALE = 0.25F; + + /** + * The maximum content {@link #scale}. + * + * @since 1.2.9 + */ + public static final float MAX_SCALE = 4.0F; + + /** + * Creates a new {@link Builder} for building button content. + * + * @return the content builder + * @since 1.2.9 + */ + public static Builder builder() { + return new Builder(); + } + + /** + * Returns an unmodifiable {@link List} of the content + * {@link ApolloButtonContentPart}s, in render order. + * + * @return the content parts + * @since 1.2.9 + */ + private final List parts; + + /** + * Returns the {@code float} scale factor applied to the content row. + * + * @return the content scale + * @since 1.2.9 + */ + private final float scale; + + /** + * Returns whether any part of this content is live. + * + * @return whether this content has live parts + * @since 1.2.9 + */ + private final boolean live; + + private ApolloButtonContent(List parts, float scale, boolean live) { + this.parts = Collections.unmodifiableList(parts); + this.scale = scale; + this.live = live; + } + + /** + * Represents a builder for {@link ApolloButtonContent}. + * + * @since 1.2.9 + */ + public static final class Builder { + + private final List parts = new ArrayList<>(); + private float scale = 1.0F; + private boolean live; + + private Builder() { + } + + /** + * Appends an adventure {@link Component} to the content. + * + * @param component the component to append + * @return this builder + * @since 1.2.9 + */ + public Builder append(@NonNull Component component) { + return this.append(ApolloButtonContentPart.component(component)); + } + + /** + * Appends an {@link Icon} to the content; see {@link IconPart}. + * + * @param icon the icon to append + * @return this builder + * @since 1.2.9 + */ + public Builder append(@NonNull Icon icon) { + return this.append(ApolloButtonContentPart.icon(icon)); + } + + /** + * Appends a live part, resolved into an adventure {@link Component} + * for each viewing {@link ApolloPlayer} and refreshed at the given + * interval. + * + * @param liveComponent the per-player component resolver to append + * @param updateInterval the refresh interval + * @return this builder + * @since 1.2.9 + */ + public Builder append(@NonNull Function liveComponent, + @NonNull Duration updateInterval) { + return this.append(ApolloButtonContentPart.live(liveComponent, updateInterval)); + } + + /** + * Appends a pre-built content part; see the + * {@link ApolloButtonContentPart} factories. + * + * @param part the content part to append + * @return this builder + * @since 1.2.9 + */ + public Builder append(@NonNull ApolloButtonContentPart part) { + this.parts.add(part); + this.live |= part.isLive(); + return this; + } + + /** + * Sets the {@code float} scale factor applied to the content row. + * Defaults to {@code 1.0}. + * + * @param scale the content scale, between {@link #MIN_SCALE} and {@link #MAX_SCALE} + * @return this builder + * @since 1.2.9 + */ + public Builder scale(float scale) { + if (!(scale >= MIN_SCALE && scale <= MAX_SCALE)) { + throw new IllegalArgumentException("ApolloButtonContent#scale must be between " + MIN_SCALE + " and " + MAX_SCALE); + } + + this.scale = scale; + return this; + } + + /** + * Builds the {@link ApolloButtonContent}. + * + * @return the built content + * @since 1.2.9 + */ + public ApolloButtonContent build() { + if (this.parts.isEmpty()) { + throw new IllegalArgumentException("ApolloButtonContent requires at least one part"); + } + + if (this.parts.size() > MAX_PARTS) { + throw new IllegalArgumentException("ApolloButtonContent supports at most " + MAX_PARTS + " parts"); + } + + return new ApolloButtonContent(new ArrayList<>(this.parts), this.scale, this.live); + } + + } + +} diff --git a/api/src/main/java/com/lunarclient/apollo/common/button/content/ApolloButtonContentPart.java b/api/src/main/java/com/lunarclient/apollo/common/button/content/ApolloButtonContentPart.java new file mode 100644 index 00000000..d9181a2b --- /dev/null +++ b/api/src/main/java/com/lunarclient/apollo/common/button/content/ApolloButtonContentPart.java @@ -0,0 +1,102 @@ +/* + * This file is part of Apollo, licensed under the MIT License. + * + * Copyright (c) 2026 Moonsworth + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +package com.lunarclient.apollo.common.button.content; + +import com.lunarclient.apollo.common.icon.Icon; +import com.lunarclient.apollo.player.ApolloPlayer; +import java.time.Duration; +import java.util.function.Function; +import lombok.AccessLevel; +import lombok.NoArgsConstructor; +import lombok.NonNull; +import net.kyori.adventure.text.Component; +import org.jetbrains.annotations.ApiStatus; + +/** + * The abstract base class for a single {@link ApolloButtonContent} part. + * + *

Each part is one of {@link ComponentPart}, {@link IconPart} or + * {@link LiveComponentPart}, created through the factory methods on this + * class or the {@link ApolloButtonContent.Builder} append overloads.

+ * + * @since 1.2.9 + */ +@NoArgsConstructor(access = AccessLevel.PACKAGE) +@ApiStatus.NonExtendable +public abstract class ApolloButtonContentPart { + + /** + * Creates a static text part from the given adventure {@link Component}. + * + * @param component the component to render + * @return the component part + * @since 1.2.9 + */ + public static ComponentPart component(@NonNull Component component) { + return new ComponentPart(component); + } + + /** + * Creates an icon part from the given {@link Icon}. + * + * @param icon the icon to render + * @return the icon part + * @since 1.2.9 + */ + public static IconPart icon(@NonNull Icon icon) { + return new IconPart(icon); + } + + /** + * Creates a live part, resolved into an adventure {@link Component} for + * each viewing {@link ApolloPlayer} and refreshed at the given interval. + * + *

The interval must be positive and is quantized to server ticks + * (50ms); anything below one tick refreshes every tick.

+ * + * @param resolver the per-player component resolver + * @param updateInterval the refresh interval + * @return the live component part + * @since 1.2.9 + */ + public static LiveComponentPart live(@NonNull Function resolver, + @NonNull Duration updateInterval) { + if (updateInterval.isNegative() || updateInterval.isZero()) { + throw new IllegalArgumentException("LiveComponentPart#updateInterval must be positive"); + } + + return new LiveComponentPart(resolver, updateInterval); + } + + /** + * Returns whether this part is live. + * + * @return whether this part is live + * @since 1.2.9 + */ + public boolean isLive() { + return false; + } + +} diff --git a/api/src/main/java/com/lunarclient/apollo/common/button/content/ComponentPart.java b/api/src/main/java/com/lunarclient/apollo/common/button/content/ComponentPart.java new file mode 100644 index 00000000..e2955e22 --- /dev/null +++ b/api/src/main/java/com/lunarclient/apollo/common/button/content/ComponentPart.java @@ -0,0 +1,48 @@ +/* + * This file is part of Apollo, licensed under the MIT License. + * + * Copyright (c) 2026 Moonsworth + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +package com.lunarclient.apollo.common.button.content; + +import lombok.AccessLevel; +import lombok.Getter; +import lombok.RequiredArgsConstructor; +import net.kyori.adventure.text.Component; + +/** + * Represents a static text content part. + * + * @since 1.2.9 + */ +@Getter +@RequiredArgsConstructor(access = AccessLevel.PACKAGE) +public final class ComponentPart extends ApolloButtonContentPart { + + /** + * Returns the adventure {@link Component} rendered by this part. + * + * @return the component + * @since 1.2.9 + */ + private final Component component; + +} diff --git a/api/src/main/java/com/lunarclient/apollo/common/button/content/IconPart.java b/api/src/main/java/com/lunarclient/apollo/common/button/content/IconPart.java new file mode 100644 index 00000000..fbb4caca --- /dev/null +++ b/api/src/main/java/com/lunarclient/apollo/common/button/content/IconPart.java @@ -0,0 +1,51 @@ +/* + * This file is part of Apollo, licensed under the MIT License. + * + * Copyright (c) 2026 Moonsworth + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +package com.lunarclient.apollo.common.button.content; + +import com.lunarclient.apollo.common.icon.Icon; +import lombok.AccessLevel; +import lombok.Getter; +import lombok.RequiredArgsConstructor; + +/** + * Represents an icon content part. + * + *

Can be any of the icons found in the {@link com.lunarclient.apollo.common.icon} package; + * for the most common use case, use {@link com.lunarclient.apollo.common.icon.ItemStackIcon}.

+ * + * @since 1.2.9 + */ +@Getter +@RequiredArgsConstructor(access = AccessLevel.PACKAGE) +public final class IconPart extends ApolloButtonContentPart { + + /** + * Returns the {@link Icon} rendered by this part. + * + * @return the icon + * @since 1.2.9 + */ + private final Icon icon; + +} diff --git a/api/src/main/java/com/lunarclient/apollo/common/button/content/LiveComponentPart.java b/api/src/main/java/com/lunarclient/apollo/common/button/content/LiveComponentPart.java new file mode 100644 index 00000000..faab4d7a --- /dev/null +++ b/api/src/main/java/com/lunarclient/apollo/common/button/content/LiveComponentPart.java @@ -0,0 +1,66 @@ +/* + * This file is part of Apollo, licensed under the MIT License. + * + * Copyright (c) 2026 Moonsworth + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +package com.lunarclient.apollo.common.button.content; + +import com.lunarclient.apollo.player.ApolloPlayer; +import java.time.Duration; +import java.util.function.Function; +import lombok.AccessLevel; +import lombok.Getter; +import lombok.RequiredArgsConstructor; +import net.kyori.adventure.text.Component; + +/** + * Represents a live content part: a per-player {@link Component} resolver + * with an update interval controlling how often the module's live button + * broadcast re-resolves and re-sends it. + * + * @since 1.2.9 + */ +@Getter +@RequiredArgsConstructor(access = AccessLevel.PACKAGE) +public final class LiveComponentPart extends ApolloButtonContentPart { + + /** + * Returns the per-player live {@link Component} resolver. + * + * @return the component resolver + * @since 1.2.9 + */ + private final Function resolver; + + /** + * Returns the refresh interval. + * + * @return the update interval + * @since 1.2.9 + */ + private final Duration updateInterval; + + @Override + public boolean isLive() { + return true; + } + +} diff --git a/api/src/main/java/com/lunarclient/apollo/common/icon/ItemStackIcon.java b/api/src/main/java/com/lunarclient/apollo/common/icon/ItemStackIcon.java index 3913eee7..ff1fffe7 100644 --- a/api/src/main/java/com/lunarclient/apollo/common/icon/ItemStackIcon.java +++ b/api/src/main/java/com/lunarclient/apollo/common/icon/ItemStackIcon.java @@ -79,4 +79,12 @@ public final class ItemStackIcon extends Icon { */ @Nullable Profile profile; + /** + * Returns the icon {@link String} potion id (e.g. {@code "healing"}). + * + * @return the icon potion id + * @since 1.2.9 + */ + @Nullable String potion; + } diff --git a/api/src/main/java/com/lunarclient/apollo/common/location/HudPosition.java b/api/src/main/java/com/lunarclient/apollo/common/location/HudPosition.java index c6f7f4fa..4d3f7a49 100644 --- a/api/src/main/java/com/lunarclient/apollo/common/location/HudPosition.java +++ b/api/src/main/java/com/lunarclient/apollo/common/location/HudPosition.java @@ -35,6 +35,18 @@ @Builder public final class HudPosition { + /** + * Creates a new {@link HudPosition} with the given coordinates. + * + * @param x the x coordinate + * @param y the y coordinate + * @return the hud position + * @since 1.2.9 + */ + public static HudPosition of(float x, float y) { + return new HudPosition(x, y); + } + /** * Returns the {@code float} X coordinate for this HUD position. * diff --git a/api/src/main/java/com/lunarclient/apollo/event/packetenrichment/inventory/ApolloPlayerInventoryCloseEvent.java b/api/src/main/java/com/lunarclient/apollo/event/packetenrichment/inventory/ApolloPlayerInventoryCloseEvent.java new file mode 100644 index 00000000..ab47b864 --- /dev/null +++ b/api/src/main/java/com/lunarclient/apollo/event/packetenrichment/inventory/ApolloPlayerInventoryCloseEvent.java @@ -0,0 +1,64 @@ +/* + * This file is part of Apollo, licensed under the MIT License. + * + * Copyright (c) 2026 Moonsworth + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +package com.lunarclient.apollo.event.packetenrichment.inventory; + +import com.lunarclient.apollo.event.Event; +import com.lunarclient.apollo.module.packetenrichment.PlayerInfo; +import com.lunarclient.apollo.player.ApolloPlayer; +import lombok.Value; + +/** + * Represents an event that is fired when the player closes their inventory. + * + * @since 1.2.9 + */ +@Value +public class ApolloPlayerInventoryCloseEvent implements Event { + + /** + * The player that sent the packet. + * + * @return the player + * @since 1.2.9 + */ + ApolloPlayer player; + + /** + * The {@code long} representing the unix timestamp + * when the packet was created. + * + * @return the unix timestamp + * @since 1.2.9 + */ + long instantiationTimeMs; + + /** + * The player's {@link PlayerInfo} information. + * + * @return the player's player info + * @since 1.2.9 + */ + PlayerInfo playerInfo; + +} diff --git a/api/src/main/java/com/lunarclient/apollo/event/packetenrichment/inventory/ApolloPlayerInventoryOpenEvent.java b/api/src/main/java/com/lunarclient/apollo/event/packetenrichment/inventory/ApolloPlayerInventoryOpenEvent.java new file mode 100644 index 00000000..9d0c3dde --- /dev/null +++ b/api/src/main/java/com/lunarclient/apollo/event/packetenrichment/inventory/ApolloPlayerInventoryOpenEvent.java @@ -0,0 +1,64 @@ +/* + * This file is part of Apollo, licensed under the MIT License. + * + * Copyright (c) 2026 Moonsworth + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +package com.lunarclient.apollo.event.packetenrichment.inventory; + +import com.lunarclient.apollo.event.Event; +import com.lunarclient.apollo.module.packetenrichment.PlayerInfo; +import com.lunarclient.apollo.player.ApolloPlayer; +import lombok.Value; + +/** + * Represents an event that is fired when the player opens their inventory. + * + * @since 1.2.9 + */ +@Value +public class ApolloPlayerInventoryOpenEvent implements Event { + + /** + * The player that sent the packet. + * + * @return the player + * @since 1.2.9 + */ + ApolloPlayer player; + + /** + * The {@code long} representing the unix timestamp + * when the packet was created. + * + * @return the unix timestamp + * @since 1.2.9 + */ + long instantiationTimeMs; + + /** + * The player's {@link PlayerInfo} information. + * + * @return the player's player info + * @since 1.2.9 + */ + PlayerInfo playerInfo; + +} diff --git a/api/src/main/java/com/lunarclient/apollo/mods/Mods.java b/api/src/main/java/com/lunarclient/apollo/mods/Mods.java index 344016d6..98e66355 100644 --- a/api/src/main/java/com/lunarclient/apollo/mods/Mods.java +++ b/api/src/main/java/com/lunarclient/apollo/mods/Mods.java @@ -25,6 +25,7 @@ import com.lunarclient.apollo.mods.impl.Mod2dItems; import com.lunarclient.apollo.mods.impl.Mod3dSkins; +import com.lunarclient.apollo.mods.impl.ModActionBar; import com.lunarclient.apollo.mods.impl.ModArmorstatus; import com.lunarclient.apollo.mods.impl.ModAttackIndicator; import com.lunarclient.apollo.mods.impl.ModAudioSubtitles; @@ -64,6 +65,8 @@ import com.lunarclient.apollo.mods.impl.ModItemTracker; import com.lunarclient.apollo.mods.impl.ModKeystrokes; import com.lunarclient.apollo.mods.impl.ModKillSounds; +import com.lunarclient.apollo.mods.impl.ModKnockbackTrainer; +import com.lunarclient.apollo.mods.impl.ModLightOverlay; import com.lunarclient.apollo.mods.impl.ModLighting; import com.lunarclient.apollo.mods.impl.ModMarkers; import com.lunarclient.apollo.mods.impl.ModMemory; @@ -83,6 +86,7 @@ import com.lunarclient.apollo.mods.impl.ModParticleChanger; import com.lunarclient.apollo.mods.impl.ModPing; import com.lunarclient.apollo.mods.impl.ModPlaytime; +import com.lunarclient.apollo.mods.impl.ModPotionCounter; import com.lunarclient.apollo.mods.impl.ModPotionEffects; import com.lunarclient.apollo.mods.impl.ModPvpInfo; import com.lunarclient.apollo.mods.impl.ModQuickplay; @@ -155,6 +159,7 @@ public final class Mods { ModScoreboard.class, ModTitles.class, ModItemCounter.class, + ModPotionCounter.class, ModPing.class, ModMotionBlur.class, ModPackOrganizer.class, @@ -218,15 +223,18 @@ public final class Mods { ModOverlayMod.class, ModRewind.class, ModAudioSubtitles.class, + ModActionBar.class, ModShields.class, + ModLightOverlay.class, ModKillSounds.class, ModInventoryMod.class, ModF3Display.class, ModGuiScale.class, + ModKnockbackTrainer.class, ModRadio.class, - ModSba.class, ModUhcOverlay.class, - ModNeu.class + ModNeu.class, + ModSba.class ); private Mods() { diff --git a/api/src/main/java/com/lunarclient/apollo/mods/impl/ModActionBar.java b/api/src/main/java/com/lunarclient/apollo/mods/impl/ModActionBar.java new file mode 100644 index 00000000..d416060f --- /dev/null +++ b/api/src/main/java/com/lunarclient/apollo/mods/impl/ModActionBar.java @@ -0,0 +1,63 @@ +/* + * This file is part of Apollo, licensed under the MIT License. + * + * Copyright (c) 2026 Moonsworth + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +package com.lunarclient.apollo.mods.impl; + +import com.lunarclient.apollo.option.NumberOption; +import com.lunarclient.apollo.option.SimpleOption; +import io.leangen.geantyref.TypeToken; + +/** + * Allows you to move and scale Minecraft's action bar. + * + * @since 1.2.9 + */ +public final class ModActionBar { + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption ENABLED = SimpleOption.builder() + .node("action-bar", "enabled").type(TypeToken.get(Boolean.class)) + .defaultValue(false) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final NumberOption SCALE = NumberOption.number() + .node("action-bar", "scale").type(TypeToken.get(Float.class)) + .min(0.25F).max(5.0F) + .defaultValue(1.0F) + .notifyClient() + .build(); + + private ModActionBar() { + } + +} diff --git a/api/src/main/java/com/lunarclient/apollo/mods/impl/ModChat.java b/api/src/main/java/com/lunarclient/apollo/mods/impl/ModChat.java index 231f2f69..b428e8c2 100644 --- a/api/src/main/java/com/lunarclient/apollo/mods/impl/ModChat.java +++ b/api/src/main/java/com/lunarclient/apollo/mods/impl/ModChat.java @@ -207,6 +207,66 @@ public final class ModChat { .notifyClient() .build(); + /** + * Displays the player's Minecraft head before their message in chat. + * + * @since 1.2.9 + */ + public static final SimpleOption CHAT_HEADS = SimpleOption.builder() + .comment("Displays the player's Minecraft head before their message in chat.") + .node("chat", "chat-heads").type(TypeToken.get(Boolean.class)) + .defaultValue(false) + .notifyClient() + .build(); + + /** + * Looks up skins for chat senders that aren't in the tab list, like players on other servers of a network. Head detection may be less accurate. + * + * @since 1.2.9 + */ + public static final SimpleOption CHAT_HEADS_FETCH_UNKNOWN = SimpleOption.builder() + .comment("Looks up skins for chat senders that aren't in the tab list, like players on other servers of a network. Head detection may be less accurate.") + .node("chat", "chat-heads-fetch-unknown").type(TypeToken.get(Boolean.class)) + .defaultValue(false) + .notifyClient() + .build(); + + /** + * Adds emojis to chat. Shortcodes like :smile: autocomplete as you type, and emojis in messages show as colorful Twemoji. + * + * @since 1.2.9 + */ + public static final SimpleOption CHAT_EMOJI = SimpleOption.builder() + .comment("Adds emojis to chat. Shortcodes like :smile: autocomplete as you type, and emojis in messages show as colorful Twemoji.") + .node("chat", "chat-emoji").type(TypeToken.get(Boolean.class)) + .defaultValue(true) + .notifyClient() + .build(); + + /** + * Shows emojis with Minecraft's built-in font instead of Twemoji images. Shortcodes the game font can't display are left as text. + * + * @since 1.2.9 + */ + public static final SimpleOption CHAT_EMOJI_UNICODE_ONLY = SimpleOption.builder() + .comment("Shows emojis with Minecraft's built-in font instead of Twemoji images. Shortcodes the game font can't display are left as text.") + .node("chat", "chat-emoji-unicode-only").type(TypeToken.get(Boolean.class)) + .defaultValue(false) + .notifyClient() + .build(); + + /** + * Turns shortcodes like :skull: in other players' messages into emojis. When disabled, only emojis sent as actual characters are shown. + * + * @since 1.2.9 + */ + public static final SimpleOption CHAT_EMOJI_CONVERT_SHORTCODES = SimpleOption.builder() + .comment("Turns shortcodes like :skull: in other players' messages into emojis. When disabled, only emojis sent as actual characters are shown.") + .node("chat", "chat-emoji-convert-shortcodes").type(TypeToken.get(Boolean.class)) + .defaultValue(true) + .notifyClient() + .build(); + /** * Copies the hovered chat message when holding the keybind and clicking. * diff --git a/api/src/main/java/com/lunarclient/apollo/mods/impl/ModHitbox.java b/api/src/main/java/com/lunarclient/apollo/mods/impl/ModHitbox.java index 715abbd2..66109a77 100644 --- a/api/src/main/java/com/lunarclient/apollo/mods/impl/ModHitbox.java +++ b/api/src/main/java/com/lunarclient/apollo/mods/impl/ModHitbox.java @@ -104,6 +104,62 @@ public final class ModHitbox { .notifyClient() .build(); + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption HITBOX_PLAYER_SHOW_HITTABLE_COLOR = SimpleOption.builder() + .node("hitbox", "hitbox-player-show-hittable-color").type(TypeToken.get(Boolean.class)) + .defaultValue(false) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption HITBOX_PLAYER_HITTABLE_COLOR = SimpleOption.builder() + .node("hitbox", "hitbox-player-hittable-color").type(TypeToken.get(Color.class)) + .defaultValue(new Color(0, 255, 0)) + .notifyClient() + .build(); + + /** + * Only show the hitbox when the entity is within reach and under your crosshair. + * + * @since 1.2.9 + */ + public static final SimpleOption HITBOX_PLAYER_ONLY_SHOW_HITTABLE = SimpleOption.builder() + .comment("Only show the hitbox when the entity is within reach and under your crosshair") + .node("hitbox", "hitbox-player-only-show-hittable").type(TypeToken.get(Boolean.class)) + .defaultValue(false) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption HITBOX_PLAYER_SHOW_DAMAGED_COLOR = SimpleOption.builder() + .node("hitbox", "hitbox-player-show-damaged-color").type(TypeToken.get(Boolean.class)) + .defaultValue(false) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption HITBOX_PLAYER_DAMAGED_COLOR = SimpleOption.builder() + .node("hitbox", "hitbox-player-damaged-color").type(TypeToken.get(Color.class)) + .defaultValue(new Color(255, 0, 0)) + .notifyClient() + .build(); + /** * No documentation available. * @@ -149,6 +205,61 @@ public final class ModHitbox { .notifyClient() .build(); + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption HITBOX_ITEM_SHOW_HITTABLE_COLOR = SimpleOption.builder() + .node("hitbox", "hitbox-item-show-hittable-color").type(TypeToken.get(Boolean.class)) + .defaultValue(false) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption HITBOX_ITEM_HITTABLE_COLOR = SimpleOption.builder() + .node("hitbox", "hitbox-item-hittable-color").type(TypeToken.get(Color.class)) + .defaultValue(new Color(0, 255, 0)) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption HITBOX_ITEM_ONLY_SHOW_HITTABLE = SimpleOption.builder() + .node("hitbox", "hitbox-item-only-show-hittable").type(TypeToken.get(Boolean.class)) + .defaultValue(false) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption HITBOX_ITEM_SHOW_DAMAGED_COLOR = SimpleOption.builder() + .node("hitbox", "hitbox-item-show-damaged-color").type(TypeToken.get(Boolean.class)) + .defaultValue(false) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption HITBOX_ITEM_DAMAGED_COLOR = SimpleOption.builder() + .node("hitbox", "hitbox-item-damaged-color").type(TypeToken.get(Color.class)) + .defaultValue(new Color(255, 0, 0)) + .notifyClient() + .build(); + /** * No documentation available. * @@ -194,6 +305,61 @@ public final class ModHitbox { .notifyClient() .build(); + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption HITBOX_EXP_ORB_SHOW_HITTABLE_COLOR = SimpleOption.builder() + .node("hitbox", "hitbox-exp-orb-show-hittable-color").type(TypeToken.get(Boolean.class)) + .defaultValue(false) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption HITBOX_EXP_ORB_HITTABLE_COLOR = SimpleOption.builder() + .node("hitbox", "hitbox-exp-orb-hittable-color").type(TypeToken.get(Color.class)) + .defaultValue(new Color(0, 255, 0)) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption HITBOX_EXP_ORB_ONLY_SHOW_HITTABLE = SimpleOption.builder() + .node("hitbox", "hitbox-exp-orb-only-show-hittable").type(TypeToken.get(Boolean.class)) + .defaultValue(false) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption HITBOX_EXP_ORB_SHOW_DAMAGED_COLOR = SimpleOption.builder() + .node("hitbox", "hitbox-exp-orb-show-damaged-color").type(TypeToken.get(Boolean.class)) + .defaultValue(false) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption HITBOX_EXP_ORB_DAMAGED_COLOR = SimpleOption.builder() + .node("hitbox", "hitbox-exp-orb-damaged-color").type(TypeToken.get(Color.class)) + .defaultValue(new Color(255, 0, 0)) + .notifyClient() + .build(); + /** * No documentation available. * @@ -239,6 +405,61 @@ public final class ModHitbox { .notifyClient() .build(); + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption HITBOX_ITEM_FRAME_SHOW_HITTABLE_COLOR = SimpleOption.builder() + .node("hitbox", "hitbox-item-frame-show-hittable-color").type(TypeToken.get(Boolean.class)) + .defaultValue(false) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption HITBOX_ITEM_FRAME_HITTABLE_COLOR = SimpleOption.builder() + .node("hitbox", "hitbox-item-frame-hittable-color").type(TypeToken.get(Color.class)) + .defaultValue(new Color(0, 255, 0)) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption HITBOX_ITEM_FRAME_ONLY_SHOW_HITTABLE = SimpleOption.builder() + .node("hitbox", "hitbox-item-frame-only-show-hittable").type(TypeToken.get(Boolean.class)) + .defaultValue(false) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption HITBOX_ITEM_FRAME_SHOW_DAMAGED_COLOR = SimpleOption.builder() + .node("hitbox", "hitbox-item-frame-show-damaged-color").type(TypeToken.get(Boolean.class)) + .defaultValue(false) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption HITBOX_ITEM_FRAME_DAMAGED_COLOR = SimpleOption.builder() + .node("hitbox", "hitbox-item-frame-damaged-color").type(TypeToken.get(Color.class)) + .defaultValue(new Color(255, 0, 0)) + .notifyClient() + .build(); + /** * No documentation available. * @@ -284,6 +505,61 @@ public final class ModHitbox { .notifyClient() .build(); + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption HITBOX_FIREWORK_SHOW_HITTABLE_COLOR = SimpleOption.builder() + .node("hitbox", "hitbox-firework-show-hittable-color").type(TypeToken.get(Boolean.class)) + .defaultValue(false) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption HITBOX_FIREWORK_HITTABLE_COLOR = SimpleOption.builder() + .node("hitbox", "hitbox-firework-hittable-color").type(TypeToken.get(Color.class)) + .defaultValue(new Color(0, 255, 0)) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption HITBOX_FIREWORK_ONLY_SHOW_HITTABLE = SimpleOption.builder() + .node("hitbox", "hitbox-firework-only-show-hittable").type(TypeToken.get(Boolean.class)) + .defaultValue(false) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption HITBOX_FIREWORK_SHOW_DAMAGED_COLOR = SimpleOption.builder() + .node("hitbox", "hitbox-firework-show-damaged-color").type(TypeToken.get(Boolean.class)) + .defaultValue(false) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption HITBOX_FIREWORK_DAMAGED_COLOR = SimpleOption.builder() + .node("hitbox", "hitbox-firework-damaged-color").type(TypeToken.get(Color.class)) + .defaultValue(new Color(255, 0, 0)) + .notifyClient() + .build(); + /** * No documentation available. * @@ -329,6 +605,61 @@ public final class ModHitbox { .notifyClient() .build(); + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption HITBOX_WITHER_SKULL_SHOW_HITTABLE_COLOR = SimpleOption.builder() + .node("hitbox", "hitbox-wither-skull-show-hittable-color").type(TypeToken.get(Boolean.class)) + .defaultValue(false) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption HITBOX_WITHER_SKULL_HITTABLE_COLOR = SimpleOption.builder() + .node("hitbox", "hitbox-wither-skull-hittable-color").type(TypeToken.get(Color.class)) + .defaultValue(new Color(0, 255, 0)) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption HITBOX_WITHER_SKULL_ONLY_SHOW_HITTABLE = SimpleOption.builder() + .node("hitbox", "hitbox-wither-skull-only-show-hittable").type(TypeToken.get(Boolean.class)) + .defaultValue(false) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption HITBOX_WITHER_SKULL_SHOW_DAMAGED_COLOR = SimpleOption.builder() + .node("hitbox", "hitbox-wither-skull-show-damaged-color").type(TypeToken.get(Boolean.class)) + .defaultValue(false) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption HITBOX_WITHER_SKULL_DAMAGED_COLOR = SimpleOption.builder() + .node("hitbox", "hitbox-wither-skull-damaged-color").type(TypeToken.get(Color.class)) + .defaultValue(new Color(255, 0, 0)) + .notifyClient() + .build(); + /** * No documentation available. * @@ -374,6 +705,61 @@ public final class ModHitbox { .notifyClient() .build(); + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption HITBOX_SNOWBALL_SHOW_HITTABLE_COLOR = SimpleOption.builder() + .node("hitbox", "hitbox-snowball-show-hittable-color").type(TypeToken.get(Boolean.class)) + .defaultValue(false) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption HITBOX_SNOWBALL_HITTABLE_COLOR = SimpleOption.builder() + .node("hitbox", "hitbox-snowball-hittable-color").type(TypeToken.get(Color.class)) + .defaultValue(new Color(0, 255, 0)) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption HITBOX_SNOWBALL_ONLY_SHOW_HITTABLE = SimpleOption.builder() + .node("hitbox", "hitbox-snowball-only-show-hittable").type(TypeToken.get(Boolean.class)) + .defaultValue(false) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption HITBOX_SNOWBALL_SHOW_DAMAGED_COLOR = SimpleOption.builder() + .node("hitbox", "hitbox-snowball-show-damaged-color").type(TypeToken.get(Boolean.class)) + .defaultValue(false) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption HITBOX_SNOWBALL_DAMAGED_COLOR = SimpleOption.builder() + .node("hitbox", "hitbox-snowball-damaged-color").type(TypeToken.get(Color.class)) + .defaultValue(new Color(255, 0, 0)) + .notifyClient() + .build(); + /** * No documentation available. * @@ -419,6 +805,61 @@ public final class ModHitbox { .notifyClient() .build(); + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption HITBOX_FIREBALL_SHOW_HITTABLE_COLOR = SimpleOption.builder() + .node("hitbox", "hitbox-fireball-show-hittable-color").type(TypeToken.get(Boolean.class)) + .defaultValue(false) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption HITBOX_FIREBALL_HITTABLE_COLOR = SimpleOption.builder() + .node("hitbox", "hitbox-fireball-hittable-color").type(TypeToken.get(Color.class)) + .defaultValue(new Color(0, 255, 0)) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption HITBOX_FIREBALL_ONLY_SHOW_HITTABLE = SimpleOption.builder() + .node("hitbox", "hitbox-fireball-only-show-hittable").type(TypeToken.get(Boolean.class)) + .defaultValue(false) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption HITBOX_FIREBALL_SHOW_DAMAGED_COLOR = SimpleOption.builder() + .node("hitbox", "hitbox-fireball-show-damaged-color").type(TypeToken.get(Boolean.class)) + .defaultValue(false) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption HITBOX_FIREBALL_DAMAGED_COLOR = SimpleOption.builder() + .node("hitbox", "hitbox-fireball-damaged-color").type(TypeToken.get(Color.class)) + .defaultValue(new Color(255, 0, 0)) + .notifyClient() + .build(); + /** * No documentation available. * @@ -464,6 +905,61 @@ public final class ModHitbox { .notifyClient() .build(); + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption HITBOX_ARROW_SHOW_HITTABLE_COLOR = SimpleOption.builder() + .node("hitbox", "hitbox-arrow-show-hittable-color").type(TypeToken.get(Boolean.class)) + .defaultValue(false) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption HITBOX_ARROW_HITTABLE_COLOR = SimpleOption.builder() + .node("hitbox", "hitbox-arrow-hittable-color").type(TypeToken.get(Color.class)) + .defaultValue(new Color(0, 255, 0)) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption HITBOX_ARROW_ONLY_SHOW_HITTABLE = SimpleOption.builder() + .node("hitbox", "hitbox-arrow-only-show-hittable").type(TypeToken.get(Boolean.class)) + .defaultValue(false) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption HITBOX_ARROW_SHOW_DAMAGED_COLOR = SimpleOption.builder() + .node("hitbox", "hitbox-arrow-show-damaged-color").type(TypeToken.get(Boolean.class)) + .defaultValue(false) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption HITBOX_ARROW_DAMAGED_COLOR = SimpleOption.builder() + .node("hitbox", "hitbox-arrow-damaged-color").type(TypeToken.get(Color.class)) + .defaultValue(new Color(255, 0, 0)) + .notifyClient() + .build(); + /** * No documentation available. * @@ -509,6 +1005,61 @@ public final class ModHitbox { .notifyClient() .build(); + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption HITBOX_PROJECTILE_SHOW_HITTABLE_COLOR = SimpleOption.builder() + .node("hitbox", "hitbox-projectile-show-hittable-color").type(TypeToken.get(Boolean.class)) + .defaultValue(false) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption HITBOX_PROJECTILE_HITTABLE_COLOR = SimpleOption.builder() + .node("hitbox", "hitbox-projectile-hittable-color").type(TypeToken.get(Color.class)) + .defaultValue(new Color(0, 255, 0)) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption HITBOX_PROJECTILE_ONLY_SHOW_HITTABLE = SimpleOption.builder() + .node("hitbox", "hitbox-projectile-only-show-hittable").type(TypeToken.get(Boolean.class)) + .defaultValue(false) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption HITBOX_PROJECTILE_SHOW_DAMAGED_COLOR = SimpleOption.builder() + .node("hitbox", "hitbox-projectile-show-damaged-color").type(TypeToken.get(Boolean.class)) + .defaultValue(false) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption HITBOX_PROJECTILE_DAMAGED_COLOR = SimpleOption.builder() + .node("hitbox", "hitbox-projectile-damaged-color").type(TypeToken.get(Color.class)) + .defaultValue(new Color(255, 0, 0)) + .notifyClient() + .build(); + /** * No documentation available. * @@ -554,6 +1105,62 @@ public final class ModHitbox { .notifyClient() .build(); + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption HITBOX_MONSTER_SHOW_HITTABLE_COLOR = SimpleOption.builder() + .node("hitbox", "hitbox-monster-show-hittable-color").type(TypeToken.get(Boolean.class)) + .defaultValue(false) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption HITBOX_MONSTER_HITTABLE_COLOR = SimpleOption.builder() + .node("hitbox", "hitbox-monster-hittable-color").type(TypeToken.get(Color.class)) + .defaultValue(new Color(0, 255, 0)) + .notifyClient() + .build(); + + /** + * Only show the hitbox when the entity is within reach and under your crosshair. + * + * @since 1.2.9 + */ + public static final SimpleOption HITBOX_MONSTER_ONLY_SHOW_HITTABLE = SimpleOption.builder() + .comment("Only show the hitbox when the entity is within reach and under your crosshair") + .node("hitbox", "hitbox-monster-only-show-hittable").type(TypeToken.get(Boolean.class)) + .defaultValue(false) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption HITBOX_MONSTER_SHOW_DAMAGED_COLOR = SimpleOption.builder() + .node("hitbox", "hitbox-monster-show-damaged-color").type(TypeToken.get(Boolean.class)) + .defaultValue(false) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption HITBOX_MONSTER_DAMAGED_COLOR = SimpleOption.builder() + .node("hitbox", "hitbox-monster-damaged-color").type(TypeToken.get(Color.class)) + .defaultValue(new Color(255, 0, 0)) + .notifyClient() + .build(); + /** * No documentation available. * @@ -599,6 +1206,62 @@ public final class ModHitbox { .notifyClient() .build(); + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption HITBOX_PASSIVE_SHOW_HITTABLE_COLOR = SimpleOption.builder() + .node("hitbox", "hitbox-passive-show-hittable-color").type(TypeToken.get(Boolean.class)) + .defaultValue(false) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption HITBOX_PASSIVE_HITTABLE_COLOR = SimpleOption.builder() + .node("hitbox", "hitbox-passive-hittable-color").type(TypeToken.get(Color.class)) + .defaultValue(new Color(0, 255, 0)) + .notifyClient() + .build(); + + /** + * Only show the hitbox when the entity is within reach and under your crosshair. + * + * @since 1.2.9 + */ + public static final SimpleOption HITBOX_PASSIVE_ONLY_SHOW_HITTABLE = SimpleOption.builder() + .comment("Only show the hitbox when the entity is within reach and under your crosshair") + .node("hitbox", "hitbox-passive-only-show-hittable").type(TypeToken.get(Boolean.class)) + .defaultValue(false) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption HITBOX_PASSIVE_SHOW_DAMAGED_COLOR = SimpleOption.builder() + .node("hitbox", "hitbox-passive-show-damaged-color").type(TypeToken.get(Boolean.class)) + .defaultValue(false) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption HITBOX_PASSIVE_DAMAGED_COLOR = SimpleOption.builder() + .node("hitbox", "hitbox-passive-damaged-color").type(TypeToken.get(Color.class)) + .defaultValue(new Color(255, 0, 0)) + .notifyClient() + .build(); + /** * No documentation available. * @@ -644,6 +1307,61 @@ public final class ModHitbox { .notifyClient() .build(); + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption HITBOX_OTHER_SHOW_HITTABLE_COLOR = SimpleOption.builder() + .node("hitbox", "hitbox-other-show-hittable-color").type(TypeToken.get(Boolean.class)) + .defaultValue(false) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption HITBOX_OTHER_HITTABLE_COLOR = SimpleOption.builder() + .node("hitbox", "hitbox-other-hittable-color").type(TypeToken.get(Color.class)) + .defaultValue(new Color(0, 255, 0)) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption HITBOX_OTHER_ONLY_SHOW_HITTABLE = SimpleOption.builder() + .node("hitbox", "hitbox-other-only-show-hittable").type(TypeToken.get(Boolean.class)) + .defaultValue(false) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption HITBOX_OTHER_SHOW_DAMAGED_COLOR = SimpleOption.builder() + .node("hitbox", "hitbox-other-show-damaged-color").type(TypeToken.get(Boolean.class)) + .defaultValue(false) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption HITBOX_OTHER_DAMAGED_COLOR = SimpleOption.builder() + .node("hitbox", "hitbox-other-damaged-color").type(TypeToken.get(Color.class)) + .defaultValue(new Color(255, 0, 0)) + .notifyClient() + .build(); + /** * No documentation available. * diff --git a/api/src/main/java/com/lunarclient/apollo/mods/impl/ModKnockbackTrainer.java b/api/src/main/java/com/lunarclient/apollo/mods/impl/ModKnockbackTrainer.java new file mode 100644 index 00000000..1a82c014 --- /dev/null +++ b/api/src/main/java/com/lunarclient/apollo/mods/impl/ModKnockbackTrainer.java @@ -0,0 +1,98 @@ +/* + * This file is part of Apollo, licensed under the MIT License. + * + * Copyright (c) 2026 Moonsworth + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +package com.lunarclient.apollo.mods.impl; + +import com.lunarclient.apollo.option.NumberOption; +import com.lunarclient.apollo.option.SimpleOption; +import io.leangen.geantyref.TypeToken; + +/** + * Train jump resets: how close your jump press lands to the tick you were hit. + * + * @since 1.2.9 + */ +public final class ModKnockbackTrainer { + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption ENABLED = SimpleOption.builder() + .node("knockback-trainer", "enabled").type(TypeToken.get(Boolean.class)) + .defaultValue(false) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final NumberOption TARGET_TICKS = NumberOption.number() + .node("knockback-trainer", "target-ticks").type(TypeToken.get(Integer.class)) + .min(0).max(6) + .defaultValue(0) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final NumberOption WINDOW_TICKS = NumberOption.number() + .node("knockback-trainer", "window-ticks").type(TypeToken.get(Integer.class)) + .min(0).max(10) + .defaultValue(5) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption FALLING_HIT_SOUND = SimpleOption.builder() + .node("knockback-trainer", "falling-hit-sound").type(TypeToken.get(Boolean.class)) + .defaultValue(true) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final NumberOption FALLING_HIT_SOUND_VOLUME = NumberOption.number() + .node("knockback-trainer", "falling-hit-sound-volume").type(TypeToken.get(Float.class)) + .min(0.0F).max(1.0F) + .defaultValue(1.0F) + .notifyClient() + .build(); + + private ModKnockbackTrainer() { + } + +} diff --git a/api/src/main/java/com/lunarclient/apollo/mods/impl/ModLightOverlay.java b/api/src/main/java/com/lunarclient/apollo/mods/impl/ModLightOverlay.java new file mode 100644 index 00000000..07d415e1 --- /dev/null +++ b/api/src/main/java/com/lunarclient/apollo/mods/impl/ModLightOverlay.java @@ -0,0 +1,208 @@ +/* + * This file is part of Apollo, licensed under the MIT License. + * + * Copyright (c) 2026 Moonsworth + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +package com.lunarclient.apollo.mods.impl; + +import com.lunarclient.apollo.option.NumberOption; +import com.lunarclient.apollo.option.SimpleOption; +import io.leangen.geantyref.TypeToken; +import java.awt.Color; + +/** + * Shows the light levels of blocks where mobs can spawn. + * + * @since 1.2.9 + */ +public final class ModLightOverlay { + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption ENABLED = SimpleOption.builder() + .node("light-overlay", "enabled").type(TypeToken.get(Boolean.class)) + .defaultValue(false) + .notifyClient() + .build(); + + /** + * The rendering limit (in chunks) for light overlay values. Higher values might lower your FPS. + * + * @since 1.2.9 + */ + public static final NumberOption RENDER_RANGE_LIMIT = NumberOption.number() + .comment("The rendering limit (in chunks) for light overlay values. Higher values might lower your FPS.") + .node("light-overlay", "render-range-limit").type(TypeToken.get(Integer.class)) + .min(1).max(12) + .defaultValue(2) + .notifyClient() + .build(); + + /** + * With this option on, the overlay updates aren't deferred, and happen as fast as possible.This looks nicer (less "pop in"), but turning this option on comes at a potential performance cost. + * + * @since 1.2.9 + */ + public static final SimpleOption FAST_UPDATES = SimpleOption.builder() + .comment("With this option on, the overlay updates aren't deferred, and happen as fast as possible.This looks nicer (less \"pop in\"), but turning this option on comes at a potential performance cost.") + .node("light-overlay", "fast-updates").type(TypeToken.get(Boolean.class)) + .defaultValue(false) + .notifyClient() + .build(); + + /** + * Reduce the amount of overlays that are rendered, increasing performance, especially at higher rendering ranges.This comes at the expense of overlays at the edges of the screen sometimes popping in and out as you look around.It's highly recommended that this option is kept on, especially if using higher rendering ranges. + * + * @since 1.2.9 + */ + public static final SimpleOption CULLING = SimpleOption.builder() + .comment("Reduce the amount of overlays that are rendered, increasing performance, especially at higher rendering ranges.This comes at the expense of overlays at the edges of the screen sometimes popping in and out as you look around.It's highly recommended that this option is kept on, especially if using higher rendering ranges.") + .node("light-overlay", "culling").type(TypeToken.get(Boolean.class)) + .defaultValue(true) + .notifyClient() + .build(); + + /** + * With this option on, the real, effective light value is displayed. With this option off, only the block light is used, completely ignoring the sky/day light. + * + * @since 1.2.9 + */ + public static final SimpleOption INCLUDE_SKY_LIGHT = SimpleOption.builder() + .comment("With this option on, the real, effective light value is displayed. With this option off, only the block light is used, completely ignoring the sky/day light.") + .node("light-overlay", "include-sky-light").type(TypeToken.get(Boolean.class)) + .defaultValue(true) + .notifyClient() + .build(); + + /** + * Only show on blocks which have light levels that hostile mobs can spawn on. + * + * @since 1.2.9 + */ + public static final SimpleOption HIDE_UNSPAWNABLE_LIGHT = SimpleOption.builder() + .comment("Only show on blocks which have light levels that hostile mobs can spawn on") + .node("light-overlay", "hide-unspawnable-light").type(TypeToken.get(Boolean.class)) + .defaultValue(false) + .notifyClient() + .build(); + + /** + * Set a custom threshold for Light Check. This overrides the vanilla hostile mob spawning value, and shows the light overlay on all blocks on which the light level falls below this threshold. + * + * @since 1.2.9 + */ + public static final SimpleOption CUSTOM_LIGHT_THRESHOLD = SimpleOption.builder() + .comment("Set a custom threshold for Light Check. This overrides the vanilla hostile mob spawning value, and shows the light overlay on all blocks on which the light level falls below this threshold") + .node("light-overlay", "custom-light-threshold").type(TypeToken.get(Boolean.class)) + .defaultValue(false) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final NumberOption THRESHOLD = NumberOption.number() + .node("light-overlay", "threshold").type(TypeToken.get(Integer.class)) + .min(0).max(15) + .defaultValue(15) + .notifyClient() + .build(); + + /** + * Show a number for the light value of each block.Turning this option on might lower your FPS. + * + * @since 1.2.9 + */ + public static final SimpleOption SHOW_LIGHT_VALUE = SimpleOption.builder() + .comment("Show a number for the light value of each block.Turning this option on might lower your FPS.") + .node("light-overlay", "show-light-value").type(TypeToken.get(Boolean.class)) + .defaultValue(false) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final NumberOption CROSS_THICKNESS = NumberOption.number() + .node("light-overlay", "cross-thickness").type(TypeToken.get(Float.class)) + .min(0.5F).max(10.0F) + .defaultValue(2.0F) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption TEXT_COLOR = SimpleOption.builder() + .node("light-overlay", "text-color").type(TypeToken.get(Color.class)) + .defaultValue(new Color(255, 255, 255)) + .notifyClient() + .build(); + + /** + * Color where hostile mobs can't spawn. + * + * @since 1.2.9 + */ + public static final SimpleOption BRIGHT_COLOR = SimpleOption.builder() + .comment("Color where hostile mobs can't spawn") + .node("light-overlay", "bright-color").type(TypeToken.get(Color.class)) + .defaultValue(new Color(0, 255, 0)) + .notifyClient() + .build(); + + /** + * Color where hostile mobs can spawn. + * + * @since 1.2.9 + */ + public static final SimpleOption DARK_COLOR = SimpleOption.builder() + .comment("Color where hostile mobs can spawn") + .node("light-overlay", "dark-color").type(TypeToken.get(Color.class)) + .defaultValue(new Color(255, 0, 0)) + .notifyClient() + .build(); + + /** + * When this is off, the color is picked based on the light level allowing hostile mobs to spawn. When this is on, the color is interpolated smoothly. + * + * @since 1.2.9 + */ + public static final SimpleOption LIGHT_OVERLAY_DYNAMIC_COLOR = SimpleOption.builder() + .comment("When this is off, the color is picked based on the light level allowing hostile mobs to spawn. When this is on, the color is interpolated smoothly.") + .node("light-overlay", "light-overlay-dynamic-color").type(TypeToken.get(Boolean.class)) + .defaultValue(false) + .notifyClient() + .build(); + + private ModLightOverlay() { + } + +} diff --git a/api/src/main/java/com/lunarclient/apollo/mods/impl/ModNametag.java b/api/src/main/java/com/lunarclient/apollo/mods/impl/ModNametag.java index 64e724b6..1ab58554 100644 --- a/api/src/main/java/com/lunarclient/apollo/mods/impl/ModNametag.java +++ b/api/src/main/java/com/lunarclient/apollo/mods/impl/ModNametag.java @@ -104,6 +104,18 @@ public final class ModNametag { .notifyClient() .build(); + /** + * With this option enabled, your nametag will be hidden in third person when there is a passenger attached to you. + * + * @since 1.2.9 + */ + public static final SimpleOption HIDE_NAMETAG_F5PASSENGERS = SimpleOption.builder() + .comment("With this option enabled, your nametag will be hidden in third person when there is a passenger attached to you.") + .node("nametag", "hide-nametag-f5-passengers").type(TypeToken.get(Boolean.class)) + .defaultValue(false) + .notifyClient() + .build(); + /** * No documentation available. * diff --git a/api/src/main/java/com/lunarclient/apollo/mods/impl/ModOverlayMod.java b/api/src/main/java/com/lunarclient/apollo/mods/impl/ModOverlayMod.java index 21f6786f..b04034dd 100644 --- a/api/src/main/java/com/lunarclient/apollo/mods/impl/ModOverlayMod.java +++ b/api/src/main/java/com/lunarclient/apollo/mods/impl/ModOverlayMod.java @@ -70,6 +70,18 @@ public final class ModOverlayMod { .notifyClient() .build(); + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final NumberOption FIRE_BLOCK_HEIGHT = NumberOption.number() + .node("overlay-mod", "fire-block-height").type(TypeToken.get(Float.class)) + .min(0.0F).max(2.0F) + .defaultValue(1.0F) + .notifyClient() + .build(); + /** * No documentation available. * diff --git a/api/src/main/java/com/lunarclient/apollo/mods/impl/ModPing.java b/api/src/main/java/com/lunarclient/apollo/mods/impl/ModPing.java index 059e6312..3e46e2bf 100644 --- a/api/src/main/java/com/lunarclient/apollo/mods/impl/ModPing.java +++ b/api/src/main/java/com/lunarclient/apollo/mods/impl/ModPing.java @@ -47,15 +47,15 @@ public final class ModPing { .build(); /** - * Faster updates may impact performance. + * How often ping is measured. If you have trouble connecting to a server, try increasing this. * * @since 1.0.0 */ public static final NumberOption UPDATE_INTERVAL_SEC = NumberOption.number() - .comment("Faster updates may impact performance") + .comment("How often ping is measured. If you have trouble connecting to a server, try increasing this.") .node("ping", "update-interval-sec").type(TypeToken.get(Integer.class)) .min(1).max(120) - .defaultValue(20) + .defaultValue(5) .notifyClient() .build(); diff --git a/api/src/main/java/com/lunarclient/apollo/mods/impl/ModPotionCounter.java b/api/src/main/java/com/lunarclient/apollo/mods/impl/ModPotionCounter.java new file mode 100644 index 00000000..02dac49d --- /dev/null +++ b/api/src/main/java/com/lunarclient/apollo/mods/impl/ModPotionCounter.java @@ -0,0 +1,213 @@ +/* + * This file is part of Apollo, licensed under the MIT License. + * + * Copyright (c) 2026 Moonsworth + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +package com.lunarclient.apollo.mods.impl; + +import com.lunarclient.apollo.option.NumberOption; +import com.lunarclient.apollo.option.SimpleOption; +import io.leangen.geantyref.TypeToken; +import java.awt.Color; + +/** + * Displays how many healing potions or soups are currently in your inventory on the HUD. + * + * @since 1.2.9 + */ +public final class ModPotionCounter { + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption ENABLED = SimpleOption.builder() + .node("potion-counter", "enabled").type(TypeToken.get(Boolean.class)) + .defaultValue(false) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final NumberOption SCALE = NumberOption.number() + .node("potion-counter", "scale").type(TypeToken.get(Float.class)) + .min(0.25F).max(5.0F) + .defaultValue(1.0F) + .notifyClient() + .build(); + + /** + * Adds a shadow to text. + * + * @since 1.2.9 + */ + public static final SimpleOption TEXT_SHADOW = SimpleOption.builder() + .comment("Adds a shadow to text") + .node("potion-counter", "text-shadow").type(TypeToken.get(Boolean.class)) + .defaultValue(true) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption BRACKETS = SimpleOption.builder() + .node("potion-counter", "brackets").type(TypeToken.get(Boolean.class)) + .defaultValue(true) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption BRACKET_COLOR = SimpleOption.builder() + .node("potion-counter", "bracket-color").type(TypeToken.get(Color.class)) + .defaultValue(new Color(255, 255, 255)) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption BACKGROUND = SimpleOption.builder() + .node("potion-counter", "background").type(TypeToken.get(Boolean.class)) + .defaultValue(true) + .notifyClient() + .build(); + + /** + * If this is disabled the background will change size with the text. + * + * @since 1.2.9 + */ + public static final SimpleOption STATIC_BACKGROUND_WIDTH = SimpleOption.builder() + .comment("If this is disabled the background will change size with the text.") + .node("potion-counter", "static-background-width").type(TypeToken.get(Boolean.class)) + .defaultValue(true) + .notifyClient() + .build(); + + /** + * If this is disabled the background will change size with the text. + * + * @since 1.2.9 + */ + public static final SimpleOption STATIC_BACKGROUND_HEIGHT = SimpleOption.builder() + .comment("If this is disabled the background will change size with the text.") + .node("potion-counter", "static-background-height").type(TypeToken.get(Boolean.class)) + .defaultValue(true) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final NumberOption BACKGROUND_WIDTH = NumberOption.number() + .node("potion-counter", "background-width").type(TypeToken.get(Integer.class)) + .min(40).max(62) + .defaultValue(56) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final NumberOption BACKGROUND_HEIGHT = NumberOption.number() + .node("potion-counter", "background-height").type(TypeToken.get(Integer.class)) + .min(10).max(22) + .defaultValue(18) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption BORDER = SimpleOption.builder() + .node("potion-counter", "border").type(TypeToken.get(Boolean.class)) + .defaultValue(false) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final NumberOption BORDER_THICKNESS = NumberOption.number() + .node("potion-counter", "border-thickness").type(TypeToken.get(Float.class)) + .min(0.5F).max(3.0F) + .defaultValue(0.5F) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption BORDER_COLOR = SimpleOption.builder() + .node("potion-counter", "border-color").type(TypeToken.get(Color.class)) + .defaultValue(new Color(0, 0, 0, 159)) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption BACKGROUND_COLOR = SimpleOption.builder() + .node("potion-counter", "background-color").type(TypeToken.get(Color.class)) + .defaultValue(new Color(0, 0, 0, 111)) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption TEXT_COLOR = SimpleOption.builder() + .node("potion-counter", "text-color").type(TypeToken.get(Color.class)) + .defaultValue(new Color(255, 255, 255)) + .notifyClient() + .build(); + + private ModPotionCounter() { + } + +} diff --git a/api/src/main/java/com/lunarclient/apollo/mods/impl/ModPotionEffects.java b/api/src/main/java/com/lunarclient/apollo/mods/impl/ModPotionEffects.java index 93be05cc..649d2ee1 100644 --- a/api/src/main/java/com/lunarclient/apollo/mods/impl/ModPotionEffects.java +++ b/api/src/main/java/com/lunarclient/apollo/mods/impl/ModPotionEffects.java @@ -49,22 +49,22 @@ public final class ModPotionEffects { /** * No documentation available. * - * @since 1.0.0 + * @since 1.2.9 */ - public static final NumberOption SCALE = NumberOption.number() - .node("potion-effects", "scale").type(TypeToken.get(Float.class)) - .min(0.25F).max(5.0F) - .defaultValue(1.0F) + public static final SimpleOption HIDE_AMBIENT_DURATION = SimpleOption.builder() + .node("potion-effects", "hide-ambient-duration").type(TypeToken.get(Boolean.class)) + .defaultValue(false) .notifyClient() .build(); /** - * No documentation available. + * Put the good effects and the bad effects on separate lines. * - * @since 1.0.0 + * @since 1.2.9 */ - public static final SimpleOption SHOW_IN_INVENTORY = SimpleOption.builder() - .node("potion-effects", "show-in-inventory").type(TypeToken.get(Boolean.class)) + public static final SimpleOption VANILLA_GROUP_EFFECTS = SimpleOption.builder() + .comment("Put the good effects and the bad effects on separate lines") + .node("potion-effects", "vanilla-group-effects").type(TypeToken.get(Boolean.class)) .defaultValue(true) .notifyClient() .build(); @@ -72,14 +72,49 @@ public final class ModPotionEffects { /** * No documentation available. * - * @since 1.0.0 + * @since 1.2.9 */ - public static final SimpleOption SHOW_WHILE_TYPING = SimpleOption.builder() - .node("potion-effects", "show-while-typing").type(TypeToken.get(Boolean.class)) + public static final SimpleOption VANILLA_MODE_HORIZONTAL = SimpleOption.builder() + .node("potion-effects", "vanilla-mode-horizontal").type(TypeToken.get(Boolean.class)) .defaultValue(true) .notifyClient() .build(); + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final NumberOption VANILLA_MODE_TILES_PER_LINE = NumberOption.number() + .node("potion-effects", "vanilla-mode-tiles-per-line").type(TypeToken.get(Integer.class)) + .min(1).max(10) + .defaultValue(10) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.1.9 + */ + public static final SimpleOption MINIMAL_MODE_HORIZONTAL = SimpleOption.builder() + .node("potion-effects", "minimal-mode-horizontal").type(TypeToken.get(Boolean.class)) + .defaultValue(false) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final NumberOption MINIMAL_MODE_TILES_PER_LINE = NumberOption.number() + .node("potion-effects", "minimal-mode-tiles-per-line").type(TypeToken.get(Integer.class)) + .min(1).max(10) + .defaultValue(4) + .notifyClient() + .build(); + /** * No documentation available. * @@ -92,13 +127,12 @@ public final class ModPotionEffects { .build(); /** - * Adds a shadow to text. + * No documentation available. * - * @since 1.0.0 + * @since 1.2.9 */ - public static final SimpleOption TEXT_SHADOW = SimpleOption.builder() - .comment("Adds a shadow to text") - .node("potion-effects", "text-shadow").type(TypeToken.get(Boolean.class)) + public static final SimpleOption EFFECT_DURATION = SimpleOption.builder() + .node("potion-effects", "effect-duration").type(TypeToken.get(Boolean.class)) .defaultValue(true) .notifyClient() .build(); @@ -106,10 +140,10 @@ public final class ModPotionEffects { /** * No documentation available. * - * @since 1.1.9 + * @since 1.2.9 */ - public static final SimpleOption BACKGROUND = SimpleOption.builder() - .node("potion-effects", "background").type(TypeToken.get(Boolean.class)) + public static final SimpleOption EFFECT_AMPLIFIER = SimpleOption.builder() + .node("potion-effects", "effect-amplifier").type(TypeToken.get(Boolean.class)) .defaultValue(true) .notifyClient() .build(); @@ -117,32 +151,44 @@ public final class ModPotionEffects { /** * No documentation available. * - * @since 1.1.9 + * @since 1.0.0 */ - public static final SimpleOption MINIMAL_MODE = SimpleOption.builder() - .node("potion-effects", "minimal-mode").type(TypeToken.get(Boolean.class)) - .defaultValue(false) + public static final SimpleOption SHOW_IN_INVENTORY = SimpleOption.builder() + .node("potion-effects", "show-in-inventory").type(TypeToken.get(Boolean.class)) + .defaultValue(true) .notifyClient() .build(); /** * No documentation available. * - * @since 1.1.9 + * @since 1.0.0 */ - public static final SimpleOption MINIMAL_MODE_HORIZONTAL = SimpleOption.builder() - .node("potion-effects", "minimal-mode-horizontal").type(TypeToken.get(Boolean.class)) - .defaultValue(false) + public static final SimpleOption SHOW_WHILE_TYPING = SimpleOption.builder() + .node("potion-effects", "show-while-typing").type(TypeToken.get(Boolean.class)) + .defaultValue(true) .notifyClient() .build(); /** * No documentation available. * - * @since 1.1.9 + * @since 1.0.0 */ - public static final SimpleOption BORDER = SimpleOption.builder() - .node("potion-effects", "border").type(TypeToken.get(Boolean.class)) + public static final SimpleOption POTION_BLINK = SimpleOption.builder() + .node("potion-effects", "potion-blink").type(TypeToken.get(Boolean.class)) + .defaultValue(true) + .notifyClient() + .build(); + + /** + * With this enabled, the potion effect icon blinks as well. + * + * @since 1.2.9 + */ + public static final SimpleOption POTION_BLINK_ICON = SimpleOption.builder() + .comment("With this enabled, the potion effect icon blinks as well") + .node("potion-effects", "potion-blink-icon").type(TypeToken.get(Boolean.class)) .defaultValue(false) .notifyClient() .build(); @@ -150,23 +196,23 @@ public final class ModPotionEffects { /** * No documentation available. * - * @since 1.1.9 + * @since 1.0.0 */ - public static final NumberOption BORDER_THICKNESS = NumberOption.number() - .node("potion-effects", "border-thickness").type(TypeToken.get(Float.class)) - .min(0.5F).max(3.0F) - .defaultValue(0.5F) + public static final NumberOption BLINK_DURATION = NumberOption.number() + .node("potion-effects", "blink-duration").type(TypeToken.get(Integer.class)) + .min(2).max(20) + .defaultValue(10) .notifyClient() .build(); /** * No documentation available. * - * @since 1.1.9 + * @since 1.2.9 */ - public static final SimpleOption FORMATTED_DURATIONS = SimpleOption.builder() - .node("potion-effects", "formatted-durations").type(TypeToken.get(Boolean.class)) - .defaultValue(false) + public static final SimpleOption VANILLA_BLINK_COLOR = SimpleOption.builder() + .node("potion-effects", "vanilla-blink-color").type(TypeToken.get(Color.class)) + .defaultValue(new Color(255, 255, 255)) .notifyClient() .build(); @@ -192,6 +238,17 @@ public final class ModPotionEffects { .notifyClient() .build(); + /** + * No documentation available. + * + * @since 1.1.9 + */ + public static final SimpleOption FORMATTED_DURATIONS = SimpleOption.builder() + .node("potion-effects", "formatted-durations").type(TypeToken.get(Boolean.class)) + .defaultValue(false) + .notifyClient() + .build(); + /** * No documentation available. * @@ -204,25 +261,25 @@ public final class ModPotionEffects { .build(); /** - * No documentation available. + * Completely hide the potion effects mod HUD. * - * @since 1.0.0 + * @since 1.2.9 */ - public static final SimpleOption POTION_BLINK = SimpleOption.builder() - .node("potion-effects", "potion-blink").type(TypeToken.get(Boolean.class)) - .defaultValue(true) + public static final SimpleOption HIDE_POTION_STATUS = SimpleOption.builder() + .comment("Completely hide the potion effects mod HUD") + .node("potion-effects", "hide-potion-status").type(TypeToken.get(Boolean.class)) + .defaultValue(false) .notifyClient() .build(); /** * No documentation available. * - * @since 1.0.0 + * @since 1.1.9 */ - public static final NumberOption BLINK_DURATION = NumberOption.number() - .node("potion-effects", "blink-duration").type(TypeToken.get(Integer.class)) - .min(2).max(20) - .defaultValue(10) + public static final SimpleOption BACKGROUND = SimpleOption.builder() + .node("potion-effects", "background").type(TypeToken.get(Boolean.class)) + .defaultValue(true) .notifyClient() .build(); @@ -237,6 +294,29 @@ public final class ModPotionEffects { .notifyClient() .build(); + /** + * No documentation available. + * + * @since 1.1.9 + */ + public static final SimpleOption BORDER = SimpleOption.builder() + .node("potion-effects", "border").type(TypeToken.get(Boolean.class)) + .defaultValue(false) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.1.9 + */ + public static final NumberOption BORDER_THICKNESS = NumberOption.number() + .node("potion-effects", "border-thickness").type(TypeToken.get(Float.class)) + .min(0.5F).max(3.0F) + .defaultValue(0.5F) + .notifyClient() + .build(); + /** * No documentation available. * @@ -248,6 +328,18 @@ public final class ModPotionEffects { .notifyClient() .build(); + /** + * Adds a shadow to text. + * + * @since 1.0.0 + */ + public static final SimpleOption TEXT_SHADOW = SimpleOption.builder() + .comment("Adds a shadow to text") + .node("potion-effects", "text-shadow").type(TypeToken.get(Boolean.class)) + .defaultValue(true) + .notifyClient() + .build(); + /** * No documentation available. * @@ -259,6 +351,28 @@ public final class ModPotionEffects { .notifyClient() .build(); + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption COLOR_INFO_BASED_ON_EFFECT = SimpleOption.builder() + .node("potion-effects", "color-info-based-on-effect").type(TypeToken.get(Boolean.class)) + .defaultValue(false) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption SHOW_EFFECT_BACKGROUND = SimpleOption.builder() + .node("potion-effects", "show-effect-background").type(TypeToken.get(Boolean.class)) + .defaultValue(true) + .notifyClient() + .build(); + /** * No documentation available. * @@ -273,14 +387,50 @@ public final class ModPotionEffects { /** * No documentation available. * - * @since 1.0.0 + * @since 1.2.9 */ - public static final SimpleOption DURATION_COLOR = SimpleOption.builder() - .node("potion-effects", "duration-color").type(TypeToken.get(Color.class)) + public static final SimpleOption INFO_COLOR = SimpleOption.builder() + .node("potion-effects", "info-color").type(TypeToken.get(Color.class)) .defaultValue(new Color(255, 255, 255)) .notifyClient() .build(); + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final NumberOption VANILLA_ICON_SCALE = NumberOption.number() + .node("potion-effects", "vanilla-icon-scale").type(TypeToken.get(Float.class)) + .min(0.5F).max(1.25F) + .defaultValue(1.0F) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final NumberOption VANILLA_TEXT_SCALE = NumberOption.number() + .node("potion-effects", "vanilla-text-scale").type(TypeToken.get(Float.class)) + .min(0.25F).max(2.0F) + .defaultValue(1.0F) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.0.0 + */ + public static final NumberOption SCALE = NumberOption.number() + .node("potion-effects", "scale").type(TypeToken.get(Float.class)) + .min(0.25F).max(5.0F) + .defaultValue(1.0F) + .notifyClient() + .build(); + /** * No documentation available. * @@ -545,6 +695,30 @@ public final class ModPotionEffects { .notifyClient() .build(); + /** + * No documentation available. + * + * @since 1.1.9 + */ + @Deprecated + public static final SimpleOption MINIMAL_MODE = SimpleOption.builder() + .node("potion-effects", "minimal-mode").type(TypeToken.get(Boolean.class)) + .defaultValue(false) + .notifyClient() + .build(); + + /** + * No documentation available. + * + * @since 1.0.0 + */ + @Deprecated + public static final SimpleOption DURATION_COLOR = SimpleOption.builder() + .node("potion-effects", "duration-color").type(TypeToken.get(Color.class)) + .defaultValue(new Color(255, 255, 255)) + .notifyClient() + .build(); + private ModPotionEffects() { } diff --git a/api/src/main/java/com/lunarclient/apollo/mods/impl/ModScoreboard.java b/api/src/main/java/com/lunarclient/apollo/mods/impl/ModScoreboard.java index b0425df7..21a39371 100644 --- a/api/src/main/java/com/lunarclient/apollo/mods/impl/ModScoreboard.java +++ b/api/src/main/java/com/lunarclient/apollo/mods/impl/ModScoreboard.java @@ -115,6 +115,17 @@ public final class ModScoreboard { .notifyClient() .build(); + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption DISPLAY_TOGGLE_MESSAGE = SimpleOption.builder() + .node("scoreboard", "display-toggle-message").type(TypeToken.get(Boolean.class)) + .defaultValue(true) + .notifyClient() + .build(); + /** * No documentation available. * diff --git a/api/src/main/java/com/lunarclient/apollo/mods/impl/ModScreenshot.java b/api/src/main/java/com/lunarclient/apollo/mods/impl/ModScreenshot.java index 2945c34b..9859a34b 100644 --- a/api/src/main/java/com/lunarclient/apollo/mods/impl/ModScreenshot.java +++ b/api/src/main/java/com/lunarclient/apollo/mods/impl/ModScreenshot.java @@ -88,6 +88,17 @@ public final class ModScreenshot { .notifyClient() .build(); + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption DELETE_OPTION = SimpleOption.builder() + .node("screenshot", "delete-option").type(TypeToken.get(Boolean.class)) + .defaultValue(true) + .notifyClient() + .build(); + /** * A screenshot file saved with world details enabled has metadata that contains your player coordinates, the biome, and more. * diff --git a/api/src/main/java/com/lunarclient/apollo/mods/impl/ModSkyblock.java b/api/src/main/java/com/lunarclient/apollo/mods/impl/ModSkyblock.java index e5ca424d..c46082b9 100644 --- a/api/src/main/java/com/lunarclient/apollo/mods/impl/ModSkyblock.java +++ b/api/src/main/java/com/lunarclient/apollo/mods/impl/ModSkyblock.java @@ -59,25 +59,25 @@ public final class ModSkyblock { .build(); /** - * Adds tab completion to the /warp command. + * Fixes being unable to use the "Pick Block" keybind on items when it is bound to a mouse button. * - * @since 1.2.2 + * @since 1.2.5 */ - public static final SimpleOption SKYBLOCK_AUTOCOMPLETE_WARPS = SimpleOption.builder() - .comment("Adds tab completion to the /warp command.") - .node("skyblock", "skyblock-autocomplete-warps").type(TypeToken.get(Boolean.class)) + public static final SimpleOption MIDDLE_CLICK_ARMOR_FIX = SimpleOption.builder() + .comment("Fixes being unable to use the \"Pick Block\" keybind on items when it is bound to a mouse button.") + .node("skyblock", "middle-click-armor-fix").type(TypeToken.get(Boolean.class)) .defaultValue(true) .notifyClient() .build(); /** - * Fixes being unable to use the "Pick Block" keybind on items when it is bound to a mouse button. + * Adds tab completion to the /warp command. * - * @since 1.2.5 + * @since 1.2.2 */ - public static final SimpleOption MIDDLE_CLICK_ARMOR_FIX = SimpleOption.builder() - .comment("Fixes being unable to use the \"Pick Block\" keybind on items when it is bound to a mouse button.") - .node("skyblock", "middle-click-armor-fix").type(TypeToken.get(Boolean.class)) + public static final SimpleOption SKYBLOCK_AUTOCOMPLETE_WARPS = SimpleOption.builder() + .comment("Adds tab completion to the /warp command.") + .node("skyblock", "skyblock-autocomplete-warps").type(TypeToken.get(Boolean.class)) .defaultValue(true) .notifyClient() .build(); @@ -204,7 +204,7 @@ public final class ModSkyblock { public static final NumberOption CUSTOM_CHIME_VOLUME = NumberOption.number() .node("skyblock", "custom-chime-volume").type(TypeToken.get(Float.class)) .min(0.0F).max(1.0F) - .defaultValue(5.0F) + .defaultValue(0.5F) .notifyClient() .build(); diff --git a/api/src/main/java/com/lunarclient/apollo/mods/impl/ModTierTagger.java b/api/src/main/java/com/lunarclient/apollo/mods/impl/ModTierTagger.java index 87d3bfa8..a751c027 100644 --- a/api/src/main/java/com/lunarclient/apollo/mods/impl/ModTierTagger.java +++ b/api/src/main/java/com/lunarclient/apollo/mods/impl/ModTierTagger.java @@ -28,7 +28,7 @@ import java.awt.Color; /** - * Show player's PvP tier on their Name Tag. + * Show player's PvP tier on their Name Tag. Also has a /lctiers command to look up player tiers. * * @since 1.1.9 */ @@ -122,6 +122,17 @@ public final class ModTierTagger { .notifyClient() .build(); + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption COLOR_MT1 = SimpleOption.builder() + .node("tier-tagger", "color-m-t1").type(TypeToken.get(Color.class)) + .defaultValue(new Color(234, 193, 79)) + .notifyClient() + .build(); + /** * No documentation available. * @@ -144,6 +155,17 @@ public final class ModTierTagger { .notifyClient() .build(); + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption COLOR_MT2 = SimpleOption.builder() + .node("tier-tagger", "color-m-t2").type(TypeToken.get(Color.class)) + .defaultValue(new Color(150, 160, 174)) + .notifyClient() + .build(); + /** * No documentation available. * @@ -166,6 +188,17 @@ public final class ModTierTagger { .notifyClient() .build(); + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption COLOR_MT3 = SimpleOption.builder() + .node("tier-tagger", "color-m-t3").type(TypeToken.get(Color.class)) + .defaultValue(new Color(200, 120, 60)) + .notifyClient() + .build(); + /** * No documentation available. * @@ -188,6 +221,17 @@ public final class ModTierTagger { .notifyClient() .build(); + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption COLOR_MT4 = SimpleOption.builder() + .node("tier-tagger", "color-m-t4").type(TypeToken.get(Color.class)) + .defaultValue(new Color(101, 91, 121)) + .notifyClient() + .build(); + /** * No documentation available. * @@ -210,6 +254,17 @@ public final class ModTierTagger { .notifyClient() .build(); + /** + * No documentation available. + * + * @since 1.2.9 + */ + public static final SimpleOption COLOR_MT5 = SimpleOption.builder() + .node("tier-tagger", "color-m-t5").type(TypeToken.get(Color.class)) + .defaultValue(new Color(101, 91, 121)) + .notifyClient() + .build(); + /** * No documentation available. * diff --git a/api/src/main/java/com/lunarclient/apollo/module/chat/ChatButton.java b/api/src/main/java/com/lunarclient/apollo/module/chat/ChatButton.java new file mode 100644 index 00000000..441bbd93 --- /dev/null +++ b/api/src/main/java/com/lunarclient/apollo/module/chat/ChatButton.java @@ -0,0 +1,123 @@ +/* + * This file is part of Apollo, licensed under the MIT License. + * + * Copyright (c) 2026 Moonsworth + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +package com.lunarclient.apollo.module.chat; + +import com.lunarclient.apollo.common.button.ApolloButton; +import com.lunarclient.apollo.common.button.ApolloButtonSize; +import java.awt.Color; +import lombok.Builder; +import lombok.Getter; +import lombok.experimental.SuperBuilder; +import org.jetbrains.annotations.NotNull; + +/** + * Represents a chat button which can be shown on the client, placed in a + * single fixed-size box anchored in the strip between the chat input field + * and the chat log, visible while the chat screen is open. + * + * @since 1.2.9 + */ +@Getter +@SuperBuilder(toBuilder = true) +public final class ChatButton extends ApolloButton { + + /** + * The width of the button box. + * + * @since 1.2.9 + */ + public static final float BOX_WIDTH = 320.0F; + + /** + * The height of the button box. + * + * @since 1.2.9 + */ + public static final float BOX_HEIGHT = 20.0F; + + /** + * The maximum number of buttons in the box. + * + * @since 1.2.9 + */ + public static final int MAX_BUTTONS = 25; + + /** + * A suggested small size (56x16); five fit side by side in the + * button box. + * + * @since 1.2.9 + */ + public static final ApolloButtonSize SIZE_SMALL = ApolloButtonSize.of(56.0F, 16.0F); + + /** + * A suggested medium size (96x16); three fit side by side in the + * button box. + * + * @since 1.2.9 + */ + public static final ApolloButtonSize SIZE_MEDIUM = ApolloButtonSize.of(96.0F, 16.0F); + + /** + * A suggested icon size (16x16) for square icon-only buttons. + * + * @since 1.2.9 + */ + public static final ApolloButtonSize SIZE_ICON = ApolloButtonSize.of(16.0F); + + /** + * The suggested default background {@link Color} of a chat button, + * matching the vanilla chat background fill. + * + * @since 1.2.9 + */ + public static final Color DEFAULT_BACKGROUND_COLOR = new Color(0, 0, 0, 128); + + /** + * The suggested default border {@link Color} of a chat button, matching + * the background so buttons read as part of the chat. + * + * @since 1.2.9 + */ + public static final Color DEFAULT_BORDER_COLOR = new Color(0, 0, 0, 128); + + /** + * Returns the background {@link Color} of this button. + * + * @return the background color + * @since 1.2.9 + */ + @Builder.Default + @NotNull Color backgroundColor = DEFAULT_BACKGROUND_COLOR; + + /** + * Returns the border {@link Color} of this button. + * + * @return the border color + * @since 1.2.9 + */ + @Builder.Default + @NotNull Color borderColor = DEFAULT_BORDER_COLOR; + +} diff --git a/api/src/main/java/com/lunarclient/apollo/module/chat/ChatModule.java b/api/src/main/java/com/lunarclient/apollo/module/chat/ChatModule.java index c6190500..2c4f41dd 100644 --- a/api/src/main/java/com/lunarclient/apollo/module/chat/ChatModule.java +++ b/api/src/main/java/com/lunarclient/apollo/module/chat/ChatModule.java @@ -23,11 +23,28 @@ */ package com.lunarclient.apollo.module.chat; +import com.lunarclient.apollo.common.button.ApolloButtonShape; +import com.lunarclient.apollo.common.button.ApolloButtonSize; +import com.lunarclient.apollo.common.button.ApolloButtonTooltip; +import com.lunarclient.apollo.common.button.action.ApolloButtonAction; +import com.lunarclient.apollo.common.button.content.ApolloButtonContent; +import com.lunarclient.apollo.common.icon.ItemStackIcon; +import com.lunarclient.apollo.common.location.HudPosition; import com.lunarclient.apollo.module.ApolloModule; import com.lunarclient.apollo.module.ModuleDefinition; +import com.lunarclient.apollo.option.ListOption; +import com.lunarclient.apollo.option.Option; +import com.lunarclient.apollo.option.SimpleOption; import com.lunarclient.apollo.recipients.Recipients; +import io.leangen.geantyref.TypeToken; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.Collection; +import java.util.List; import net.kyori.adventure.text.Component; +import net.kyori.adventure.text.format.NamedTextColor; import org.jetbrains.annotations.ApiStatus; +import org.jetbrains.annotations.Nullable; /** * Represents the chat module. @@ -38,6 +55,68 @@ @ModuleDefinition(id = "chat", name = "Chat") public abstract class ChatModule extends ApolloModule { + /** + * Controls whether live {@link ChatButton} content is automatically + * re-resolved and re-sent to viewers. + * + *

When enabled without further setup, updates are always sent to + * every player holding live buttons, even while their chat is closed. + * Also enable the packet enrichment module and its player chat + * open/close packets and events to only send updates to players who + * currently have their chat open.

+ * + * @since 1.2.9 + */ + public static final SimpleOption BROADCAST_LIVE_BUTTONS = Option.builder() + .comment( + "Set to 'true' to automatically re-send resolved live chat button content, otherwise 'false'.", + "When enabled, updates are always sent, even to players whose chat is closed; also enable", + "the packet enrichment module and its player chat open/close packets and events to only", + "send updates to players who currently have their chat open." + ) + .node("buttons", "live-broadcast").type(TypeToken.get(Boolean.class)) + .defaultValue(false).build(); + + /** + * Controls whether the {@link #DEFAULT_BUTTONS} are displayed to + * players when they join. + * + * @since 1.2.9 + */ + public static final SimpleOption SEND_DEFAULT_BUTTONS = Option.builder() + .comment("Set to 'true' to display the default buttons to players when they join, otherwise 'false'.") + .node("buttons", "send-defaults").type(TypeToken.get(Boolean.class)) + .defaultValue(false).build(); + + /** + * The default {@link ChatButton}s displayed to joining players while + * {@link #SEND_DEFAULT_BUTTONS} is enabled. + * + * @since 1.2.9 + */ + public static final ListOption DEFAULT_BUTTONS = Option.list() + .comment( + "Sets the default buttons to display to players when they join, while send-defaults is enabled.", + "Text is read as legacy strings ('&'-color codes) and icons as icon definitions; live values", + "are only available through the API." + ) + .node("buttons", "defaults").type(new TypeToken>() {}) + .defaultValue(ChatModule.createDefaultButtons()) + .build(); + + protected ChatModule() { + this.registerOptions( + ChatModule.BROADCAST_LIVE_BUTTONS, + ChatModule.SEND_DEFAULT_BUTTONS, + ChatModule.DEFAULT_BUTTONS + ); + } + + @Override + public boolean isClientNotify() { + return true; + } + /** * Displays the message to the {@link Recipients}. * @@ -57,4 +136,130 @@ public abstract class ChatModule extends ApolloModule { */ public abstract void removeLiveChatMessage(Recipients recipients, int messageId); + /** + * Displays the {@link ChatButton}s to the {@link Recipients}. + * + * @param recipients the recipients that are receiving the packet + * @param buttons the chat buttons + * @since 1.2.9 + */ + public abstract void displayChatButtons(Recipients recipients, Collection buttons); + + /** + * Displays the {@link ChatButton} to the {@link Recipients}. + * + * @param recipients the recipients that are receiving the packet + * @param button the chat button + * @since 1.2.9 + */ + public abstract void displayChatButton(Recipients recipients, ChatButton button); + + /** + * Removes the {@link ChatButton} from the {@link Recipients}. + * + * @param recipients the recipients that are receiving the packet + * @param buttonId the chat button id + * @since 1.2.9 + */ + public abstract void removeChatButton(Recipients recipients, String buttonId); + + /** + * Removes the {@link ChatButton} from the {@link Recipients}. + * + * @param recipients the recipients that are receiving the packet + * @param button the chat button + * @since 1.2.9 + */ + public abstract void removeChatButton(Recipients recipients, ChatButton button); + + /** + * Resets all {@link ChatButton}s for the {@link Recipients}. + * + * @param recipients the recipients that are receiving the packet + * @since 1.2.9 + */ + public abstract void resetChatButtons(Recipients recipients); + + /** + * Updates the content and tooltip of a previously displayed + * {@link ChatButton} for the {@link Recipients}. + * + * @param recipients the recipients that are receiving the packet + * @param buttonId the chat button id + * @param content the new button content + * @param tooltip the new tooltip, or {@code null} to clear the tooltip + * @since 1.2.9 + */ + public abstract void updateChatButton(Recipients recipients, String buttonId, + ApolloButtonContent content, @Nullable ApolloButtonTooltip tooltip); + + /** + * Updates only the content of a previously displayed + * {@link ChatButton} for the {@link Recipients}, keeping the + * previous tooltip. + * + * @param recipients the recipients that are receiving the packet + * @param buttonId the chat button id + * @param content the new button content + * @since 1.2.9 + */ + public abstract void updateChatButtonContent(Recipients recipients, String buttonId, + ApolloButtonContent content); + + /** + * Updates only the tooltip of a previously displayed + * {@link ChatButton} for the {@link Recipients}, keeping the + * previous content. + * + * @param recipients the recipients that are receiving the packet + * @param buttonId the chat button id + * @param tooltip the new tooltip, or {@code null} to clear the tooltip + * @since 1.2.9 + */ + public abstract void updateChatButtonTooltip(Recipients recipients, String buttonId, + @Nullable ApolloButtonTooltip tooltip); + + private static List createDefaultButtons() { + ChatButton teamChat = ChatButton.builder() + .id("team-chat") + .position(HudPosition.of(0, 2)) + .size(ApolloButtonSize.of(70, 16)) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder().itemName("SHIELD").build()) + .append(Component.text("Team Chat", NamedTextColor.GREEN)) + .build()) + .tooltip(ApolloButtonTooltip.of(Component.text("Click to switch!", NamedTextColor.YELLOW))) + .onClick(ApolloButtonAction.runCommand("/channel team")) + .build(); + + ChatButton publicChat = ChatButton.builder() + .id("public-chat") + .position(HudPosition.of(76, 2)) + .size(ApolloButtonSize.of(78, 16)) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder().itemName("OAK_SIGN").build()) + .append(Component.text("Public Chat")) + .build()) + .tooltip(ApolloButtonTooltip.of(Component.text("Click to switch!", NamedTextColor.YELLOW))) + .onClick(ApolloButtonAction.runCommand("/channel public")) + .build(); + + ChatButton partyChat = ChatButton.builder() + .id("party-chat") + .position(HudPosition.of(160, 2)) + .size(ApolloButtonSize.of(76, 16)) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder().itemName("FIREWORK_ROCKET").build()) + .append(Component.text("Party Chat", NamedTextColor.LIGHT_PURPLE)) + .build()) + .tooltip(ApolloButtonTooltip.of(Component.text("Click to switch!", NamedTextColor.YELLOW))) + .onClick(ApolloButtonAction.runCommand("/channel party")) + .build(); + + return new ArrayList<>(Arrays.asList(teamChat, publicChat, partyChat)); + } + } diff --git a/api/src/main/java/com/lunarclient/apollo/module/heightlimit/HeightLimit.java b/api/src/main/java/com/lunarclient/apollo/module/heightlimit/HeightLimit.java new file mode 100644 index 00000000..78035f57 --- /dev/null +++ b/api/src/main/java/com/lunarclient/apollo/module/heightlimit/HeightLimit.java @@ -0,0 +1,70 @@ +/* + * This file is part of Apollo, licensed under the MIT License. + * + * Copyright (c) 2026 Moonsworth + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +package com.lunarclient.apollo.module.heightlimit; + +import lombok.Builder; +import lombok.Getter; +import net.kyori.adventure.text.Component; +import org.jetbrains.annotations.Nullable; +import org.jetbrains.annotations.Range; + +/** + * Represents a height limit which can be shown on the client. + * + * @since 1.2.9 + */ +@Getter +@Builder +public final class HeightLimit { + + /** + * Returns the height limit {@link String} world name. + * + * @return the height limit world name + * @since 1.2.9 + */ + String world; + + /** + * Returns the height limit {@link Integer} Y level where block placement + * is denied. + * + *

The highest buildable layer is {@code limit - 1}.

+ * + * @return the height limit + * @since 1.2.9 + */ + @Range(from = 1, to = Integer.MAX_VALUE) int limit; + + /** + * Returns the height limit {@link Component} display name. + * + *

Shown on the client's height limit HUD.

+ * + * @return the height limit display name + * @since 1.2.9 + */ + @Nullable Component displayName; + +} diff --git a/api/src/main/java/com/lunarclient/apollo/module/heightlimit/HeightLimitModule.java b/api/src/main/java/com/lunarclient/apollo/module/heightlimit/HeightLimitModule.java new file mode 100644 index 00000000..86431321 --- /dev/null +++ b/api/src/main/java/com/lunarclient/apollo/module/heightlimit/HeightLimitModule.java @@ -0,0 +1,118 @@ +/* + * This file is part of Apollo, licensed under the MIT License. + * + * Copyright (c) 2026 Moonsworth + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +package com.lunarclient.apollo.module.heightlimit; + +import com.lunarclient.apollo.module.ApolloModule; +import com.lunarclient.apollo.module.ModuleDefinition; +import com.lunarclient.apollo.option.ListOption; +import com.lunarclient.apollo.option.Option; +import com.lunarclient.apollo.recipients.Recipients; +import io.leangen.geantyref.TypeToken; +import java.util.ArrayList; +import java.util.Collections; +import java.util.List; +import net.kyori.adventure.text.Component; +import net.kyori.adventure.text.format.NamedTextColor; +import org.jetbrains.annotations.ApiStatus; + +/** + * Represents the height limit module. + * + *

Sets the build-height limit shown by the clients Height Limit mod + * (block overlay and HUD display). The client resolves the active limit + * against the world the player is currently in.

+ * + *

This module only provides a visual indicator for the player. The + * server is still responsible for cancelling block placement above the + * height limit.

+ * + * @since 1.2.9 + */ +@ApiStatus.NonExtendable +@ModuleDefinition(id = "height_limit", name = "Height Limit") +public abstract class HeightLimitModule extends ApolloModule { + + private static final HeightLimit OVERWORLD_HEIGHT_LIMIT = HeightLimit.builder() + .world("world") + .limit(200) + .displayName(Component.text("Overworld", NamedTextColor.GOLD)) + .build(); + + /** + * Returns the default list of height limits to send to the player. + * + * @since 1.2.9 + */ + public static final ListOption DEFAULT_HEIGHT_LIMITS = Option.list() + .comment("Sets the default height limits to send to the player.") + .node("default-height-limits").type(new TypeToken>() {}) + .defaultValue(new ArrayList<>(Collections.singletonList(HeightLimitModule.OVERWORLD_HEIGHT_LIMIT))) + .build(); + + protected HeightLimitModule() { + this.registerOptions( + ApolloModule.ENABLE_OPTION_OFF, + HeightLimitModule.DEFAULT_HEIGHT_LIMITS + ); + } + + /** + * Overrides the {@link HeightLimit} for the {@link Recipients}. + * + *

Sending a height limit for an already-known world replaces + * that worlds entry.

+ * + * @param recipients the recipients that are receiving the packet + * @param heightLimit the height limit + * @since 1.2.9 + */ + public abstract void overrideHeightLimit(Recipients recipients, HeightLimit heightLimit); + + /** + * Removes the {@link HeightLimit} from the {@link Recipients}. + * + * @param recipients the recipients that are receiving the packet + * @param world the world name + * @since 1.2.9 + */ + public abstract void removeHeightLimit(Recipients recipients, String world); + + /** + * Removes the {@link HeightLimit} from the {@link Recipients}. + * + * @param recipients the recipients that are receiving the packet + * @param heightLimit the height limit + * @since 1.2.9 + */ + public abstract void removeHeightLimit(Recipients recipients, HeightLimit heightLimit); + + /** + * Resets all {@link HeightLimit}s for the {@link Recipients}. + * + * @param recipients the recipients that are receiving the packet + * @since 1.2.9 + */ + public abstract void resetHeightLimits(Recipients recipients); + +} diff --git a/api/src/main/java/com/lunarclient/apollo/module/inventory/InventoryButton.java b/api/src/main/java/com/lunarclient/apollo/module/inventory/InventoryButton.java new file mode 100644 index 00000000..05da39f8 --- /dev/null +++ b/api/src/main/java/com/lunarclient/apollo/module/inventory/InventoryButton.java @@ -0,0 +1,148 @@ +/* + * This file is part of Apollo, licensed under the MIT License. + * + * Copyright (c) 2026 Moonsworth + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +package com.lunarclient.apollo.module.inventory; + +import com.lunarclient.apollo.common.button.ApolloButton; +import com.lunarclient.apollo.common.button.ApolloButtonSize; +import java.awt.Color; +import lombok.Builder; +import lombok.Getter; +import lombok.experimental.SuperBuilder; +import org.jetbrains.annotations.NotNull; + +/** + * Represents an inventory button which can be shown on the client, placed + * in one of the two boxes in the player inventory. + * + * @since 1.2.9 + */ +@Getter +@SuperBuilder(toBuilder = true) +public final class InventoryButton extends ApolloButton { + + /** + * The width of each button box. + * + * @since 1.2.9 + */ + public static final float BOX_WIDTH = 92.0F; + + /** + * The height of each button box. + * + * @since 1.2.9 + */ + public static final float BOX_HEIGHT = 166.0F; + + /** + * The maximum number of buttons per box. + * + * @since 1.2.9 + */ + public static final int MAX_BUTTONS_PER_BOX = 25; + + /** + * The suggested default background {@link Color} of an inventory button. + * + * @since 1.2.9 + */ + public static final Color DEFAULT_BACKGROUND_COLOR = new Color(255, 255, 255, 40); + + /** + * The suggested default border {@link Color} of an inventory button. + * + * @since 1.2.9 + */ + public static final Color DEFAULT_BORDER_COLOR = new Color(37, 37, 37, 128); + + /** + * A suggested small square size (26x26); three fit side by side + * in a button box row. + * + * @since 1.2.9 + */ + public static final ApolloButtonSize SIZE_SMALL = ApolloButtonSize.of(26.0F); + + /** + * A suggested medium square size (40x40); two fit side by side + * in a button box row. + * + * @since 1.2.9 + */ + public static final ApolloButtonSize SIZE_MEDIUM = ApolloButtonSize.of(40.0F); + + /** + * A suggested large square size (84x84), spanning a full button + * box row. + * + * @since 1.2.9 + */ + public static final ApolloButtonSize SIZE_LARGE = ApolloButtonSize.of(84.0F); + + /** + * A suggested wide size (80x26), fitting text buttons spanning + * the box width. + * + * @since 1.2.9 + */ + public static final ApolloButtonSize SIZE_WIDE = ApolloButtonSize.of(80.0F, 26.0F); + + /** + * Returns the {@link InventoryType} this button belongs to. + * + * @return the inventory type + * @since 1.2.9 + */ + @NotNull InventoryType inventoryType; + + /** + * Returns the {@link InventoryButtonBox} this button is placed in. + * + *

Two fixed-size boxes ({@value #BOX_WIDTH}x{@value #BOX_HEIGHT}) + * show in the player inventory on its left and right side.

+ * + * @return the button box + * @since 1.2.9 + */ + @NotNull InventoryButtonBox box; + + /** + * Returns the background {@link Color} of this button. + * + * @return the background color + * @since 1.2.9 + */ + @Builder.Default + @NotNull Color backgroundColor = DEFAULT_BACKGROUND_COLOR; + + /** + * Returns the border {@link Color} of this button. + * + * @return the border color + * @since 1.2.9 + */ + @Builder.Default + @NotNull Color borderColor = DEFAULT_BORDER_COLOR; + +} diff --git a/api/src/main/java/com/lunarclient/apollo/module/inventory/InventoryButtonBox.java b/api/src/main/java/com/lunarclient/apollo/module/inventory/InventoryButtonBox.java new file mode 100644 index 00000000..9d49341f --- /dev/null +++ b/api/src/main/java/com/lunarclient/apollo/module/inventory/InventoryButtonBox.java @@ -0,0 +1,35 @@ +/* + * This file is part of Apollo, licensed under the MIT License. + * + * Copyright (c) 2026 Moonsworth + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +package com.lunarclient.apollo.module.inventory; + +/** + * Represents the box an inventory button is placed in. + * + * @since 1.2.9 + */ +public enum InventoryButtonBox { + LEFT, + RIGHT + +} diff --git a/api/src/main/java/com/lunarclient/apollo/module/inventory/InventoryModule.java b/api/src/main/java/com/lunarclient/apollo/module/inventory/InventoryModule.java index ed5861e3..450a7043 100644 --- a/api/src/main/java/com/lunarclient/apollo/module/inventory/InventoryModule.java +++ b/api/src/main/java/com/lunarclient/apollo/module/inventory/InventoryModule.java @@ -23,9 +23,28 @@ */ package com.lunarclient.apollo.module.inventory; +import com.lunarclient.apollo.common.button.ApolloButtonShape; +import com.lunarclient.apollo.common.button.ApolloButtonTooltip; +import com.lunarclient.apollo.common.button.action.ApolloButtonAction; +import com.lunarclient.apollo.common.button.content.ApolloButtonContent; +import com.lunarclient.apollo.common.icon.ItemStackIcon; +import com.lunarclient.apollo.common.location.HudPosition; import com.lunarclient.apollo.module.ApolloModule; import com.lunarclient.apollo.module.ModuleDefinition; +import com.lunarclient.apollo.option.ListOption; +import com.lunarclient.apollo.option.Option; +import com.lunarclient.apollo.option.SimpleOption; +import com.lunarclient.apollo.recipients.Recipients; +import io.leangen.geantyref.TypeToken; +import java.awt.Color; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.Collection; +import java.util.List; +import net.kyori.adventure.text.Component; +import net.kyori.adventure.text.format.NamedTextColor; import org.jetbrains.annotations.ApiStatus; +import org.jetbrains.annotations.Nullable; /** * Represents the inventory module. @@ -34,10 +53,64 @@ */ @ApiStatus.NonExtendable @ModuleDefinition(id = "inventory", name = "Inventory") -public class InventoryModule extends ApolloModule { +public abstract class InventoryModule extends ApolloModule { + + /** + * Controls whether live {@link InventoryButton} content is automatically + * re-resolved and re-sent to viewers. + * + *

When enabled without further setup, updates are always sent to + * every player holding live buttons, even while their inventory is + * closed. Also enable the packet enrichment module and its player + * inventory open/close packets and events to only send updates to + * players who currently have their inventory open.

+ * + * @since 1.2.9 + */ + public static final SimpleOption BROADCAST_LIVE_BUTTONS = Option.builder() + .comment( + "Set to 'true' to automatically re-send resolved live inventory button content, otherwise 'false'.", + "When enabled, updates are always sent, even to players whose inventory is closed; also enable", + "the packet enrichment module and its player inventory open/close packets and events to only", + "send updates to players who currently have their inventory open." + ) + .node("buttons", "live-broadcast").type(TypeToken.get(Boolean.class)) + .defaultValue(false).build(); + + /** + * Controls whether the {@link #DEFAULT_BUTTONS} are displayed to + * players when they join. + * + * @since 1.2.9 + */ + public static final SimpleOption SEND_DEFAULT_BUTTONS = Option.builder() + .comment("Set to 'true' to display the default buttons to players when they join, otherwise 'false'.") + .node("buttons", "send-defaults").type(TypeToken.get(Boolean.class)) + .defaultValue(false).build(); + + /** + * The default {@link InventoryButton}s displayed to joining players + * while {@link #SEND_DEFAULT_BUTTONS} is enabled. + * + * @since 1.2.9 + */ + public static final ListOption DEFAULT_BUTTONS = Option.list() + .comment( + "Sets the default buttons to display to players when they join, while send-defaults is enabled.", + "Text is read as legacy strings ('&'-color codes) and icons as icon definitions; live values", + "are only available through the API." + ) + .node("buttons", "defaults").type(new TypeToken>() {}) + .defaultValue(InventoryModule.createDefaultButtons()) + .build(); protected InventoryModule() { - this.registerOptions(ApolloModule.ENABLE_OPTION_OFF); + this.registerOptions( + ApolloModule.ENABLE_OPTION_OFF, + InventoryModule.BROADCAST_LIVE_BUTTONS, + InventoryModule.SEND_DEFAULT_BUTTONS, + InventoryModule.DEFAULT_BUTTONS + ); } @Override @@ -45,4 +118,250 @@ public boolean isClientNotify() { return true; } + /** + * Displays the {@link InventoryButton}s to the {@link Recipients}. + * + * @param recipients the recipients that are receiving the packet + * @param buttons the inventory buttons + * @since 1.2.9 + */ + public abstract void displayInventoryButtons(Recipients recipients, Collection buttons); + + /** + * Displays the {@link InventoryButton} to the {@link Recipients}. + * + * @param recipients the recipients that are receiving the packet + * @param button the inventory button + * @since 1.2.9 + */ + public abstract void displayInventoryButton(Recipients recipients, InventoryButton button); + + /** + * Removes the {@link InventoryButton} from the {@link Recipients}. + * + * @param recipients the recipients that are receiving the packet + * @param buttonId the inventory button id + * @since 1.2.9 + */ + public abstract void removeInventoryButton(Recipients recipients, String buttonId); + + /** + * Removes the {@link InventoryButton} from the {@link Recipients}. + * + * @param recipients the recipients that are receiving the packet + * @param button the inventory button + * @since 1.2.9 + */ + public abstract void removeInventoryButton(Recipients recipients, InventoryButton button); + + /** + * Resets all {@link InventoryButton}s for the {@link Recipients}. + * + * @param recipients the recipients that are receiving the packet + * @since 1.2.9 + */ + public abstract void resetInventoryButtons(Recipients recipients); + + /** + * Updates the content and tooltip of a previously displayed + * {@link InventoryButton} for the {@link Recipients}. + * + * @param recipients the recipients that are receiving the packet + * @param buttonId the inventory button id + * @param content the new button content + * @param tooltip the new tooltip, or {@code null} to clear the tooltip + * @since 1.2.9 + */ + public abstract void updateInventoryButton(Recipients recipients, String buttonId, + ApolloButtonContent content, @Nullable ApolloButtonTooltip tooltip); + + /** + * Updates only the content of a previously displayed + * {@link InventoryButton} for the {@link Recipients}, keeping the + * previous tooltip. + * + * @param recipients the recipients that are receiving the packet + * @param buttonId the inventory button id + * @param content the new button content + * @since 1.2.9 + */ + public abstract void updateInventoryButtonContent(Recipients recipients, String buttonId, + ApolloButtonContent content); + + /** + * Updates only the tooltip of a previously displayed + * {@link InventoryButton} for the {@link Recipients}, keeping the + * previous content. + * + * @param recipients the recipients that are receiving the packet + * @param buttonId the inventory button id + * @param tooltip the new tooltip, or {@code null} to clear the tooltip + * @since 1.2.9 + */ + public abstract void updateInventoryButtonTooltip(Recipients recipients, String buttonId, + @Nullable ApolloButtonTooltip tooltip); + + private static List createDefaultButtons() { + InventoryButton shop = InventoryButton.builder() + .id("shop") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.LEFT) + .position(HudPosition.of(4, 4)) + .size(InventoryButton.SIZE_MEDIUM) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder().itemName("EMERALD").build()) + .build()) + .tooltip(ApolloButtonTooltip.of( + Component.text("Shop", NamedTextColor.GREEN), + Component.text("Browse categories and buy items", NamedTextColor.GRAY), + Component.text("Click to open", NamedTextColor.YELLOW))) + .onClick(ApolloButtonAction.runCommand("/shop")) + .build(); + + InventoryButton spawn = InventoryButton.builder() + .id("spawn") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.LEFT) + .position(HudPosition.of(48, 4)) + .size(InventoryButton.SIZE_MEDIUM) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder().itemName("RED_BED").build()) + .build()) + .tooltip(ApolloButtonTooltip.of( + Component.text("Spawn", NamedTextColor.AQUA), + Component.text("Teleport back to spawn", NamedTextColor.GRAY), + Component.text("Click to teleport", NamedTextColor.YELLOW))) + .onClick(ApolloButtonAction.runCommand("/spawn")) + .build(); + + InventoryButton warps = InventoryButton.builder() + .id("warps") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.LEFT) + .position(HudPosition.of(4, 48)) + .size(InventoryButton.SIZE_MEDIUM) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder().itemName("COMPASS").build()) + .build()) + .tooltip(ApolloButtonTooltip.of( + Component.text("Warps", NamedTextColor.AQUA), + Component.text("Browse public warps", NamedTextColor.GRAY), + Component.text("Click to teleport", NamedTextColor.YELLOW))) + .onClick(ApolloButtonAction.runCommand("/warps")) + .build(); + + InventoryButton enderChest = InventoryButton.builder() + .id("enderchest") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.LEFT) + .position(HudPosition.of(48, 48)) + .size(InventoryButton.SIZE_MEDIUM) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder().itemName("ENDER_CHEST").build()) + .build()) + .tooltip(ApolloButtonTooltip.of( + Component.text("Ender Chest", NamedTextColor.LIGHT_PURPLE), + Component.text("Open your personal storage", NamedTextColor.GRAY), + Component.text("Click to open", NamedTextColor.YELLOW))) + .onClick(ApolloButtonAction.runCommand("/enderchest")) + .build(); + + InventoryButton profile = InventoryButton.builder() + .id("profile") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.RIGHT) + .position(HudPosition.of(4, 4)) + .size(InventoryButton.SIZE_MEDIUM) + .shape(ApolloButtonShape.CIRCLE) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder().itemName("PLAYER_HEAD").build()) + .build()) + .tooltip(ApolloButtonTooltip.of( + Component.text("Your Profile", NamedTextColor.GOLD), + Component.text("View your stats", NamedTextColor.GRAY))) + .onClick(ApolloButtonAction.runCommand("/profile")) + .build(); + + InventoryButton settings = InventoryButton.builder() + .id("settings") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.RIGHT) + .position(HudPosition.of(48, 4)) + .size(InventoryButton.SIZE_MEDIUM) + .shape(ApolloButtonShape.CIRCLE) + .backgroundColor(new Color(222, 160, 60, 85)) + .borderColor(new Color(255, 218, 150, 140)) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder().itemName("COMPARATOR").build()) + .build()) + .tooltip(ApolloButtonTooltip.of( + Component.text("Settings", NamedTextColor.WHITE), + Component.text("Server preferences", NamedTextColor.GRAY))) + .onClick(ApolloButtonAction.runCommand("/settings")) + .build(); + + InventoryButton vote = InventoryButton.builder() + .id("vote") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.RIGHT) + .position(HudPosition.of(6, 52)) + .size(InventoryButton.SIZE_WIDE) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(new Color(34, 204, 68, 64)) + .borderColor(new Color(190, 255, 205, 110)) + .hoveredBackgroundColor(new Color(34, 204, 68, 130)) + .hoveredBorderColor(new Color(190, 255, 205, 210)) + .content(ApolloButtonContent.builder() + .append(Component.text("Vote")) + .build()) + .tooltip(ApolloButtonTooltip.of( + Component.text("Vote", NamedTextColor.GREEN), + Component.text("Vote daily for rewards", NamedTextColor.GRAY))) + .onClick(ApolloButtonAction.openUrl("https://example.com/vote")) + .build(); + + InventoryButton discord = InventoryButton.builder() + .id("discord") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.RIGHT) + .position(HudPosition.of(6, 84)) + .size(InventoryButton.SIZE_WIDE) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(new Color(88, 101, 242, 90)) + .borderColor(new Color(150, 160, 250, 140)) + .content(ApolloButtonContent.builder() + .append(Component.text("Discord")) + .build()) + .tooltip(ApolloButtonTooltip.of( + Component.text("Discord", NamedTextColor.BLUE), + Component.text("Join our community", NamedTextColor.GRAY))) + .onClick(ApolloButtonAction.openUrl("https://lunarclient.dev/discord")) + .build(); + + InventoryButton lobby = InventoryButton.builder() + .id("lobby") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.RIGHT) + .position(HudPosition.of(6, 136)) + .size(InventoryButton.SIZE_WIDE) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(new Color(224, 64, 64, 128)) + .borderColor(new Color(255, 200, 200, 140)) + .content(ApolloButtonContent.builder() + .append(Component.text("Back to Lobby")) + .build()) + .tooltip(ApolloButtonTooltip.of( + Component.text("Back to Lobby", NamedTextColor.RED), + Component.text("Return to the main lobby", NamedTextColor.GRAY))) + .onClick(ApolloButtonAction.runCommand("/lobby")) + .build(); + + return new ArrayList<>(Arrays.asList(shop, spawn, warps, enderChest, + profile, settings, vote, discord, lobby)); + } + } diff --git a/api/src/main/java/com/lunarclient/apollo/module/inventory/InventoryType.java b/api/src/main/java/com/lunarclient/apollo/module/inventory/InventoryType.java new file mode 100644 index 00000000..d0e8a53f --- /dev/null +++ b/api/src/main/java/com/lunarclient/apollo/module/inventory/InventoryType.java @@ -0,0 +1,34 @@ +/* + * This file is part of Apollo, licensed under the MIT License. + * + * Copyright (c) 2026 Moonsworth + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +package com.lunarclient.apollo.module.inventory; + +/** + * Represents the inventory screen an inventory button belongs to. + * + * @since 1.2.9 + */ +public enum InventoryType { + PLAYER + +} diff --git a/api/src/main/java/com/lunarclient/apollo/module/nametag/Nametag.java b/api/src/main/java/com/lunarclient/apollo/module/nametag/Nametag.java index 5089ffd8..a45544b3 100644 --- a/api/src/main/java/com/lunarclient/apollo/module/nametag/Nametag.java +++ b/api/src/main/java/com/lunarclient/apollo/module/nametag/Nametag.java @@ -45,4 +45,13 @@ public final class Nametag { */ List lines; + /** + * Returns the {@link NametagVisibilityOverride} override for this nametag. + * + * @return the visibility override + * @since 1.2.9 + */ + @Builder.Default + NametagVisibilityOverride visibilityOverride = NametagVisibilityOverride.NONE; + } diff --git a/api/src/main/java/com/lunarclient/apollo/module/nametag/NametagVisibilityOverride.java b/api/src/main/java/com/lunarclient/apollo/module/nametag/NametagVisibilityOverride.java new file mode 100644 index 00000000..4c0b5ff2 --- /dev/null +++ b/api/src/main/java/com/lunarclient/apollo/module/nametag/NametagVisibilityOverride.java @@ -0,0 +1,59 @@ +/* + * This file is part of Apollo, licensed under the MIT License. + * + * Copyright (c) 2026 Moonsworth + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +package com.lunarclient.apollo.module.nametag; + +/** + * Represents an override of the vanilla team-based nametag visibility + * outcome for the target player, from the viewpoint of the receiving player. + * + * @since 1.2.9 + */ +public enum NametagVisibilityOverride { + + /** + * The vanilla team-based nametag visibility applies. + * + * @since 1.2.9 + */ + NONE, + + /** + * Shows the nametag, as if the target's team nametag visibility + * were {@code always}, still respecting invisibility. + * + * @since 1.2.9 + */ + SHOWN, + + /** + * Hides the nametag, as if the target's team nametag visibility + * were {@code never}. + * + *

Applies even when the target is not on any team.

+ * + * @since 1.2.9 + */ + HIDDEN + +} diff --git a/api/src/main/java/com/lunarclient/apollo/module/packetenrichment/PacketEnrichmentModule.java b/api/src/main/java/com/lunarclient/apollo/module/packetenrichment/PacketEnrichmentModule.java index cec82188..c1f6ee9b 100644 --- a/api/src/main/java/com/lunarclient/apollo/module/packetenrichment/PacketEnrichmentModule.java +++ b/api/src/main/java/com/lunarclient/apollo/module/packetenrichment/PacketEnrichmentModule.java @@ -102,6 +102,48 @@ public abstract class PacketEnrichmentModule extends ApolloModule { .node("player-chat-close", "fire-apollo-event").type(TypeToken.get(Boolean.class)) .defaultValue(false).build(); + /** + * Controls whether the client sends an additional player inventory open packet to the server. + * + * @since 1.2.9 + */ + public static final SimpleOption PLAYER_INVENTORY_OPEN_PACKET = Option.builder() + .comment("Set to 'true' to have the client send an additional player inventory open packet to the server, otherwise 'false'.") + .node("player-inventory-open", "send-packet").type(TypeToken.get(Boolean.class)) + .defaultValue(false).notifyClient().build(); + + /** + * Controls whether Apollo fires {@link com.lunarclient.apollo.event.packetenrichment.inventory.ApolloPlayerInventoryOpenEvent} + * when the packet is received. + * + * @since 1.2.9 + */ + public static final SimpleOption PLAYER_INVENTORY_OPEN_EVENT = Option.builder() + .comment("If 'true', Apollo fires the player inventory open event on the main thread. Disable this and handle the packet yourself if you require asynchronous or off-thread processing.") + .node("player-inventory-open", "fire-apollo-event").type(TypeToken.get(Boolean.class)) + .defaultValue(false).build(); + + /** + * Controls whether the client sends an additional player inventory close packet to the server. + * + * @since 1.2.9 + */ + public static final SimpleOption PLAYER_INVENTORY_CLOSE_PACKET = Option.builder() + .comment("Set to 'true' to have the client send an additional player inventory close packet to the server, otherwise 'false'.") + .node("player-inventory-close", "send-packet").type(TypeToken.get(Boolean.class)) + .defaultValue(false).notifyClient().build(); + + /** + * Controls whether Apollo fires {@link com.lunarclient.apollo.event.packetenrichment.inventory.ApolloPlayerInventoryCloseEvent} + * when the packet is received. + * + * @since 1.2.9 + */ + public static final SimpleOption PLAYER_INVENTORY_CLOSE_EVENT = Option.builder() + .comment("If 'true', Apollo fires the player inventory close event on the main thread. Disable this and handle the packet yourself if you require asynchronous or off-thread processing.") + .node("player-inventory-close", "fire-apollo-event").type(TypeToken.get(Boolean.class)) + .defaultValue(false).build(); + /** * Controls whether the client sends an additional player use item packet to the server. * @@ -153,6 +195,10 @@ protected PacketEnrichmentModule() { PacketEnrichmentModule.PLAYER_CHAT_OPEN_EVENT, PacketEnrichmentModule.PLAYER_CHAT_CLOSE_PACKET, PacketEnrichmentModule.PLAYER_CHAT_CLOSE_EVENT, + PacketEnrichmentModule.PLAYER_INVENTORY_OPEN_PACKET, + PacketEnrichmentModule.PLAYER_INVENTORY_OPEN_EVENT, + PacketEnrichmentModule.PLAYER_INVENTORY_CLOSE_PACKET, + PacketEnrichmentModule.PLAYER_INVENTORY_CLOSE_EVENT, PacketEnrichmentModule.PLAYER_USE_ITEM_PACKET, PacketEnrichmentModule.PLAYER_USE_ITEM_EVENT, PacketEnrichmentModule.PLAYER_USE_ITEM_BUCKET_PACKET, diff --git a/api/src/main/java/com/lunarclient/apollo/module/transfer/PingRequest.java b/api/src/main/java/com/lunarclient/apollo/module/transfer/PingRequest.java index 27640400..3b305bd3 100644 --- a/api/src/main/java/com/lunarclient/apollo/module/transfer/PingRequest.java +++ b/api/src/main/java/com/lunarclient/apollo/module/transfer/PingRequest.java @@ -45,4 +45,15 @@ public final class PingRequest extends ApolloRequest { */ List serverIps; + /** + * Returns the timeout for ping requests, in milliseconds. + * + * @return the request timeout, in milliseconds + * @since 1.2.9 + */ + @Override + public long getTimeoutMillis() { + return 10_000L; + } + } diff --git a/api/src/main/java/com/lunarclient/apollo/module/transfer/TransferModule.java b/api/src/main/java/com/lunarclient/apollo/module/transfer/TransferModule.java index 2d033f4d..39b08ed8 100644 --- a/api/src/main/java/com/lunarclient/apollo/module/transfer/TransferModule.java +++ b/api/src/main/java/com/lunarclient/apollo/module/transfer/TransferModule.java @@ -42,6 +42,14 @@ @ModuleDefinition(id = "transfer", name = "Transfer") public abstract class TransferModule extends ApolloModule { + /** + * The maximum amount of server IPs the client will ping + * for a single {@link PingRequest}. + * + * @since 1.2.9 + */ + public static final int MAX_PINGS_PER_PACKET = 10; + @Override public Collection getSupportedPlatforms() { return Arrays.asList(ApolloPlatform.Kind.SERVER, ApolloPlatform.Kind.PROXY); @@ -55,6 +63,8 @@ public Collection getSupportedPlatforms() { * @param player the player * @param serverIps all server IPs to ping * @return future to be listened to for errors/success + * @throws IllegalArgumentException if no server IPs or more than + * {@value #MAX_PINGS_PER_PACKET} server IPs are provided * @since 1.0.0 */ public Future ping(ApolloPlayer player, List serverIps) { @@ -85,6 +95,8 @@ public Future transfer(ApolloPlayer player, String serverIp) { * @param player the player * @param request the ping request * @return future to be listened to for errors/success + * @throws IllegalArgumentException if no server IPs or more than + * {@value #MAX_PINGS_PER_PACKET} server IPs are provided * @since 1.0.0 */ public abstract Future ping(ApolloPlayer player, PingRequest request); diff --git a/api/src/main/java/com/lunarclient/apollo/roundtrip/ApolloRequest.java b/api/src/main/java/com/lunarclient/apollo/roundtrip/ApolloRequest.java index 372d8ae3..f5bb25b9 100644 --- a/api/src/main/java/com/lunarclient/apollo/roundtrip/ApolloRequest.java +++ b/api/src/main/java/com/lunarclient/apollo/roundtrip/ApolloRequest.java @@ -67,4 +67,14 @@ public ApolloRequest() { this.sentTime = System.currentTimeMillis(); } + /** + * Returns the time to wait for a response, in milliseconds. + * + * @return the request timeout, in milliseconds + * @since 1.2.9 + */ + public long getTimeoutMillis() { + return TIMEOUT; + } + } diff --git a/api/src/main/java/com/lunarclient/apollo/roundtrip/ApolloRoundtripManager.java b/api/src/main/java/com/lunarclient/apollo/roundtrip/ApolloRoundtripManager.java index f0d5bce8..31771c4c 100644 --- a/api/src/main/java/com/lunarclient/apollo/roundtrip/ApolloRoundtripManager.java +++ b/api/src/main/java/com/lunarclient/apollo/roundtrip/ApolloRoundtripManager.java @@ -119,13 +119,14 @@ public void registerListener(ApolloRequest request this.paginationManager.handleTimeout(packetId); if (listener != null) { - Throwable error = new Throwable("Timeout exceeded!"); + Throwable error = new Throwable("Timeout exceeded! No " + request.getClass().getSimpleName() + + " response received within " + request.getTimeoutMillis() + "ms"); future.handleFailure(error); } } catch (Exception e) { e.printStackTrace(); } - }, ApolloRequest.TIMEOUT, TimeUnit.MILLISECONDS); + }, request.getTimeoutMillis(), TimeUnit.MILLISECONDS); this.listeners.put(packetId, (UncertainFuture) future); } diff --git a/common/src/main/java/com/lunarclient/apollo/module/button/ApolloButtonSerializer.java b/common/src/main/java/com/lunarclient/apollo/module/button/ApolloButtonSerializer.java new file mode 100644 index 00000000..babf1248 --- /dev/null +++ b/common/src/main/java/com/lunarclient/apollo/module/button/ApolloButtonSerializer.java @@ -0,0 +1,273 @@ +/* + * This file is part of Apollo, licensed under the MIT License. + * + * Copyright (c) 2026 Moonsworth + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +package com.lunarclient.apollo.module.button; + +import com.lunarclient.apollo.common.ApolloComponent; +import com.lunarclient.apollo.common.button.ApolloButton; +import com.lunarclient.apollo.common.button.ApolloButtonShape; +import com.lunarclient.apollo.common.button.ApolloButtonSize; +import com.lunarclient.apollo.common.button.ApolloButtonTooltip; +import com.lunarclient.apollo.common.button.action.ApolloButtonAction; +import com.lunarclient.apollo.common.button.action.ApolloButtonClientAction; +import com.lunarclient.apollo.common.button.action.ClientAction; +import com.lunarclient.apollo.common.button.action.OpenUrlAction; +import com.lunarclient.apollo.common.button.action.RunCommandAction; +import com.lunarclient.apollo.common.button.content.ApolloButtonContent; +import com.lunarclient.apollo.common.button.content.ApolloButtonContentPart; +import com.lunarclient.apollo.common.button.content.ComponentPart; +import com.lunarclient.apollo.common.button.content.IconPart; +import com.lunarclient.apollo.common.button.content.LiveComponentPart; +import com.lunarclient.apollo.common.icon.Icon; +import com.lunarclient.apollo.common.location.HudPosition; +import java.awt.Color; +import java.lang.reflect.Type; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.List; +import java.util.Locale; +import net.kyori.adventure.text.Component; +import org.checkerframework.checker.nullness.qual.Nullable; +import org.spongepowered.configurate.ConfigurationNode; +import org.spongepowered.configurate.serialize.SerializationException; +import org.spongepowered.configurate.serialize.TypeSerializer; + +/** + * Reads and writes the shared {@link ApolloButton} properties from a module + * configuration; each button surface extends this with its own placement + * fields. + * + * @param the surface button type + * @since 1.2.9 + */ +public abstract class ApolloButtonSerializer implements TypeSerializer { + + @Override + public T deserialize(Type type, ConfigurationNode node) throws SerializationException { + try { + ApolloButtonContent.Builder content = ApolloButtonContent.builder(); + for (ConfigurationNode part : node.node("content", "parts").childrenList()) { + if (part.hasChild("text")) { + content.append(ApolloComponent.fromLegacyAmpersand(part.node("text").getString(""))); + } else if (part.hasChild("icon")) { + Icon icon = part.node("icon").get(Icon.class); + if (icon == null) { + throw new SerializationException("Button content part 'icon' must not be empty!"); + } + + content.append(icon); + } else { + throw new SerializationException("Button content parts require a 'text' or 'icon' field!"); + } + } + + if (node.hasChild("content", "scale")) { + content.scale((float) node.node("content", "scale").getDouble(1.0D)); + } + + String id = this.virtualNode(node, "id").getString(); + if (id == null || id.isEmpty()) { + throw new SerializationException("Required field id must not be empty!"); + } + + ApolloButton.ApolloButtonBuilder builder = this.createBuilder(node); + builder.id(id); + builder.position(HudPosition.of( + (float) this.virtualNode(node, "position", "x").getDouble(), + (float) this.virtualNode(node, "position", "y").getDouble())); + builder.size(ApolloButtonSize.of( + (float) this.virtualNode(node, "size", "width").getDouble(), + (float) this.virtualNode(node, "size", "height").getDouble())); + builder.shape(this.parseEnum(ApolloButtonShape.class, this.virtualNode(node, "shape").getString(), "shape")); + builder.content(content.build()); + builder.hoveredBackgroundColor(node.node("hovered-background-color").get(Color.class)); + builder.hoveredBorderColor(node.node("hovered-border-color").get(Color.class)); + + if (node.hasChild("tooltip")) { + List lines = new ArrayList<>(); + for (ConfigurationNode line : node.node("tooltip").childrenList()) { + lines.add(ApolloComponent.fromLegacyAmpersand(line.getString(""))); + } + + builder.tooltip(ApolloButtonTooltip.of(lines)); + } + + if (node.hasChild("on-click")) { + builder.onClick(this.readAction(node.node("on-click"))); + } + + return builder.build(); + } catch (IllegalArgumentException exception) { + throw new SerializationException(exception.getMessage()); + } + } + + @Override + public void serialize(Type type, @Nullable T button, ConfigurationNode node) throws SerializationException { + if (button == null) { + node.raw(null); + return; + } + + node.node("id").set(button.getId()); + this.serializeSurface(button, node); + node.node("position", "x").set((double) button.getPosition().getX()); + node.node("position", "y").set((double) button.getPosition().getY()); + node.node("size", "width").set((double) button.getSize().getWidth()); + node.node("size", "height").set((double) button.getSize().getHeight()); + node.node("shape").set(button.getShape().name()); + node.node("background-color").set(Color.class, button.getBackgroundColor()); + node.node("border-color").set(Color.class, button.getBorderColor()); + + if (button.getHoveredBackgroundColor() != null) { + node.node("hovered-background-color").set(Color.class, button.getHoveredBackgroundColor()); + } + + if (button.getHoveredBorderColor() != null) { + node.node("hovered-border-color").set(Color.class, button.getHoveredBorderColor()); + } + + node.node("content", "scale").set((double) button.getContent().getScale()); + for (ApolloButtonContentPart part : button.getContent().getParts()) { + this.writePart(node.node("content", "parts").appendListNode(), part); + } + + ApolloButtonTooltip tooltip = button.getTooltip(); + if (tooltip != null) { + if (tooltip.isLive() || tooltip.getLines() == null) { + throw new SerializationException("Live tooltips cannot be stored in the config!"); + } + + for (Component line : tooltip.getLines()) { + node.node("tooltip").appendListNode().set(ApolloComponent.toLegacyAmpersand(line)); + } + } + + ApolloButtonAction action = button.getOnClick(); + if (action instanceof RunCommandAction) { + node.node("on-click", "run-command").set(((RunCommandAction) action).getCommand()); + } else if (action instanceof OpenUrlAction) { + node.node("on-click", "open-url").set(((OpenUrlAction) action).getUrl()); + } else if (action instanceof ClientAction) { + node.node("on-click", "client-action").set(((ClientAction) action).getAction().name()); + } + } + + /** + * Creates the surface builder, reading the surface placement + * fields from the given node. + * + * @param node the button node + * @return the surface builder + * @throws SerializationException if a surface field is invalid + * @since 1.2.9 + */ + protected abstract ApolloButton.ApolloButtonBuilder createBuilder(ConfigurationNode node) throws SerializationException; + + /** + * Writes the surface placement fields to the given node. + * + * @param button the button to serialize + * @param node the button node + * @throws SerializationException if a surface field cannot be written + * @since 1.2.9 + */ + protected void serializeSurface(T button, ConfigurationNode node) throws SerializationException { + } + + /** + * Parses an enum constant. + * + * @param type the enum type + * @param value the config value + * @param field the field name used in error messages + * @param the enum type + * @return the parsed constant + * @throws SerializationException if the value is missing or unknown + * @since 1.2.9 + */ + protected > E parseEnum(Class type, @Nullable String value, String field) throws SerializationException { + if (value == null) { + throw new SerializationException("Required field " + field + " not found!"); + } + + try { + return Enum.valueOf(type, value.toUpperCase(Locale.ROOT)); + } catch (IllegalArgumentException exception) { + throw new SerializationException("Unknown " + field + " '" + value + "'!"); + } + } + + /** + * Returns the node at the given path, requiring it to exist. + * + * @param source the source node + * @param path the child path + * @return the child node + * @throws SerializationException if the child does not exist + * @since 1.2.9 + */ + protected ConfigurationNode virtualNode(ConfigurationNode source, Object... path) throws SerializationException { + if (!source.hasChild(path)) { + throw new SerializationException("Required field " + Arrays.toString(path) + " not found!"); + } + + return source.node(path); + } + + private ApolloButtonAction readAction(ConfigurationNode node) throws SerializationException { + if (node.hasChild("run-command")) { + return ApolloButtonAction.runCommand(node.node("run-command").getString("")); + } + + if (node.hasChild("open-url")) { + return ApolloButtonAction.openUrl(node.node("open-url").getString("")); + } + + if (node.hasChild("client-action")) { + return ApolloButtonAction.clientAction(this.parseEnum(ApolloButtonClientAction.class, + node.node("client-action").getString(), "client-action")); + } + + throw new SerializationException("on-click requires a 'run-command', 'open-url' or 'client-action' field!"); + } + + private void writePart(ConfigurationNode node, ApolloButtonContentPart part) throws SerializationException { + if (part instanceof LiveComponentPart) { + throw new SerializationException("Live content parts cannot be stored in the config!"); + } + + if (part instanceof ComponentPart) { + node.node("text").set(ApolloComponent.toLegacyAmpersand(((ComponentPart) part).getComponent())); + return; + } + + if (part instanceof IconPart) { + node.node("icon").set(Icon.class, ((IconPart) part).getIcon()); + return; + } + + throw new SerializationException("Unknown button content part type: " + part.getClass().getName()); + } + +} diff --git a/common/src/main/java/com/lunarclient/apollo/module/button/ButtonModuleSupport.java b/common/src/main/java/com/lunarclient/apollo/module/button/ButtonModuleSupport.java new file mode 100644 index 00000000..be3fada2 --- /dev/null +++ b/common/src/main/java/com/lunarclient/apollo/module/button/ButtonModuleSupport.java @@ -0,0 +1,504 @@ +/* + * This file is part of Apollo, licensed under the MIT License. + * + * Copyright (c) 2026 Moonsworth + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +package com.lunarclient.apollo.module.button; + +import com.google.protobuf.Message; +import com.lunarclient.apollo.Apollo; +import com.lunarclient.apollo.ApolloManager; +import com.lunarclient.apollo.button.v1.ButtonUpdate; +import com.lunarclient.apollo.common.button.ApolloButton; +import com.lunarclient.apollo.common.button.ApolloButtonSize; +import com.lunarclient.apollo.common.button.ApolloButtonTooltip; +import com.lunarclient.apollo.common.button.action.ApolloButtonAction; +import com.lunarclient.apollo.common.button.action.RunCommandAction; +import com.lunarclient.apollo.common.button.content.ApolloButtonContent; +import com.lunarclient.apollo.common.button.content.ApolloButtonContentPart; +import com.lunarclient.apollo.common.button.content.LiveComponentPart; +import com.lunarclient.apollo.common.location.HudPosition; +import com.lunarclient.apollo.module.ApolloModule; +import com.lunarclient.apollo.network.ButtonNetworkTypes; +import com.lunarclient.apollo.option.SimpleOption; +import com.lunarclient.apollo.player.ApolloPlayer; +import com.lunarclient.apollo.recipients.Recipients; +import java.time.Duration; +import java.util.ArrayList; +import java.util.Collection; +import java.util.HashSet; +import java.util.Iterator; +import java.util.List; +import java.util.Map; +import java.util.Set; +import java.util.UUID; +import java.util.concurrent.ConcurrentHashMap; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.atomic.AtomicBoolean; +import lombok.RequiredArgsConstructor; +import org.jetbrains.annotations.Nullable; + +/** + * The shared engine behind every button module. + * + * @param the button type + * @param

the protobuf message + * @since 1.2.9 + */ +@RequiredArgsConstructor +public final class ButtonModuleSupport { + + private static final long TICK_MILLIS = 50L; + + private final Set openViewers = ConcurrentHashMap.newKeySet(); + private final Map> liveButtons = new ConcurrentHashMap<>(); + private final AtomicBoolean broadcastStarted = new AtomicBoolean(false); + private final AtomicBoolean ticking = new AtomicBoolean(false); + + private final ApolloModule owner; + private final ButtonSurface surface; + private final SimpleOption broadcastOption; + + /** + * Starts the repeating live-button broadcast task. + * + * @since 1.2.9 + */ + public void startBroadcast() { + if (!this.broadcastStarted.compareAndSet(false, true)) { + return; + } + + try { + Apollo.getPlatform().getScheduler() + .scheduleAsyncRepeating(this::broadcastTick, TICK_MILLIS, TICK_MILLIS, TimeUnit.MILLISECONDS); + } catch (Throwable throwable) { + this.broadcastStarted.set(false); + } + } + + /** + * Validates and displays the buttons, resolving live values per viewer + * and registering live buttons for the periodic broadcast. + * + * @param recipients the recipients that are receiving the packet + * @param buttons the buttons to display + * @since 1.2.9 + */ + public void displayButtons(Recipients recipients, Collection buttons) { + if (buttons.isEmpty()) { + throw new IllegalArgumentException("Button collection must not be empty"); + } + + Set ids = new HashSet<>(buttons.size()); + List live = new ArrayList<>(); + for (B button : buttons) { + this.surface.validate(button); + + if (!ids.add(button.getId())) { + throw new IllegalArgumentException("Duplicate button id '" + button.getId() + "' in display batch"); + } + + if (this.isLiveButton(button)) { + live.add(button); + } + } + + if (live.isEmpty()) { + List

elements = new ArrayList<>(); + for (B button : buttons) { + elements.add(this.surface.toDisplayElement(button, null)); + } + + ApolloManager.getNetworkManager().sendPacket(recipients, this.surface.createDisplay(elements)); + this.untrackButtons(recipients, buttons); + return; + } + + recipients.forEach(recipient -> { + ApolloPlayer player = (ApolloPlayer) recipient; + + List

elements = new ArrayList<>(); + for (B button : buttons) { + elements.add(this.surface.toDisplayElement(button, player)); + } + + ApolloManager.getNetworkManager().sendPacket(player, this.surface.createDisplay(elements)); + + long now = System.currentTimeMillis(); + Map tracked = this.liveButtons.computeIfAbsent(player.getUniqueId(), uuid -> new ConcurrentHashMap<>()); + + for (B button : buttons) { + if (this.isLiveButton(button)) { + tracked.put(button.getId(), this.createLiveButton(button.getContent(), button.getTooltip(), now)); + } else { + tracked.remove(button.getId()); + } + } + }); + } + + private void untrackButtons(Recipients recipients, Collection buttons) { + recipients.forEach(recipient -> { + Map tracked = this.liveButtons.get(((ApolloPlayer) recipient).getUniqueId()); + if (tracked == null) { + return; + } + + for (B button : buttons) { + tracked.remove(button.getId()); + } + }); + } + + /** + * Removes a button by id and drops it from live tracking. + * + * @param recipients the recipients that are receiving the packet + * @param buttonId the button id + * @since 1.2.9 + */ + public void removeButton(Recipients recipients, String buttonId) { + ApolloManager.getNetworkManager().sendPacket(recipients, this.surface.createRemove(buttonId)); + + recipients.forEach(recipient -> { + Map tracked = this.liveButtons.get(((ApolloPlayer) recipient).getUniqueId()); + if (tracked != null) { + tracked.remove(buttonId); + } + }); + } + + /** + * Resets all buttons and drops the recipients live tracking. + * + * @param recipients the recipients that are receiving the packet + * @since 1.2.9 + */ + public void resetButtons(Recipients recipients) { + ApolloManager.getNetworkManager().sendPacket(recipients, this.surface.createReset()); + recipients.forEach(recipient -> this.liveButtons.remove(((ApolloPlayer) recipient).getUniqueId())); + } + + /** + * Pushes an update for a displayed button. + * + * @param recipients the recipients that are receiving the packet + * @param buttonId the button id + * @param content the new content, or {@code null} to keep the current one + * @param updateTooltip whether the tooltip should be replaced at all + * @param tooltip the new tooltip, or {@code null} to clear it (when + * {@code updateTooltip} is {@code true}) + * @since 1.2.9 + */ + public void pushUpdate(Recipients recipients, String buttonId, + @Nullable ApolloButtonContent content, boolean updateTooltip, + @Nullable ApolloButtonTooltip tooltip) { + if (buttonId.isEmpty()) { + throw new IllegalArgumentException("ApolloButton#id must not be empty"); + } + + boolean live = (content != null && content.isLive()) || (updateTooltip && tooltip != null && tooltip.isLive()); + + if (!live) { + ButtonUpdate update = ButtonNetworkTypes.toUpdateProtobuf(content, tooltip, updateTooltip, null); + ApolloManager.getNetworkManager().sendPacket(recipients, this.surface.createUpdate(buttonId, update)); + } else { + recipients.forEach(recipient -> { + ApolloPlayer player = (ApolloPlayer) recipient; + + ButtonUpdate update = ButtonNetworkTypes.toUpdateProtobuf(content, tooltip, updateTooltip, player); + ApolloManager.getNetworkManager().sendPacket(player, this.surface.createUpdate(buttonId, update)); + }); + } + + recipients.forEach(recipient -> { + Map tracked = this.liveButtons + .computeIfAbsent(((ApolloPlayer) recipient).getUniqueId(), uuid -> new ConcurrentHashMap<>()); + + long now = System.currentTimeMillis(); + tracked.compute(buttonId, (id, previous) -> { + ApolloButtonContent newContent = content != null ? content + : previous != null ? previous.content : null; + ApolloButtonTooltip newTooltip = updateTooltip ? tooltip + : previous != null ? previous.tooltip : null; + + if (newContent == null || (!newContent.isLive() && (newTooltip == null || !newTooltip.isLive()))) { + return null; + } + + return this.createLiveButton(newContent, newTooltip, now); + }); + }); + } + + /** + * Marks a player's surface as open and pushes an immediate live refresh + * for their tracked buttons; called from the surface's open event. + * + * @param player the player whose surface opened + * @since 1.2.9 + */ + public void handleOpen(ApolloPlayer player) { + if (!this.owner.isEnabled()) { + return; + } + + this.openViewers.add(player.getUniqueId()); + + if (!this.owner.getOptions().get(this.broadcastOption)) { + return; + } + + Map tracked = this.liveButtons.get(player.getUniqueId()); + if (tracked != null && !tracked.isEmpty()) { + this.sendLiveUpdates(player, tracked, System.currentTimeMillis(), true); + } + } + + /** + * Marks a player's surface as closed; called from the surface's close + * event. + * + * @param playerIdentifier the player whose surface closed + * @since 1.2.9 + */ + public void handleClose(UUID playerIdentifier) { + this.openViewers.remove(playerIdentifier); + } + + /** + * Drops all state for a disconnecting player. + * + * @param playerIdentifier the unregistering player + * @since 1.2.9 + */ + public void handleUnregister(UUID playerIdentifier) { + this.openViewers.remove(playerIdentifier); + this.liveButtons.remove(playerIdentifier); + } + + private void broadcastTick() { + if (!this.ticking.compareAndSet(false, true)) { + return; + } + + try { + if (!this.owner.isEnabled()) { + this.liveButtons.clear(); + this.openViewers.clear(); + return; + } + + if (!this.owner.getOptions().get(this.broadcastOption) || this.liveButtons.isEmpty()) { + return; + } + + long now = System.currentTimeMillis(); + boolean trackingActive = this.surface.isOpenTrackingActive(); + + Iterator>> iterator = this.liveButtons.entrySet().iterator(); + while (iterator.hasNext()) { + Map.Entry> entry = iterator.next(); + if (entry.getValue().isEmpty()) { + iterator.remove(); + continue; + } + + if (trackingActive && !this.openViewers.contains(entry.getKey())) { + continue; + } + + if (!this.anyUpdateDue(entry.getValue(), now)) { + continue; + } + + ApolloPlayer player = Apollo.getPlayerManager().getPlayer(entry.getKey()).orElse(null); + if (player == null) { + iterator.remove(); + continue; + } + + try { + this.sendLiveUpdates(player, entry.getValue(), now, false); + } catch (Throwable throwable) { + throwable.printStackTrace(); + } + } + } catch (Throwable throwable) { + throwable.printStackTrace(); + } finally { + this.ticking.set(false); + } + } + + private long millisToTicks(Duration interval) { + return Math.max(1L, interval.toMillis() / TICK_MILLIS) * TICK_MILLIS; + } + + private LiveButton createLiveButton(ApolloButtonContent content, @Nullable ApolloButtonTooltip tooltip, long now) { + long contentInterval = 0L; + for (ApolloButtonContentPart part : content.getParts()) { + if (!(part instanceof LiveComponentPart)) { + continue; + } + + LiveComponentPart livePart = (LiveComponentPart) part; + long interval = this.millisToTicks(livePart.getUpdateInterval()); + + if (contentInterval == 0L || interval < contentInterval) { + contentInterval = interval; + } + } + + Duration tooltipUpdateInterval = tooltip != null ? tooltip.getUpdateInterval() : null; + long tooltipInterval = tooltipUpdateInterval != null ? this.millisToTicks(tooltipUpdateInterval) : 0L; + + return new LiveButton(content, tooltip, contentInterval, tooltipInterval, now); + } + + private boolean anyUpdateDue(Map buttons, long now) { + for (LiveButton button : buttons.values()) { + if (button.isContentDue(now) || button.isTooltipDue(now)) { + return true; + } + } + + return false; + } + + private void sendLiveUpdates(ApolloPlayer player, Map buttons, long now, boolean force) { + for (Map.Entry entry : buttons.entrySet()) { + LiveButton button = entry.getValue(); + + boolean contentDue = force ? button.contentIntervalMillis > 0L : button.isContentDue(now); + boolean tooltipDue = force ? button.tooltipIntervalMillis > 0L : button.isTooltipDue(now); + if (!contentDue && !tooltipDue) { + continue; + } + + ButtonUpdate update = ButtonNetworkTypes.toUpdateProtobuf(contentDue + ? button.content : null, button.tooltip, tooltipDue, player); + + ApolloManager.getNetworkManager().sendPacket(player, this.surface.createUpdate(entry.getKey(), update)); + + if (contentDue) { + button.nextContentUpdate = now + button.contentIntervalMillis; + } + + if (tooltipDue) { + button.nextTooltipUpdate = now + button.tooltipIntervalMillis; + } + } + } + + private boolean isLiveButton(ApolloButton button) { + ApolloButtonTooltip tooltip = button.getTooltip(); + return button.getContent().isLive() || (tooltip != null && tooltip.isLive()); + } + + private static final class LiveButton { + + private final ApolloButtonContent content; + private final @Nullable ApolloButtonTooltip tooltip; + private final long contentIntervalMillis; + private final long tooltipIntervalMillis; + private volatile long nextContentUpdate; + private volatile long nextTooltipUpdate; + + private LiveButton(ApolloButtonContent content, @Nullable ApolloButtonTooltip tooltip, + long contentIntervalMillis, long tooltipIntervalMillis, long now) { + this.content = content; + this.tooltip = tooltip; + this.contentIntervalMillis = contentIntervalMillis; + this.tooltipIntervalMillis = tooltipIntervalMillis; + this.nextContentUpdate = now + contentIntervalMillis; + this.nextTooltipUpdate = now + tooltipIntervalMillis; + } + + private boolean isContentDue(long now) { + return this.contentIntervalMillis > 0L && now >= this.nextContentUpdate; + } + + private boolean isTooltipDue(long now) { + return this.tooltipIntervalMillis > 0L && now >= this.nextTooltipUpdate; + } + } + + /** + * Validates the button properties. + * + * @param button the button to validate + * @param boxWidth the surface container width + * @param boxHeight the surface container height + * @since 1.2.9 + */ + public static void validateCommon(ApolloButton button, float boxWidth, float boxHeight) { + requireSet(button.getId(), "ApolloButton#id"); + requireSet(button.getPosition(), "ApolloButton#position"); + requireSet(button.getSize(), "ApolloButton#size"); + requireSet(button.getShape(), "ApolloButton#shape"); + requireSet(button.getBackgroundColor(), "ApolloButton#backgroundColor"); + requireSet(button.getBorderColor(), "ApolloButton#borderColor"); + requireSet(button.getContent(), "ApolloButton#content"); + + if (button.getId().isEmpty()) { + throw new IllegalArgumentException("ApolloButton#id must not be empty"); + } + + HudPosition position = button.getPosition(); + ApolloButtonSize size = button.getSize(); + + if (!Float.isFinite(position.getX()) || !Float.isFinite(position.getY()) + || !Float.isFinite(size.getWidth()) || !Float.isFinite(size.getHeight())) { + throw new IllegalArgumentException("ApolloButton position and size must be finite"); + } + + if (size.getWidth() <= 0.0F || size.getHeight() <= 0.0F) { + throw new IllegalArgumentException("ApolloButton#size width and height must be greater than 0"); + } + + if (position.getX() < 0.0F || position.getY() < 0.0F + || position.getX() + size.getWidth() > boxWidth + || position.getY() + size.getHeight() > boxHeight) { + throw new IllegalArgumentException("ApolloButton must fit within the " + boxWidth + "x" + boxHeight + " button box"); + } + + ApolloButtonAction onClick = button.getOnClick(); + if (onClick instanceof RunCommandAction && !((RunCommandAction) onClick).getCommand().startsWith("/")) { + throw new IllegalArgumentException("RunCommandAction#command must start with '/'"); + } + } + + /** + * Throws a {@link IllegalArgumentException} when the value is {@code null}. + * + * @param value the value to check + * @param name the field name + * @since 1.2.9 + */ + public static void requireSet(@Nullable Object value, String name) { + if (value == null) { + throw new IllegalArgumentException(name + " must not be null"); + } + } + +} diff --git a/common/src/main/java/com/lunarclient/apollo/module/button/ButtonSurface.java b/common/src/main/java/com/lunarclient/apollo/module/button/ButtonSurface.java new file mode 100644 index 00000000..75fa9701 --- /dev/null +++ b/common/src/main/java/com/lunarclient/apollo/module/button/ButtonSurface.java @@ -0,0 +1,105 @@ +/* + * This file is part of Apollo, licensed under the MIT License. + * + * Copyright (c) 2026 Moonsworth + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +package com.lunarclient.apollo.module.button; + +import com.google.protobuf.Message; +import com.lunarclient.apollo.button.v1.ButtonUpdate; +import com.lunarclient.apollo.common.button.ApolloButton; +import com.lunarclient.apollo.player.ApolloPlayer; +import java.util.List; +import org.jetbrains.annotations.Nullable; + +/** + * The per-surface strategy behind {@link ButtonModuleSupport}. + * + * @param the button type + * @param

the protobuf message + * @since 1.2.9 + */ +public interface ButtonSurface { + + /** + * Validates a button before it is sent, throwing {@link IllegalArgumentException} on invalid buttons. + * + * @param button the button to validate + * @since 1.2.9 + */ + void validate(B button); + + /** + * Builds the surface wrapper element for a button, embedding the shared + * {@code button.v1.Button} payload alongside the surface placement fields. + * + * @param button the button to serialize + * @param viewer the viewing player live values are resolved for, or {@code null} + * @return the wrapper element + * @since 1.2.9 + */ + P toDisplayElement(B button, @Nullable ApolloPlayer viewer); + + /** + * Builds the surface display message from wrapper elements. + * + * @param elements the wrapper elements + * @return the display message + * @since 1.2.9 + */ + Message createDisplay(List

elements); + + /** + * Builds the surface update message for a button id. + * + * @param buttonId the button id + * @param update the shared update fragment + * @return the update message + * @since 1.2.9 + */ + Message createUpdate(String buttonId, ButtonUpdate update); + + /** + * Builds the surface remove message for a button id. + * + * @param buttonId the button id + * @return the remove message + * @since 1.2.9 + */ + Message createRemove(String buttonId); + + /** + * Builds the surface reset message. + * + * @return the reset message + * @since 1.2.9 + */ + Message createReset(); + + /** + * Returns whether per-player surface open/close tracking is active. + * + * @return whether open tracking is active + * @since 1.2.9 + */ + boolean isOpenTrackingActive(); + +} diff --git a/common/src/main/java/com/lunarclient/apollo/module/chat/ChatButtonSerializer.java b/common/src/main/java/com/lunarclient/apollo/module/chat/ChatButtonSerializer.java new file mode 100644 index 00000000..e20999e1 --- /dev/null +++ b/common/src/main/java/com/lunarclient/apollo/module/chat/ChatButtonSerializer.java @@ -0,0 +1,57 @@ +/* + * This file is part of Apollo, licensed under the MIT License. + * + * Copyright (c) 2026 Moonsworth + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +package com.lunarclient.apollo.module.chat; + +import com.lunarclient.apollo.common.button.ApolloButton; +import com.lunarclient.apollo.module.button.ApolloButtonSerializer; +import java.awt.Color; +import org.spongepowered.configurate.ConfigurationNode; +import org.spongepowered.configurate.serialize.SerializationException; + +/** + * Reads and writes {@link ChatButton}s from the module configuration; see + * {@link ApolloButtonSerializer} for the shared button fields. + * + * @since 1.2.9 + */ +public final class ChatButtonSerializer extends ApolloButtonSerializer { + + @Override + protected ApolloButton.ApolloButtonBuilder createBuilder(ConfigurationNode node) throws SerializationException { + ChatButton.ChatButtonBuilder builder = ChatButton.builder(); + + Color background = node.node("background-color").get(Color.class); + if (background != null) { + builder.backgroundColor(background); + } + + Color border = node.node("border-color").get(Color.class); + if (border != null) { + builder.borderColor(border); + } + + return builder; + } + +} diff --git a/common/src/main/java/com/lunarclient/apollo/module/chat/ChatModuleImpl.java b/common/src/main/java/com/lunarclient/apollo/module/chat/ChatModuleImpl.java index ae4ee548..7b1a7eec 100644 --- a/common/src/main/java/com/lunarclient/apollo/module/chat/ChatModuleImpl.java +++ b/common/src/main/java/com/lunarclient/apollo/module/chat/ChatModuleImpl.java @@ -23,20 +23,66 @@ */ package com.lunarclient.apollo.module.chat; +import com.google.protobuf.Message; +import com.lunarclient.apollo.Apollo; import com.lunarclient.apollo.ApolloManager; +import com.lunarclient.apollo.button.v1.ButtonUpdate; +import com.lunarclient.apollo.chat.v1.DisplayChatButtonsMessage; import com.lunarclient.apollo.chat.v1.DisplayLiveChatMessageMessage; +import com.lunarclient.apollo.chat.v1.RemoveChatButtonMessage; import com.lunarclient.apollo.chat.v1.RemoveLiveChatMessageMessage; +import com.lunarclient.apollo.chat.v1.ResetChatButtonsMessage; +import com.lunarclient.apollo.chat.v1.UpdateChatButtonMessage; import com.lunarclient.apollo.common.ApolloComponent; +import com.lunarclient.apollo.common.button.ApolloButtonTooltip; +import com.lunarclient.apollo.common.button.content.ApolloButtonContent; +import com.lunarclient.apollo.event.packetenrichment.chat.ApolloPlayerChatCloseEvent; +import com.lunarclient.apollo.event.packetenrichment.chat.ApolloPlayerChatOpenEvent; +import com.lunarclient.apollo.event.player.ApolloRegisterPlayerEvent; +import com.lunarclient.apollo.event.player.ApolloUnregisterPlayerEvent; +import com.lunarclient.apollo.module.button.ButtonModuleSupport; +import com.lunarclient.apollo.module.button.ButtonSurface; +import com.lunarclient.apollo.module.packetenrichment.PacketEnrichmentModule; +import com.lunarclient.apollo.network.ButtonNetworkTypes; +import com.lunarclient.apollo.option.Options; +import com.lunarclient.apollo.option.config.Serializer; +import com.lunarclient.apollo.player.ApolloPlayer; import com.lunarclient.apollo.recipients.Recipients; +import java.util.Collection; +import java.util.Collections; +import java.util.List; import lombok.NonNull; import net.kyori.adventure.text.Component; +import org.jetbrains.annotations.Nullable; /** * Provides the chat module. * * @since 1.0.2 */ -public final class ChatModuleImpl extends ChatModule { +public final class ChatModuleImpl extends ChatModule implements ButtonSurface, Serializer { + + private final ButtonModuleSupport support = + new ButtonModuleSupport<>(this, this, ChatModule.BROADCAST_LIVE_BUTTONS); + + /** + * Creates a new instance of {@link ChatModuleImpl}. + * + * @since 1.2.9 + */ + public ChatModuleImpl() { + super(); + this.serializer(ChatButton.class, new ChatButtonSerializer()); + this.handle(ApolloRegisterPlayerEvent.class, this::onPlayerRegister); + this.handle(ApolloPlayerChatOpenEvent.class, event -> this.support.handleOpen(event.getPlayer())); + this.handle(ApolloPlayerChatCloseEvent.class, event -> this.support.handleClose(event.getPlayer().getUniqueId())); + this.handle(ApolloUnregisterPlayerEvent.class, event -> this.support.handleUnregister(event.getPlayer().getUniqueId())); + } + + @Override + protected void onEnable() { + this.support.startBroadcast(); + } @Override public void displayLiveChatMessage(@NonNull Recipients recipients, @NonNull Component text, int messageId) { @@ -57,4 +103,126 @@ public void removeLiveChatMessage(@NonNull Recipients recipients, int messageId) ApolloManager.getNetworkManager().sendPacket(recipients, message); } + @Override + public void displayChatButtons(@NonNull Recipients recipients, @NonNull Collection buttons) { + if (buttons.size() > ChatButton.MAX_BUTTONS) { + throw new IllegalArgumentException("ChatButton batches support at most " + ChatButton.MAX_BUTTONS + " buttons"); + } + + this.support.displayButtons(recipients, buttons); + } + + @Override + public void displayChatButton(@NonNull Recipients recipients, @NonNull ChatButton button) { + this.support.displayButtons(recipients, Collections.singleton(button)); + } + + @Override + public void removeChatButton(@NonNull Recipients recipients, @NonNull String buttonId) { + this.support.removeButton(recipients, buttonId); + } + + @Override + public void removeChatButton(@NonNull Recipients recipients, @NonNull ChatButton button) { + this.support.removeButton(recipients, button.getId()); + } + + @Override + public void resetChatButtons(@NonNull Recipients recipients) { + this.support.resetButtons(recipients); + } + + @Override + public void updateChatButton(@NonNull Recipients recipients, @NonNull String buttonId, + @NonNull ApolloButtonContent content, @Nullable ApolloButtonTooltip tooltip) { + this.support.pushUpdate(recipients, buttonId, content, true, tooltip); + } + + @Override + public void updateChatButtonContent(@NonNull Recipients recipients, @NonNull String buttonId, @NonNull ApolloButtonContent content) { + this.support.pushUpdate(recipients, buttonId, content, false, null); + } + + @Override + public void updateChatButtonTooltip(@NonNull Recipients recipients, @NonNull String buttonId, @Nullable ApolloButtonTooltip tooltip) { + this.support.pushUpdate(recipients, buttonId, null, true, tooltip); + } + + private void onPlayerRegister(ApolloRegisterPlayerEvent event) { + if (!this.isEnabled() || !this.getOptions().get(ChatModule.SEND_DEFAULT_BUTTONS)) { + return; + } + + ApolloPlayer player = event.getPlayer(); + List buttons = this.getOptions().get(player, ChatModule.DEFAULT_BUTTONS); + if (buttons == null || buttons.isEmpty()) { + return; + } + + try { + this.support.displayButtons(player, buttons); + } catch (IllegalArgumentException exception) { + Apollo.getPlatform().getPlatformLogger() + .warning("Skipping the default chat buttons: " + exception.getMessage()); + } + } + + @Override + public void validate(ChatButton button) { + ButtonModuleSupport.validateCommon(button, ChatButton.BOX_WIDTH, ChatButton.BOX_HEIGHT); + } + + @Override + public com.lunarclient.apollo.chat.v1.ChatButton toDisplayElement(ChatButton button, @Nullable ApolloPlayer viewer) { + return com.lunarclient.apollo.chat.v1.ChatButton.newBuilder() + .setButton(ButtonNetworkTypes.toProtobuf(button, viewer)) + .build(); + } + + @Override + public Message createDisplay(List elements) { + return DisplayChatButtonsMessage.newBuilder() + .addAllChatButtons(elements) + .build(); + } + + @Override + public Message createUpdate(String buttonId, ButtonUpdate update) { + return UpdateChatButtonMessage.newBuilder() + .setId(buttonId) + .setUpdate(update) + .build(); + } + + @Override + public Message createRemove(String buttonId) { + return RemoveChatButtonMessage.newBuilder() + .setId(buttonId) + .build(); + } + + @Override + public Message createReset() { + return ResetChatButtonsMessage.getDefaultInstance(); + } + + /** + * Returns whether open-chat tracking is available. + * + * @return whether open-chat tracking is active + */ + @Override + public boolean isOpenTrackingActive() { + PacketEnrichmentModule packetEnrichment = Apollo.getModuleManager().getModule(PacketEnrichmentModule.class); + if (packetEnrichment == null || !packetEnrichment.isEnabled()) { + return false; + } + + Options options = packetEnrichment.getOptions(); + return options.get(PacketEnrichmentModule.PLAYER_CHAT_OPEN_PACKET) + && options.get(PacketEnrichmentModule.PLAYER_CHAT_CLOSE_PACKET) + && options.get(PacketEnrichmentModule.PLAYER_CHAT_OPEN_EVENT) + && options.get(PacketEnrichmentModule.PLAYER_CHAT_CLOSE_EVENT); + } + } diff --git a/common/src/main/java/com/lunarclient/apollo/module/heightlimit/HeightLimitModuleImpl.java b/common/src/main/java/com/lunarclient/apollo/module/heightlimit/HeightLimitModuleImpl.java new file mode 100644 index 00000000..e8887aed --- /dev/null +++ b/common/src/main/java/com/lunarclient/apollo/module/heightlimit/HeightLimitModuleImpl.java @@ -0,0 +1,156 @@ +/* + * This file is part of Apollo, licensed under the MIT License. + * + * Copyright (c) 2026 Moonsworth + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +package com.lunarclient.apollo.module.heightlimit; + +import com.lunarclient.apollo.ApolloManager; +import com.lunarclient.apollo.common.ApolloComponent; +import com.lunarclient.apollo.event.player.ApolloRegisterPlayerEvent; +import com.lunarclient.apollo.heightlimit.v1.OverrideHeightLimitMessage; +import com.lunarclient.apollo.heightlimit.v1.RemoveHeightLimitMessage; +import com.lunarclient.apollo.heightlimit.v1.ResetHeightLimitsMessage; +import com.lunarclient.apollo.option.config.Serializer; +import com.lunarclient.apollo.player.ApolloPlayer; +import com.lunarclient.apollo.recipients.Recipients; +import java.lang.reflect.Type; +import java.util.Arrays; +import java.util.List; +import lombok.NonNull; +import net.kyori.adventure.text.Component; +import org.checkerframework.checker.nullness.qual.Nullable; +import org.spongepowered.configurate.ConfigurationNode; +import org.spongepowered.configurate.serialize.SerializationException; +import org.spongepowered.configurate.serialize.TypeSerializer; + +import static com.lunarclient.apollo.util.Ranges.checkStrictlyPositive; + +/** + * Provides the height limit module. + * + * @since 1.2.9 + */ +public final class HeightLimitModuleImpl extends HeightLimitModule implements Serializer { + + /** + * Creates a new instance of {@link HeightLimitModuleImpl}. + * + * @since 1.2.9 + */ + public HeightLimitModuleImpl() { + super(); + this.serializer(HeightLimit.class, new HeightLimitSerializer()); + this.handle(ApolloRegisterPlayerEvent.class, this::onPlayerRegister); + } + + @Override + public void overrideHeightLimit(@NonNull Recipients recipients, @NonNull HeightLimit heightLimit) { + OverrideHeightLimitMessage.Builder builder = OverrideHeightLimitMessage.newBuilder() + .setWorld(heightLimit.getWorld()) + .setLimit(checkStrictlyPositive(heightLimit.getLimit(), "HeightLimit#limit")); + + Component displayName = heightLimit.getDisplayName(); + if (displayName != null) { + builder.setDisplayNameAdventureJsonLines(ApolloComponent.toJson(displayName)); + } + + OverrideHeightLimitMessage message = builder.build(); + ApolloManager.getNetworkManager().sendPacket(recipients, message); + } + + @Override + public void removeHeightLimit(@NonNull Recipients recipients, @NonNull String world) { + RemoveHeightLimitMessage message = RemoveHeightLimitMessage.newBuilder() + .setWorld(world) + .build(); + + ApolloManager.getNetworkManager().sendPacket(recipients, message); + } + + @Override + public void removeHeightLimit(@NonNull Recipients recipients, @NonNull HeightLimit heightLimit) { + this.removeHeightLimit(recipients, heightLimit.getWorld()); + } + + @Override + public void resetHeightLimits(@NonNull Recipients recipients) { + ResetHeightLimitsMessage message = ResetHeightLimitsMessage.getDefaultInstance(); + ApolloManager.getNetworkManager().sendPacket(recipients, message); + } + + private void onPlayerRegister(ApolloRegisterPlayerEvent event) { + if (!this.isEnabled()) { + return; + } + + ApolloPlayer player = event.getPlayer(); + List heightLimits = this.getOptions().get(player, HeightLimitModule.DEFAULT_HEIGHT_LIMITS); + + if (heightLimits != null) { + for (HeightLimit heightLimit : heightLimits) { + this.overrideHeightLimit(player, heightLimit); + } + } + } + + private static final class HeightLimitSerializer implements TypeSerializer { + + @Override + public HeightLimit deserialize(Type type, ConfigurationNode node) throws SerializationException { + HeightLimit.HeightLimitBuilder builder = HeightLimit.builder() + .world(this.virtualNode(node, "world").getString()) + .limit(this.virtualNode(node, "limit").getInt()); + + String displayName = node.node("display-name").getString(); + if (displayName != null) { + builder.displayName(ApolloComponent.fromLegacyAmpersand(displayName)); + } + + return builder.build(); + } + + @Override + public void serialize(Type type, @Nullable HeightLimit heightLimit, ConfigurationNode node) throws SerializationException { + if (heightLimit == null) { + node.raw(null); + return; + } + + node.node("world").set(heightLimit.getWorld()); + node.node("limit").set(heightLimit.getLimit()); + + Component displayName = heightLimit.getDisplayName(); + if (displayName != null) { + node.node("display-name").set(ApolloComponent.toLegacyAmpersand(displayName)); + } + } + + private ConfigurationNode virtualNode(ConfigurationNode source, Object... path) throws SerializationException { + if (!source.hasChild(path)) { + throw new SerializationException("Required field " + Arrays.toString(path) + " not found!"); + } + + return source.node(path); + } + } + +} diff --git a/common/src/main/java/com/lunarclient/apollo/module/inventory/InventoryButtonSerializer.java b/common/src/main/java/com/lunarclient/apollo/module/inventory/InventoryButtonSerializer.java new file mode 100644 index 00000000..505c00b6 --- /dev/null +++ b/common/src/main/java/com/lunarclient/apollo/module/inventory/InventoryButtonSerializer.java @@ -0,0 +1,66 @@ +/* + * This file is part of Apollo, licensed under the MIT License. + * + * Copyright (c) 2026 Moonsworth + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +package com.lunarclient.apollo.module.inventory; + +import com.lunarclient.apollo.common.button.ApolloButton; +import com.lunarclient.apollo.module.button.ApolloButtonSerializer; +import java.awt.Color; +import org.spongepowered.configurate.ConfigurationNode; +import org.spongepowered.configurate.serialize.SerializationException; + +/** + * Reads and writes {@link InventoryButton}s from the module configuration; + * see {@link ApolloButtonSerializer} for the shared button fields. + * + * @since 1.2.9 + */ +public final class InventoryButtonSerializer extends ApolloButtonSerializer { + + @Override + protected ApolloButton.ApolloButtonBuilder createBuilder(ConfigurationNode node) throws SerializationException { + InventoryButton.InventoryButtonBuilder builder = InventoryButton.builder() + .inventoryType(this.parseEnum(InventoryType.class, + this.virtualNode(node, "inventory-type").getString(), "inventory-type")) + .box(this.parseEnum(InventoryButtonBox.class, this.virtualNode(node, "box").getString(), "box")); + + Color background = node.node("background-color").get(Color.class); + if (background != null) { + builder.backgroundColor(background); + } + + Color border = node.node("border-color").get(Color.class); + if (border != null) { + builder.borderColor(border); + } + + return builder; + } + + @Override + protected void serializeSurface(InventoryButton button, ConfigurationNode node) throws SerializationException { + node.node("inventory-type").set(button.getInventoryType().name()); + node.node("box").set(button.getBox().name()); + } + +} diff --git a/common/src/main/java/com/lunarclient/apollo/module/inventory/InventoryModuleImpl.java b/common/src/main/java/com/lunarclient/apollo/module/inventory/InventoryModuleImpl.java new file mode 100644 index 00000000..87590b87 --- /dev/null +++ b/common/src/main/java/com/lunarclient/apollo/module/inventory/InventoryModuleImpl.java @@ -0,0 +1,221 @@ +/* + * This file is part of Apollo, licensed under the MIT License. + * + * Copyright (c) 2026 Moonsworth + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +package com.lunarclient.apollo.module.inventory; + +import com.google.protobuf.Message; +import com.lunarclient.apollo.Apollo; +import com.lunarclient.apollo.button.v1.ButtonUpdate; +import com.lunarclient.apollo.common.button.ApolloButtonTooltip; +import com.lunarclient.apollo.common.button.content.ApolloButtonContent; +import com.lunarclient.apollo.event.packetenrichment.inventory.ApolloPlayerInventoryCloseEvent; +import com.lunarclient.apollo.event.packetenrichment.inventory.ApolloPlayerInventoryOpenEvent; +import com.lunarclient.apollo.event.player.ApolloRegisterPlayerEvent; +import com.lunarclient.apollo.event.player.ApolloUnregisterPlayerEvent; +import com.lunarclient.apollo.inventory.v1.DisplayInventoryButtonsMessage; +import com.lunarclient.apollo.inventory.v1.RemoveInventoryButtonMessage; +import com.lunarclient.apollo.inventory.v1.ResetInventoryButtonsMessage; +import com.lunarclient.apollo.inventory.v1.UpdateInventoryButtonMessage; +import com.lunarclient.apollo.module.button.ButtonModuleSupport; +import com.lunarclient.apollo.module.button.ButtonSurface; +import com.lunarclient.apollo.module.packetenrichment.PacketEnrichmentModule; +import com.lunarclient.apollo.network.ButtonNetworkTypes; +import com.lunarclient.apollo.option.Options; +import com.lunarclient.apollo.option.config.Serializer; +import com.lunarclient.apollo.player.ApolloPlayer; +import com.lunarclient.apollo.recipients.Recipients; +import java.util.Collection; +import java.util.Collections; +import java.util.List; +import lombok.NonNull; +import org.jetbrains.annotations.Nullable; + +/** + * Provides the inventory module. + * + * @since 1.2.9 + */ +public final class InventoryModuleImpl extends InventoryModule implements ButtonSurface, Serializer { + + private final ButtonModuleSupport support = + new ButtonModuleSupport<>(this, this, InventoryModule.BROADCAST_LIVE_BUTTONS); + + /** + * Creates a new instance of {@link InventoryModuleImpl}. + * + * @since 1.2.9 + */ + public InventoryModuleImpl() { + super(); + this.serializer(InventoryButton.class, new InventoryButtonSerializer()); + this.handle(ApolloRegisterPlayerEvent.class, this::onPlayerRegister); + this.handle(ApolloPlayerInventoryOpenEvent.class, event -> this.support.handleOpen(event.getPlayer())); + this.handle(ApolloPlayerInventoryCloseEvent.class, event -> this.support.handleClose(event.getPlayer().getUniqueId())); + this.handle(ApolloUnregisterPlayerEvent.class, event -> this.support.handleUnregister(event.getPlayer().getUniqueId())); + } + + @Override + protected void onEnable() { + this.support.startBroadcast(); + } + + @Override + public void displayInventoryButtons(@NonNull Recipients recipients, @NonNull Collection buttons) { + int leftButtons = 0; + int rightButtons = 0; + for (InventoryButton button : buttons) { + if (button.getBox() == InventoryButtonBox.LEFT) { + leftButtons++; + } else if (button.getBox() == InventoryButtonBox.RIGHT) { + rightButtons++; + } + } + + if (leftButtons > InventoryButton.MAX_BUTTONS_PER_BOX || rightButtons > InventoryButton.MAX_BUTTONS_PER_BOX) { + throw new IllegalArgumentException("InventoryButton batches support at most " + InventoryButton.MAX_BUTTONS_PER_BOX + " buttons per box"); + } + + this.support.displayButtons(recipients, buttons); + } + + @Override + public void displayInventoryButton(@NonNull Recipients recipients, @NonNull InventoryButton button) { + this.support.displayButtons(recipients, Collections.singleton(button)); + } + + @Override + public void removeInventoryButton(@NonNull Recipients recipients, @NonNull String buttonId) { + this.support.removeButton(recipients, buttonId); + } + + @Override + public void removeInventoryButton(@NonNull Recipients recipients, @NonNull InventoryButton button) { + this.support.removeButton(recipients, button.getId()); + } + + @Override + public void resetInventoryButtons(@NonNull Recipients recipients) { + this.support.resetButtons(recipients); + } + + @Override + public void updateInventoryButton(@NonNull Recipients recipients, @NonNull String buttonId, + @NonNull ApolloButtonContent content, @Nullable ApolloButtonTooltip tooltip) { + this.support.pushUpdate(recipients, buttonId, content, true, tooltip); + } + + @Override + public void updateInventoryButtonContent(@NonNull Recipients recipients, @NonNull String buttonId, @NonNull ApolloButtonContent content) { + this.support.pushUpdate(recipients, buttonId, content, false, null); + } + + @Override + public void updateInventoryButtonTooltip(@NonNull Recipients recipients, @NonNull String buttonId, @Nullable ApolloButtonTooltip tooltip) { + this.support.pushUpdate(recipients, buttonId, null, true, tooltip); + } + + private void onPlayerRegister(ApolloRegisterPlayerEvent event) { + if (!this.isEnabled() || !this.getOptions().get(InventoryModule.SEND_DEFAULT_BUTTONS)) { + return; + } + + ApolloPlayer player = event.getPlayer(); + List buttons = this.getOptions().get(player, InventoryModule.DEFAULT_BUTTONS); + if (buttons == null || buttons.isEmpty()) { + return; + } + + try { + this.support.displayButtons(player, buttons); + } catch (IllegalArgumentException exception) { + Apollo.getPlatform().getPlatformLogger() + .warning("Skipping the default inventory buttons: " + exception.getMessage()); + } + } + + @Override + public void validate(InventoryButton button) { + ButtonModuleSupport.validateCommon(button, InventoryButton.BOX_WIDTH, InventoryButton.BOX_HEIGHT); + + ButtonModuleSupport.requireSet(button.getInventoryType(), "InventoryButton#inventoryType"); + ButtonModuleSupport.requireSet(button.getBox(), "InventoryButton#box"); + } + + @Override + public com.lunarclient.apollo.inventory.v1.InventoryButton toDisplayElement(InventoryButton button, @Nullable ApolloPlayer viewer) { + return com.lunarclient.apollo.inventory.v1.InventoryButton.newBuilder() + .setButton(ButtonNetworkTypes.toProtobuf(button, viewer)) + .setInventoryType(com.lunarclient.apollo.inventory.v1.InventoryType + .forNumber(button.getInventoryType().ordinal() + 1)) + .setBox(com.lunarclient.apollo.inventory.v1.InventoryButtonBox + .forNumber(button.getBox().ordinal() + 1)) + .build(); + } + + @Override + public Message createDisplay(List elements) { + return DisplayInventoryButtonsMessage.newBuilder() + .addAllInventoryButtons(elements) + .build(); + } + + @Override + public Message createUpdate(String buttonId, ButtonUpdate update) { + return UpdateInventoryButtonMessage.newBuilder() + .setId(buttonId) + .setUpdate(update) + .build(); + } + + @Override + public Message createRemove(String buttonId) { + return RemoveInventoryButtonMessage.newBuilder() + .setId(buttonId) + .build(); + } + + @Override + public Message createReset() { + return ResetInventoryButtonsMessage.getDefaultInstance(); + } + + /** + * Returns whether open-inventory tracking is available. + * + * @return whether open-inventory tracking is active + */ + @Override + public boolean isOpenTrackingActive() { + PacketEnrichmentModule packetEnrichment = Apollo.getModuleManager().getModule(PacketEnrichmentModule.class); + if (packetEnrichment == null || !packetEnrichment.isEnabled()) { + return false; + } + + Options options = packetEnrichment.getOptions(); + return options.get(PacketEnrichmentModule.PLAYER_INVENTORY_OPEN_PACKET) + && options.get(PacketEnrichmentModule.PLAYER_INVENTORY_CLOSE_PACKET) + && options.get(PacketEnrichmentModule.PLAYER_INVENTORY_OPEN_EVENT) + && options.get(PacketEnrichmentModule.PLAYER_INVENTORY_CLOSE_EVENT); + } + +} diff --git a/common/src/main/java/com/lunarclient/apollo/module/nametag/NametagModuleImpl.java b/common/src/main/java/com/lunarclient/apollo/module/nametag/NametagModuleImpl.java index 5254595d..e055f0a0 100644 --- a/common/src/main/java/com/lunarclient/apollo/module/nametag/NametagModuleImpl.java +++ b/common/src/main/java/com/lunarclient/apollo/module/nametag/NametagModuleImpl.java @@ -50,6 +50,11 @@ public void overrideNametag(@NonNull Recipients recipients, @NonNull UUID player builder.addAdventureJsonLines(ApolloComponent.toJson(line)); } + NametagVisibilityOverride visibility = nametag.getVisibilityOverride(); + if (visibility != null && visibility != NametagVisibilityOverride.NONE) { + builder.setVisibilityOverride(this.toProtobuf(visibility)); + } + ApolloManager.getNetworkManager().sendPacket(recipients, builder.build()); } @@ -68,4 +73,8 @@ public void resetNametags(@NonNull Recipients recipients) { ApolloManager.getNetworkManager().sendPacket(recipients, message); } + private com.lunarclient.apollo.nametag.v1.NametagVisibilityOverride toProtobuf(NametagVisibilityOverride visibility) { + return com.lunarclient.apollo.nametag.v1.NametagVisibilityOverride.forNumber(visibility.ordinal() + 1); + } + } diff --git a/common/src/main/java/com/lunarclient/apollo/module/packetenrichment/PacketEnrichmentImpl.java b/common/src/main/java/com/lunarclient/apollo/module/packetenrichment/PacketEnrichmentImpl.java index 1446ef11..8bbe8004 100644 --- a/common/src/main/java/com/lunarclient/apollo/module/packetenrichment/PacketEnrichmentImpl.java +++ b/common/src/main/java/com/lunarclient/apollo/module/packetenrichment/PacketEnrichmentImpl.java @@ -27,6 +27,8 @@ import com.lunarclient.apollo.event.EventBus; import com.lunarclient.apollo.event.packetenrichment.chat.ApolloPlayerChatCloseEvent; import com.lunarclient.apollo.event.packetenrichment.chat.ApolloPlayerChatOpenEvent; +import com.lunarclient.apollo.event.packetenrichment.inventory.ApolloPlayerInventoryCloseEvent; +import com.lunarclient.apollo.event.packetenrichment.inventory.ApolloPlayerInventoryOpenEvent; import com.lunarclient.apollo.event.packetenrichment.melee.ApolloPlayerAttackEvent; import com.lunarclient.apollo.event.packetenrichment.world.ApolloPlayerUseItemBucketEvent; import com.lunarclient.apollo.event.packetenrichment.world.ApolloPlayerUseItemEvent; @@ -35,6 +37,8 @@ import com.lunarclient.apollo.packetenrichment.v1.PlayerAttackMessage; import com.lunarclient.apollo.packetenrichment.v1.PlayerChatCloseMessage; import com.lunarclient.apollo.packetenrichment.v1.PlayerChatOpenMessage; +import com.lunarclient.apollo.packetenrichment.v1.PlayerInventoryCloseMessage; +import com.lunarclient.apollo.packetenrichment.v1.PlayerInventoryOpenMessage; import com.lunarclient.apollo.packetenrichment.v1.PlayerUseItemBucketMessage; import com.lunarclient.apollo.packetenrichment.v1.PlayerUseItemMessage; @@ -56,6 +60,10 @@ public PacketEnrichmentImpl() { } private void onReceivePacket(ApolloReceivePacketEvent event) { + if (!this.isEnabled()) { + return; + } + Options options = this.getOptions(); if (options.get(PacketEnrichmentModule.PLAYER_ATTACK_EVENT)) { @@ -106,6 +114,36 @@ private void onReceivePacket(ApolloReceivePacketEvent event) { }); } + if (options.get(PacketEnrichmentModule.PLAYER_INVENTORY_OPEN_EVENT)) { + event.unpack(PlayerInventoryOpenMessage.class).ifPresent(packet -> { + ApolloPlayerInventoryOpenEvent playerInventoryOpenEvent = new ApolloPlayerInventoryOpenEvent( + event.getPlayer(), + NetworkTypes.fromProtobuf(packet.getPacketInfo().getInstantiationTime()), + NetworkTypes.fromProtobuf(packet.getPlayerInfo())); + + EventBus.EventResult result = EventBus.getBus().post(playerInventoryOpenEvent); + + for (Throwable throwable : result.getThrowing()) { + throwable.printStackTrace(); + } + }); + } + + if (options.get(PacketEnrichmentModule.PLAYER_INVENTORY_CLOSE_EVENT)) { + event.unpack(PlayerInventoryCloseMessage.class).ifPresent(packet -> { + ApolloPlayerInventoryCloseEvent playerInventoryCloseEvent = new ApolloPlayerInventoryCloseEvent( + event.getPlayer(), + NetworkTypes.fromProtobuf(packet.getPacketInfo().getInstantiationTime()), + NetworkTypes.fromProtobuf(packet.getPlayerInfo())); + + EventBus.EventResult result = EventBus.getBus().post(playerInventoryCloseEvent); + + for (Throwable throwable : result.getThrowing()) { + throwable.printStackTrace(); + } + }); + } + if (options.get(PacketEnrichmentModule.PLAYER_USE_ITEM_EVENT)) { event.unpack(PlayerUseItemMessage.class).ifPresent(packet -> { ApolloPlayerUseItemEvent playerUseItemEvent = new ApolloPlayerUseItemEvent( diff --git a/common/src/main/java/com/lunarclient/apollo/module/transfer/TransferModuleImpl.java b/common/src/main/java/com/lunarclient/apollo/module/transfer/TransferModuleImpl.java index 6971cf56..febd0109 100644 --- a/common/src/main/java/com/lunarclient/apollo/module/transfer/TransferModuleImpl.java +++ b/common/src/main/java/com/lunarclient/apollo/module/transfer/TransferModuleImpl.java @@ -53,9 +53,20 @@ public TransferModuleImpl() { @Override public Future ping(@NonNull ApolloPlayer player, @NonNull PingRequest request) { + List serverIps = request.getServerIps(); + + if (serverIps == null || serverIps.isEmpty()) { + throw new IllegalArgumentException("PingRequest must contain at least 1 server IP!"); + } + + if (serverIps.size() > MAX_PINGS_PER_PACKET) { + throw new IllegalArgumentException("PingRequest supports up to " + MAX_PINGS_PER_PACKET + + " server IPs, got " + serverIps.size() + "!"); + } + com.lunarclient.apollo.transfer.v1.PingRequest requestProto = com.lunarclient.apollo.transfer.v1.PingRequest.newBuilder() .setRequestId(ByteString.copyFromUtf8(request.getRequestId().toString())) - .addAllServerIps(request.getServerIps()) + .addAllServerIps(serverIps) .build(); return ((AbstractApolloPlayer) player).sendRoundTripPacket(request, requestProto); diff --git a/common/src/main/java/com/lunarclient/apollo/module/waypoint/WaypointModuleImpl.java b/common/src/main/java/com/lunarclient/apollo/module/waypoint/WaypointModuleImpl.java index b9ed8e3b..320eab67 100644 --- a/common/src/main/java/com/lunarclient/apollo/module/waypoint/WaypointModuleImpl.java +++ b/common/src/main/java/com/lunarclient/apollo/module/waypoint/WaypointModuleImpl.java @@ -110,6 +110,10 @@ public void hideWaypoint(@NonNull Recipients recipients, @NonNull String waypoin } private void onPlayerRegister(ApolloRegisterPlayerEvent event) { + if (!this.isEnabled()) { + return; + } + ApolloPlayer player = event.getPlayer(); List waypoints = this.getOptions().get(player, WaypointModule.DEFAULT_WAYPOINTS); diff --git a/common/src/main/java/com/lunarclient/apollo/network/ButtonNetworkTypes.java b/common/src/main/java/com/lunarclient/apollo/network/ButtonNetworkTypes.java new file mode 100644 index 00000000..3baad24a --- /dev/null +++ b/common/src/main/java/com/lunarclient/apollo/network/ButtonNetworkTypes.java @@ -0,0 +1,262 @@ +/* + * This file is part of Apollo, licensed under the MIT License. + * + * Copyright (c) 2026 Moonsworth + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +package com.lunarclient.apollo.network; + +import com.lunarclient.apollo.button.v1.Button; +import com.lunarclient.apollo.button.v1.ButtonClientAction; +import com.lunarclient.apollo.button.v1.ButtonContent; +import com.lunarclient.apollo.button.v1.ButtonContentPart; +import com.lunarclient.apollo.button.v1.ButtonShape; +import com.lunarclient.apollo.button.v1.ButtonSize; +import com.lunarclient.apollo.button.v1.ButtonTooltip; +import com.lunarclient.apollo.button.v1.ButtonUpdate; +import com.lunarclient.apollo.common.ApolloComponent; +import com.lunarclient.apollo.common.button.ApolloButton; +import com.lunarclient.apollo.common.button.ApolloButtonTooltip; +import com.lunarclient.apollo.common.button.action.ApolloButtonAction; +import com.lunarclient.apollo.common.button.action.ClientAction; +import com.lunarclient.apollo.common.button.action.OpenUrlAction; +import com.lunarclient.apollo.common.button.action.RunCommandAction; +import com.lunarclient.apollo.common.button.content.ApolloButtonContent; +import com.lunarclient.apollo.common.button.content.ApolloButtonContentPart; +import com.lunarclient.apollo.common.button.content.ComponentPart; +import com.lunarclient.apollo.common.button.content.IconPart; +import com.lunarclient.apollo.common.button.content.LiveComponentPart; +import com.lunarclient.apollo.player.ApolloPlayer; +import java.awt.Color; +import java.util.ArrayList; +import java.util.Collections; +import java.util.List; +import java.util.function.Function; +import java.util.stream.Collectors; +import net.kyori.adventure.text.Component; +import org.jetbrains.annotations.Nullable; + +/** + * Serializes the shared {@code common.button} API types into their + * {@code button.v1} protobuf counterparts, resolving live content and + * tooltips for a viewing player. + * + * @since 1.2.9 + */ +public final class ButtonNetworkTypes { + + /** + * Serializes the fields of the given button. + * + * @param button the button to serialize + * @param viewer the viewing player live parts are resolved for, or + * {@code null} when the button has no live parts + * @return the protobuf button + * @since 1.2.9 + */ + public static Button toProtobuf(ApolloButton button, @Nullable ApolloPlayer viewer) { + Button.Builder builder = Button.newBuilder() + .setId(button.getId()) + .setPosition(NetworkTypes.toProtobuf(button.getPosition())) + .setSize(ButtonSize.newBuilder() + .setWidth(button.getSize().getWidth()) + .setHeight(button.getSize().getHeight()) + .build()) + .setShape(ButtonShape.forNumber(button.getShape().ordinal() + 1)) + .setBackgroundColor(NetworkTypes.toProtobuf(button.getBackgroundColor())) + .setBorderColor(NetworkTypes.toProtobuf(button.getBorderColor())) + .setContent(toContentProtobuf(button.getContent(), viewer)); + + ButtonTooltip tooltip = toTooltipProtobuf(button.getTooltip(), viewer); + if (tooltip != null) { + builder.setTooltip(tooltip); + } + + ApolloButtonAction onClick = button.getOnClick(); + if (onClick instanceof RunCommandAction) { + builder.setRunCommand(((RunCommandAction) onClick).getCommand()); + } else if (onClick instanceof OpenUrlAction) { + builder.setOpenUrl(((OpenUrlAction) onClick).getUrl()); + } else if (onClick instanceof ClientAction) { + ClientAction clientAction = (ClientAction) onClick; + builder.setClientAction(ButtonClientAction.forNumber(clientAction.getAction().ordinal() + 1)); + } else if (onClick != null) { + throw new IllegalArgumentException("Unknown button action type: " + onClick.getClass().getName()); + } + + Color hoveredBackgroundColor = button.getHoveredBackgroundColor(); + if (hoveredBackgroundColor != null) { + builder.setHoveredBackgroundColor(NetworkTypes.toProtobuf(hoveredBackgroundColor)); + } + + Color hoveredBorderColor = button.getHoveredBorderColor(); + if (hoveredBorderColor != null) { + builder.setHoveredBorderColor(NetworkTypes.toProtobuf(hoveredBorderColor)); + } + + return builder.build(); + } + + /** + * Serializes button content, resolving live parts for the given viewer. + * + * @param content the content to serialize + * @param viewer the viewing player live parts are resolved for, or + * {@code null} when the content has no live parts + * @return the protobuf content + * @since 1.2.9 + */ + public static ButtonContent toContentProtobuf(ApolloButtonContent content, @Nullable ApolloPlayer viewer) { + return ButtonContent.newBuilder() + .addAllParts(resolveContentParts(content, viewer)) + .setScale(content.getScale()) + .build(); + } + + private static List resolveContentParts(ApolloButtonContent content, + @Nullable ApolloPlayer viewer) { + List parts = new ArrayList<>(); + + for (ApolloButtonContentPart part : content.getParts()) { + ButtonContentPart.Builder partBuilder = ButtonContentPart.newBuilder(); + + if (part instanceof LiveComponentPart) { + Function resolver = ((LiveComponentPart) part).getResolver(); + partBuilder.setAdventureJsonText(ApolloComponent.toJson(resolveLive(resolver, viewer))); + } else if (part instanceof ComponentPart) { + partBuilder.setAdventureJsonText(ApolloComponent.toJson(((ComponentPart) part).getComponent())); + } else if (part instanceof IconPart) { + partBuilder.setIcon(NetworkTypes.toProtobuf(((IconPart) part).getIcon())); + } else { + throw new IllegalArgumentException("Unknown button content part type: " + part.getClass().getName()); + } + + parts.add(partBuilder.build()); + } + + return parts; + } + + /** + * Serializes a button tooltip, resolving live tooltips for the given + * viewer. + * + * @param tooltip the tooltip to serialize, or {@code null} + * @param viewer the viewing player a live tooltip is resolved for, or + * {@code null} when the tooltip is static + * @return the protobuf tooltip + * @since 1.2.9 + */ + public static @Nullable ButtonTooltip toTooltipProtobuf(@Nullable ApolloButtonTooltip tooltip, + @Nullable ApolloPlayer viewer) { + List lines = resolveTooltipLines(tooltip, viewer); + if (lines == null) { + return null; + } + + return ButtonTooltip.newBuilder() + .addAllAdventureJsonLines(lines) + .build(); + } + + /** + * Builds a partial-update fragment. + * + * @param content the new content, or {@code null} to keep the current one + * @param tooltip the new tooltip, or {@code null} to clear it + * @param tooltipPresent whether the tooltip field should be set at all + * @param viewer the viewing player live values are resolved for, or {@code null} + * @return the protobuf update + * @since 1.2.9 + */ + public static ButtonUpdate toUpdateProtobuf(@Nullable ApolloButtonContent content, + @Nullable ApolloButtonTooltip tooltip, + boolean tooltipPresent, + @Nullable ApolloPlayer viewer) { + ButtonUpdate.Builder builder = ButtonUpdate.newBuilder(); + + if (content != null) { + builder.setContent(toContentProtobuf(content, viewer)); + } + + if (tooltipPresent) { + ButtonTooltip tooltipProto = toTooltipProtobuf(tooltip, viewer); + if (tooltipProto != null) { + builder.setTooltip(tooltipProto); + } + } + + return builder.build(); + } + + private static Component resolveLive(Function resolver, @Nullable ApolloPlayer viewer) { + if (viewer == null) { + return Component.empty(); + } + + try { + Component component = resolver.apply(viewer); + return component != null ? component : Component.empty(); + } catch (Throwable throwable) { + throwable.printStackTrace(); + return Component.empty(); + } + } + + private static @Nullable List resolveTooltipLines(@Nullable ApolloButtonTooltip tooltip, + @Nullable ApolloPlayer viewer) { + if (tooltip == null) { + return Collections.emptyList(); + } + + List lines = tooltip.getLines(); + + Function> resolver = tooltip.getResolver(); + if (resolver != null && viewer != null) { + lines = null; + try { + lines = resolver.apply(viewer); + } catch (Throwable throwable) { + throwable.printStackTrace(); + } + + if (lines == null) { + return null; + } + } + + if (lines == null) { + return Collections.emptyList(); + } + + try { + return lines.stream() + .map(ApolloComponent::toJson) + .collect(Collectors.toList()); + } catch (Throwable throwable) { + throwable.printStackTrace(); + return null; + } + } + + private ButtonNetworkTypes() { + } + +} diff --git a/common/src/main/java/com/lunarclient/apollo/network/NetworkTypes.java b/common/src/main/java/com/lunarclient/apollo/network/NetworkTypes.java index 00cb3c65..276175bf 100644 --- a/common/src/main/java/com/lunarclient/apollo/network/NetworkTypes.java +++ b/common/src/main/java/com/lunarclient/apollo/network/NetworkTypes.java @@ -591,6 +591,10 @@ public static com.lunarclient.apollo.common.v1.ItemStackIcon toProtobuf(ItemStac builder.setProfile(NetworkTypes.toProtobuf(icon.getProfile())); } + if (icon.getPotion() != null) { + builder.setPotion(icon.getPotion()); + } + return builder.build(); } @@ -616,6 +620,10 @@ public static ItemStackIcon fromProtobuf(com.lunarclient.apollo.common.v1.ItemSt builder.profile(NetworkTypes.fromProtobuf(icon.getProfile())); } + if (!icon.getPotion().isEmpty()) { + builder.potion(icon.getPotion()); + } + return builder.build(); } diff --git a/common/src/main/java/com/lunarclient/apollo/option/config/CommonSerializers.java b/common/src/main/java/com/lunarclient/apollo/option/config/CommonSerializers.java index 4462a872..fbd7c9ca 100644 --- a/common/src/main/java/com/lunarclient/apollo/option/config/CommonSerializers.java +++ b/common/src/main/java/com/lunarclient/apollo/option/config/CommonSerializers.java @@ -23,8 +23,19 @@ */ package com.lunarclient.apollo.option.config; +import com.lunarclient.apollo.common.icon.AdvancedResourceLocationIcon; +import com.lunarclient.apollo.common.icon.CustomModelData; +import com.lunarclient.apollo.common.icon.Icon; +import com.lunarclient.apollo.common.icon.ItemStackIcon; +import com.lunarclient.apollo.common.icon.ResourceLocationIcon; +import com.lunarclient.apollo.common.icon.SimpleResourceLocationIcon; +import com.lunarclient.apollo.common.profile.Profile; import java.awt.Color; import java.lang.reflect.Type; +import java.util.Collections; +import java.util.List; +import java.util.UUID; +import lombok.RequiredArgsConstructor; import org.checkerframework.checker.nullness.qual.Nullable; import org.spongepowered.configurate.ConfigurationNode; import org.spongepowered.configurate.serialize.SerializationException; @@ -43,7 +54,11 @@ public final class CommonSerializers implements Serializer { * @since 1.0.0 */ public CommonSerializers() { + ItemStackIconSerializer itemStackIconSerializer = new ItemStackIconSerializer(); + this.serializer(Color.class, new ColorSerializer()); + this.serializer(Icon.class, new IconSerializer(itemStackIconSerializer)); + this.serializer(ItemStackIcon.class, itemStackIconSerializer); } private static final class ColorSerializer implements TypeSerializer { @@ -87,4 +102,197 @@ public void serialize(Type type, @Nullable Color color, ConfigurationNode node) } } + @RequiredArgsConstructor + private static final class IconSerializer implements TypeSerializer { + + private final ItemStackIconSerializer itemStackIconSerializer; + + @Override + public Icon deserialize(Type type, ConfigurationNode node) throws SerializationException { + if (node.hasChild("name") || node.hasChild("id")) { + return this.itemStackIconSerializer.deserialize(type, node); + } + + if (!node.hasChild("resource-location")) { + throw new SerializationException("Icons require a 'name', 'id' or 'resource-location' field!"); + } + + String resourceLocation = node.node("resource-location").getString(); + if (resourceLocation == null || resourceLocation.isEmpty()) { + throw new SerializationException("Icon 'resource-location' must not be empty!"); + } + + if (node.hasChild("width") || node.hasChild("height") || node.hasChild("min-u") + || node.hasChild("max-u") || node.hasChild("min-v") || node.hasChild("max-v")) { + return AdvancedResourceLocationIcon.builder() + .resourceLocation(resourceLocation) + .width((float) node.node("width").getDouble()) + .height((float) node.node("height").getDouble()) + .minU((float) node.node("min-u").getDouble()) + .maxU((float) node.node("max-u").getDouble(1.0D)) + .minV((float) node.node("min-v").getDouble()) + .maxV((float) node.node("max-v").getDouble(1.0D)) + .build(); + } + + if (node.hasChild("size")) { + return SimpleResourceLocationIcon.builder() + .resourceLocation(resourceLocation) + .size(node.node("size").getInt()) + .build(); + } + + return ResourceLocationIcon.builder() + .resourceLocation(resourceLocation) + .build(); + } + + @Override + public void serialize(Type type, @Nullable Icon icon, ConfigurationNode node) throws SerializationException { + if (icon == null) { + node.raw(null); + return; + } + + if (icon instanceof ItemStackIcon) { + this.itemStackIconSerializer.serialize(type, (ItemStackIcon) icon, node); + return; + } + + if (icon instanceof SimpleResourceLocationIcon) { + SimpleResourceLocationIcon simple = (SimpleResourceLocationIcon) icon; + node.node("resource-location").set(simple.getResourceLocation()); + node.node("size").set(simple.getSize()); + return; + } + + if (icon instanceof AdvancedResourceLocationIcon) { + AdvancedResourceLocationIcon advanced = (AdvancedResourceLocationIcon) icon; + node.node("resource-location").set(advanced.getResourceLocation()); + node.node("width").set((double) advanced.getWidth()); + node.node("height").set((double) advanced.getHeight()); + node.node("min-u").set((double) advanced.getMinU()); + node.node("max-u").set((double) advanced.getMaxU()); + node.node("min-v").set((double) advanced.getMinV()); + node.node("max-v").set((double) advanced.getMaxV()); + return; + } + + if (icon instanceof ResourceLocationIcon) { + node.node("resource-location").set(((ResourceLocationIcon) icon).getResourceLocation()); + return; + } + + throw new SerializationException("Unknown icon type: " + icon.getClass().getName()); + } + } + + private static final class ItemStackIconSerializer implements TypeSerializer { + @Override + public ItemStackIcon deserialize(Type type, ConfigurationNode node) throws SerializationException { + if (!node.hasChild("name") && !node.hasChild("id")) { + throw new SerializationException("Item icons require a 'name' or 'id' field!"); + } + + ItemStackIcon.ItemStackIconBuilder builder = ItemStackIcon.builder(); + if (node.hasChild("name")) { + String name = node.node("name").getString(); + if (name == null || name.isEmpty()) { + throw new SerializationException("Item icon 'name' must not be empty!"); + } + + builder.itemName(name); + } else { + builder.itemId(node.node("id").getInt()); + } + + if (node.hasChild("custom-model-data")) { + builder.customModelData(node.node("custom-model-data").getInt()); + } + + if (node.hasChild("model-data")) { + ConfigurationNode data = node.node("model-data"); + builder.customModelDataObject(CustomModelData.builder() + .floats(data.node("floats").getList(Float.class, Collections.emptyList())) + .flags(data.node("flags").getList(Boolean.class, Collections.emptyList())) + .strings(data.node("strings").getList(String.class, Collections.emptyList())) + .colors(data.node("colors").getList(Integer.class, Collections.emptyList())) + .build()); + } + + if (node.hasChild("potion")) { + builder.potion(node.node("potion").getString()); + } + + if (node.hasChild("profile")) { + builder.profile(this.readProfile(node.node("profile"))); + } + + return builder.build(); + } + + @Override + public void serialize(Type type, @Nullable ItemStackIcon icon, ConfigurationNode node) throws SerializationException { + if (icon == null) { + node.raw(null); + return; + } + + if (icon.getItemName() != null) { + node.node("name").set(icon.getItemName()); + } else { + node.node("id").set(icon.getItemId()); + } + + if (icon.getCustomModelData() != 0) { + node.node("custom-model-data").set(icon.getCustomModelData()); + } + + CustomModelData modelData = icon.getCustomModelDataObject(); + if (modelData != null) { + this.writeList(node.node("model-data", "floats"), Float.class, modelData.getFloats()); + this.writeList(node.node("model-data", "flags"), Boolean.class, modelData.getFlags()); + this.writeList(node.node("model-data", "strings"), String.class, modelData.getStrings()); + this.writeList(node.node("model-data", "colors"), Integer.class, modelData.getColors()); + } + + if (icon.getPotion() != null) { + node.node("potion").set(icon.getPotion()); + } + + Profile profile = icon.getProfile(); + if (profile != null) { + if (profile.getId() != null) { + node.node("profile", "id").set(profile.getId().toString()); + } + + node.node("profile", "texture").set(profile.getTexture()); + node.node("profile", "signature").set(profile.getSignature()); + } + } + + private Profile readProfile(ConfigurationNode node) throws SerializationException { + Profile.ProfileBuilder builder = Profile.builder() + .texture(node.node("texture").getString("")) + .signature(node.node("signature").getString("")); + + String id = node.node("id").getString(); + if (id != null) { + try { + builder.id(UUID.fromString(id)); + } catch (IllegalArgumentException exception) { + throw new SerializationException("Invalid profile id '" + id + "'!"); + } + } + + return builder.build(); + } + + private void writeList(ConfigurationNode node, Class type, List values) throws SerializationException { + if (!values.isEmpty()) { + node.setList(type, values); + } + } + } + } diff --git a/docs/developers/events.mdx b/docs/developers/events.mdx index a8899eee..358b356a 100644 --- a/docs/developers/events.mdx +++ b/docs/developers/events.mdx @@ -218,6 +218,36 @@ _Called when the player opens their chat._ +

+ApolloPlayerInventoryCloseEvent + +### ApolloPlayerInventoryCloseEvent + +_Called when the player closes their inventory._ + +| Field | Description | +| -------------------------- | -------------------------------------------------- | +| `ApolloPlayer player` | The Apollo player that sent the packet. | +| `long instantiationTimeMs` | The unix timestamp when the packet was created. | +| `PlayerInfo playerInfo` | The player's general information. | + +
+ +
+ApolloPlayerInventoryOpenEvent + +### ApolloPlayerInventoryOpenEvent + +_Called when the player opens their inventory._ + +| Field | Description | +| -------------------------- | -------------------------------------------------- | +| `ApolloPlayer player` | The Apollo player that sent the packet. | +| `long instantiationTimeMs` | The unix timestamp when the packet was created. | +| `PlayerInfo playerInfo` | The player's general information. | + +
+
ApolloPlayerAttackEvent diff --git a/docs/developers/lightweight/json/serverbound-packets.mdx b/docs/developers/lightweight/json/serverbound-packets.mdx index fc86cf12..0cc4ad8a 100644 --- a/docs/developers/lightweight/json/serverbound-packets.mdx +++ b/docs/developers/lightweight/json/serverbound-packets.mdx @@ -54,6 +54,10 @@ public class ApolloPacketReceiveJsonListener implements PluginMessageListener { this.onPlayerChatOpen(payload); } else if ("lunarclient.apollo.packetenrichment.v1.PlayerChatCloseMessage".equals(type)) { this.onPlayerChatClose(payload); + } else if ("lunarclient.apollo.packetenrichment.v1.PlayerInventoryOpenMessage".equals(type)) { + this.onPlayerInventoryOpen(player, payload); + } else if ("lunarclient.apollo.packetenrichment.v1.PlayerInventoryCloseMessage".equals(type)) { + this.onPlayerInventoryClose(player, payload); } else if ("lunarclient.apollo.packetenrichment.v1.PlayerUseItemMessage".equals(type)) { this.onPlayerUseItem(payload); } else if ("lunarclient.apollo.packetenrichment.v1.PlayerUseItemBucketMessage".equals(type)) { @@ -102,6 +106,26 @@ public class ApolloPacketReceiveJsonListener implements PluginMessageListener { this.onPlayerInfo(message.getAsJsonObject("player_info")); } + private void onPlayerInventoryOpen(Player player, JsonObject message) { + long instantiationTimeMs = JsonUtil.toJavaTimestamp(message); + this.onPlayerInfo(message.getAsJsonObject("player_info")); + + InventoryExample example = ApolloExamplePlugin.getInstance().getInventoryExample(); + if (example instanceof InventoryJsonExample) { + ((InventoryJsonExample) example).handleInventoryOpen(player); + } + } + + private void onPlayerInventoryClose(Player player, JsonObject message) { + long instantiationTimeMs = JsonUtil.toJavaTimestamp(message); + this.onPlayerInfo(message.getAsJsonObject("player_info")); + + InventoryExample example = ApolloExamplePlugin.getInstance().getInventoryExample(); + if (example instanceof InventoryJsonExample) { + ((InventoryJsonExample) example).handleInventoryClose(player); + } + } + private void onPlayerUseItem(JsonObject message) { long instantiationTimeMs = JsonUtil.toJavaTimestamp(message); this.onPlayerInfo(message.getAsJsonObject("player_info")); diff --git a/docs/developers/lightweight/protobuf.mdx b/docs/developers/lightweight/protobuf.mdx index f39b9e45..0bb373d6 100644 --- a/docs/developers/lightweight/protobuf.mdx +++ b/docs/developers/lightweight/protobuf.mdx @@ -26,7 +26,7 @@ Available fields for each message, including their types, are available on the B com.lunarclient apollo-protos - 0.2.0 + 0.2.4 ``` @@ -41,7 +41,7 @@ Available fields for each message, including their types, are available on the B } dependencies { - api 'com.lunarclient:apollo-protos:0.2.0' + api 'com.lunarclient:apollo-protos:0.2.4' } ``` @@ -55,7 +55,7 @@ Available fields for each message, including their types, are available on the B } dependencies { - api("com.lunarclient:apollo-protos:0.2.0") + api("com.lunarclient:apollo-protos:0.2.4") } ``` diff --git a/docs/developers/lightweight/protobuf/serverbound-packets.mdx b/docs/developers/lightweight/protobuf/serverbound-packets.mdx index 6690301b..8a75188a 100644 --- a/docs/developers/lightweight/protobuf/serverbound-packets.mdx +++ b/docs/developers/lightweight/protobuf/serverbound-packets.mdx @@ -31,6 +31,10 @@ public class ApolloPacketReceiveProtoListener implements PluginMessageListener { this.onPlayerChatOpen(any.unpack(PlayerChatOpenMessage.class)); } else if (any.is(PlayerChatCloseMessage.class)) { this.onPlayerChatClose(any.unpack(PlayerChatCloseMessage.class)); + } else if (any.is(PlayerInventoryOpenMessage.class)) { + this.onPlayerInventoryOpen(player, any.unpack(PlayerInventoryOpenMessage.class)); + } else if (any.is(PlayerInventoryCloseMessage.class)) { + this.onPlayerInventoryClose(player, any.unpack(PlayerInventoryCloseMessage.class)); } else if (any.is(PlayerUseItemMessage.class)) { this.onPlayerUseItem(any.unpack(PlayerUseItemMessage.class)); } else if (any.is(PlayerUseItemBucketMessage.class)) { @@ -83,6 +87,30 @@ public class ApolloPacketReceiveProtoListener implements PluginMessageListener { this.onPlayerInfo(playerInfo); } + private void onPlayerInventoryOpen(Player player, PlayerInventoryOpenMessage message) { + long instantiationTimeMs = ProtobufUtil.toJavaTimestamp(message.getPacketInfo().getInstantiationTime()); + + PlayerInfo playerInfo = message.getPlayerInfo(); + this.onPlayerInfo(playerInfo); + + InventoryExample example = ApolloExamplePlugin.getInstance().getInventoryExample(); + if (example instanceof InventoryProtoExample) { + ((InventoryProtoExample) example).handleInventoryOpen(player); + } + } + + private void onPlayerInventoryClose(Player player, PlayerInventoryCloseMessage message) { + long instantiationTimeMs = ProtobufUtil.toJavaTimestamp(message.getPacketInfo().getInstantiationTime()); + + PlayerInfo playerInfo = message.getPlayerInfo(); + this.onPlayerInfo(playerInfo); + + InventoryExample example = ApolloExamplePlugin.getInstance().getInventoryExample(); + if (example instanceof InventoryProtoExample) { + ((InventoryProtoExample) example).handleInventoryClose(player); + } + } + private void onPlayerUseItem(PlayerUseItemMessage message) { long instantiationTimeMs = ProtobufUtil.toJavaTimestamp(message.getPacketInfo().getInstantiationTime()); diff --git a/docs/developers/minestom.mdx b/docs/developers/minestom.mdx index 0cd257ac..996eea83 100644 --- a/docs/developers/minestom.mdx +++ b/docs/developers/minestom.mdx @@ -52,14 +52,14 @@ Next, add the `apollo-minestom` dependency to your project. ```kotlin filename="build.gradle.kts" dependencies { - implementation("com.lunarclient:apollo-minestom:1.2.8") + implementation("com.lunarclient:apollo-minestom:1.2.9") } ``` ```groovy filename="build.gradle" dependencies { - implementation 'com.lunarclient:apollo-minestom:1.2.8' + implementation 'com.lunarclient:apollo-minestom:1.2.9' } ``` @@ -69,7 +69,7 @@ Next, add the `apollo-minestom` dependency to your project. com.lunarclient apollo-minestom - 1.2.8 + 1.2.9 compile diff --git a/docs/developers/mods/_meta.json b/docs/developers/mods/_meta.json index 5729f816..1be56200 100644 --- a/docs/developers/mods/_meta.json +++ b/docs/developers/mods/_meta.json @@ -1,6 +1,7 @@ { "2ditems": "2dItems", "3dskins": "3dSkins", + "actionbar": "ActionBar", "armorstatus": "Armorstatus", "attackindicator": "AttackIndicator", "audiosubtitles": "AudioSubtitles", @@ -40,7 +41,9 @@ "itemtracker": "ItemTracker", "keystrokes": "Keystrokes", "killsounds": "KillSounds", + "knockbacktrainer": "KnockbackTrainer", "lighting": "Lighting", + "lightoverlay": "LightOverlay", "markers": "Markers", "memory": "Memory", "menublur": "MenuBlur", @@ -58,6 +61,7 @@ "particlechanger": "ParticleChanger", "ping": "Ping", "playtime": "Playtime", + "potioncounter": "PotionCounter", "potioneffects": "PotionEffects", "pvpinfo": "PvpInfo", "quickplay": "Quickplay", diff --git a/docs/developers/mods/actionbar.mdx b/docs/developers/mods/actionbar.mdx new file mode 100644 index 00000000..2717694f --- /dev/null +++ b/docs/developers/mods/actionbar.mdx @@ -0,0 +1,31 @@ +# Action Bar + +Allows you to move and scale Minecraft's action bar. + +## Integration + +### How to toggle the mod + +```java +public void toggleActionBarExample(Player viewer, boolean value) { + Optional apolloPlayerOpt = Apollo.getPlayerManager().getPlayer(viewer.getUniqueId()); + apolloPlayerOpt.ifPresent(apolloPlayer -> this.modSettingModule.getOptions().set(apolloPlayer, ModActionBar.ENABLED, value)); +} +``` + +## Available options + +- __`ENABLED`__ + - Config Key: `enabled` + - Values + - Type: `Boolean` + - Default: `false` + +- __`SCALE`__ + - Config Key: `scale` + - Values + - Type: `Float` + - Default: `1.0F` + - Minimum: `0.25F` + - Maximum: `5.0F` + diff --git a/docs/developers/mods/chat.mdx b/docs/developers/mods/chat.mdx index d3382e81..bf9fdc98 100644 --- a/docs/developers/mods/chat.mdx +++ b/docs/developers/mods/chat.mdx @@ -115,6 +115,41 @@ For example, if your name is Notch, this will ping on Notch but not Notch123. - Type: `Boolean` - Default: `false` +- __`CHAT_HEADS`__ + - Displays the player's Minecraft head before their message in chat. + - Config Key: `chat-heads` + - Values + - Type: `Boolean` + - Default: `false` + +- __`CHAT_HEADS_FETCH_UNKNOWN`__ + - Looks up skins for chat senders that aren't in the tab list, like players on other servers of a network. Head detection may be less accurate. + - Config Key: `chat-heads-fetch-unknown` + - Values + - Type: `Boolean` + - Default: `false` + +- __`CHAT_EMOJI`__ + - Adds emojis to chat. Shortcodes like :smile: autocomplete as you type, and emojis in messages show as colorful Twemoji. + - Config Key: `chat-emoji` + - Values + - Type: `Boolean` + - Default: `true` + +- __`CHAT_EMOJI_UNICODE_ONLY`__ + - Shows emojis with Minecraft's built-in font instead of Twemoji images. Shortcodes the game font can't display are left as text. + - Config Key: `chat-emoji-unicode-only` + - Values + - Type: `Boolean` + - Default: `false` + +- __`CHAT_EMOJI_CONVERT_SHORTCODES`__ + - Turns shortcodes like :skull: in other players' messages into emojis. When disabled, only emojis sent as actual characters are shown. + - Config Key: `chat-emoji-convert-shortcodes` + - Values + - Type: `Boolean` + - Default: `true` + - __`COPY_CHAT`__ - Copies the hovered chat message when holding the keybind and clicking. - Config Key: `copy-chat` diff --git a/docs/developers/mods/hitbox.mdx b/docs/developers/mods/hitbox.mdx index 6f91d4fc..6fc2c955 100644 --- a/docs/developers/mods/hitbox.mdx +++ b/docs/developers/mods/hitbox.mdx @@ -56,6 +56,37 @@ public void toggleHitboxExample(Player viewer, boolean value) { - Type: `String` - Default: `#FFFFFFFF` +- __`HITBOX_PLAYER_SHOW_HITTABLE_COLOR`__ + - Config Key: `hitbox-player-show-hittable-color` + - Values + - Type: `Boolean` + - Default: `false` + +- __`HITBOX_PLAYER_HITTABLE_COLOR`__ + - Config Key: `hitbox-player-hittable-color` + - Values + - Type: `String` + - Default: `#FF00FF00` + +- __`HITBOX_PLAYER_ONLY_SHOW_HITTABLE`__ + - Only show the hitbox when the entity is within reach and under your crosshair + - Config Key: `hitbox-player-only-show-hittable` + - Values + - Type: `Boolean` + - Default: `false` + +- __`HITBOX_PLAYER_SHOW_DAMAGED_COLOR`__ + - Config Key: `hitbox-player-show-damaged-color` + - Values + - Type: `Boolean` + - Default: `false` + +- __`HITBOX_PLAYER_DAMAGED_COLOR`__ + - Config Key: `hitbox-player-damaged-color` + - Values + - Type: `String` + - Default: `#FFFF0000` + - __`HITBOX_PLAYER_LOOK_VECTOR`__ - Config Key: `hitbox-player-look-vector` - Values @@ -82,6 +113,36 @@ public void toggleHitboxExample(Player viewer, boolean value) { - Type: `String` - Default: `#FFFFFFFF` +- __`HITBOX_ITEM_SHOW_HITTABLE_COLOR`__ + - Config Key: `hitbox-item-show-hittable-color` + - Values + - Type: `Boolean` + - Default: `false` + +- __`HITBOX_ITEM_HITTABLE_COLOR`__ + - Config Key: `hitbox-item-hittable-color` + - Values + - Type: `String` + - Default: `#FF00FF00` + +- __`HITBOX_ITEM_ONLY_SHOW_HITTABLE`__ + - Config Key: `hitbox-item-only-show-hittable` + - Values + - Type: `Boolean` + - Default: `false` + +- __`HITBOX_ITEM_SHOW_DAMAGED_COLOR`__ + - Config Key: `hitbox-item-show-damaged-color` + - Values + - Type: `Boolean` + - Default: `false` + +- __`HITBOX_ITEM_DAMAGED_COLOR`__ + - Config Key: `hitbox-item-damaged-color` + - Values + - Type: `String` + - Default: `#FFFF0000` + - __`HITBOX_ITEM_LOOK_VECTOR`__ - Config Key: `hitbox-item-look-vector` - Values @@ -108,6 +169,36 @@ public void toggleHitboxExample(Player viewer, boolean value) { - Type: `String` - Default: `#FFFFFFFF` +- __`HITBOX_EXP_ORB_SHOW_HITTABLE_COLOR`__ + - Config Key: `hitbox-exp-orb-show-hittable-color` + - Values + - Type: `Boolean` + - Default: `false` + +- __`HITBOX_EXP_ORB_HITTABLE_COLOR`__ + - Config Key: `hitbox-exp-orb-hittable-color` + - Values + - Type: `String` + - Default: `#FF00FF00` + +- __`HITBOX_EXP_ORB_ONLY_SHOW_HITTABLE`__ + - Config Key: `hitbox-exp-orb-only-show-hittable` + - Values + - Type: `Boolean` + - Default: `false` + +- __`HITBOX_EXP_ORB_SHOW_DAMAGED_COLOR`__ + - Config Key: `hitbox-exp-orb-show-damaged-color` + - Values + - Type: `Boolean` + - Default: `false` + +- __`HITBOX_EXP_ORB_DAMAGED_COLOR`__ + - Config Key: `hitbox-exp-orb-damaged-color` + - Values + - Type: `String` + - Default: `#FFFF0000` + - __`HITBOX_EXP_ORB_LOOK_VECTOR`__ - Config Key: `hitbox-exp-orb-look-vector` - Values @@ -134,6 +225,36 @@ public void toggleHitboxExample(Player viewer, boolean value) { - Type: `String` - Default: `#FFFFFFFF` +- __`HITBOX_ITEM_FRAME_SHOW_HITTABLE_COLOR`__ + - Config Key: `hitbox-item-frame-show-hittable-color` + - Values + - Type: `Boolean` + - Default: `false` + +- __`HITBOX_ITEM_FRAME_HITTABLE_COLOR`__ + - Config Key: `hitbox-item-frame-hittable-color` + - Values + - Type: `String` + - Default: `#FF00FF00` + +- __`HITBOX_ITEM_FRAME_ONLY_SHOW_HITTABLE`__ + - Config Key: `hitbox-item-frame-only-show-hittable` + - Values + - Type: `Boolean` + - Default: `false` + +- __`HITBOX_ITEM_FRAME_SHOW_DAMAGED_COLOR`__ + - Config Key: `hitbox-item-frame-show-damaged-color` + - Values + - Type: `Boolean` + - Default: `false` + +- __`HITBOX_ITEM_FRAME_DAMAGED_COLOR`__ + - Config Key: `hitbox-item-frame-damaged-color` + - Values + - Type: `String` + - Default: `#FFFF0000` + - __`HITBOX_ITEM_FRAME_LOOK_VECTOR`__ - Config Key: `hitbox-item-frame-look-vector` - Values @@ -160,6 +281,36 @@ public void toggleHitboxExample(Player viewer, boolean value) { - Type: `String` - Default: `#FFFFFFFF` +- __`HITBOX_FIREWORK_SHOW_HITTABLE_COLOR`__ + - Config Key: `hitbox-firework-show-hittable-color` + - Values + - Type: `Boolean` + - Default: `false` + +- __`HITBOX_FIREWORK_HITTABLE_COLOR`__ + - Config Key: `hitbox-firework-hittable-color` + - Values + - Type: `String` + - Default: `#FF00FF00` + +- __`HITBOX_FIREWORK_ONLY_SHOW_HITTABLE`__ + - Config Key: `hitbox-firework-only-show-hittable` + - Values + - Type: `Boolean` + - Default: `false` + +- __`HITBOX_FIREWORK_SHOW_DAMAGED_COLOR`__ + - Config Key: `hitbox-firework-show-damaged-color` + - Values + - Type: `Boolean` + - Default: `false` + +- __`HITBOX_FIREWORK_DAMAGED_COLOR`__ + - Config Key: `hitbox-firework-damaged-color` + - Values + - Type: `String` + - Default: `#FFFF0000` + - __`HITBOX_FIREWORK_LOOK_VECTOR`__ - Config Key: `hitbox-firework-look-vector` - Values @@ -186,6 +337,36 @@ public void toggleHitboxExample(Player viewer, boolean value) { - Type: `String` - Default: `#FFFFFFFF` +- __`HITBOX_WITHER_SKULL_SHOW_HITTABLE_COLOR`__ + - Config Key: `hitbox-wither-skull-show-hittable-color` + - Values + - Type: `Boolean` + - Default: `false` + +- __`HITBOX_WITHER_SKULL_HITTABLE_COLOR`__ + - Config Key: `hitbox-wither-skull-hittable-color` + - Values + - Type: `String` + - Default: `#FF00FF00` + +- __`HITBOX_WITHER_SKULL_ONLY_SHOW_HITTABLE`__ + - Config Key: `hitbox-wither-skull-only-show-hittable` + - Values + - Type: `Boolean` + - Default: `false` + +- __`HITBOX_WITHER_SKULL_SHOW_DAMAGED_COLOR`__ + - Config Key: `hitbox-wither-skull-show-damaged-color` + - Values + - Type: `Boolean` + - Default: `false` + +- __`HITBOX_WITHER_SKULL_DAMAGED_COLOR`__ + - Config Key: `hitbox-wither-skull-damaged-color` + - Values + - Type: `String` + - Default: `#FFFF0000` + - __`HITBOX_WITHER_SKULL_LOOK_VECTOR`__ - Config Key: `hitbox-wither-skull-look-vector` - Values @@ -212,6 +393,36 @@ public void toggleHitboxExample(Player viewer, boolean value) { - Type: `String` - Default: `#FFFFFFFF` +- __`HITBOX_SNOWBALL_SHOW_HITTABLE_COLOR`__ + - Config Key: `hitbox-snowball-show-hittable-color` + - Values + - Type: `Boolean` + - Default: `false` + +- __`HITBOX_SNOWBALL_HITTABLE_COLOR`__ + - Config Key: `hitbox-snowball-hittable-color` + - Values + - Type: `String` + - Default: `#FF00FF00` + +- __`HITBOX_SNOWBALL_ONLY_SHOW_HITTABLE`__ + - Config Key: `hitbox-snowball-only-show-hittable` + - Values + - Type: `Boolean` + - Default: `false` + +- __`HITBOX_SNOWBALL_SHOW_DAMAGED_COLOR`__ + - Config Key: `hitbox-snowball-show-damaged-color` + - Values + - Type: `Boolean` + - Default: `false` + +- __`HITBOX_SNOWBALL_DAMAGED_COLOR`__ + - Config Key: `hitbox-snowball-damaged-color` + - Values + - Type: `String` + - Default: `#FFFF0000` + - __`HITBOX_SNOWBALL_LOOK_VECTOR`__ - Config Key: `hitbox-snowball-look-vector` - Values @@ -238,6 +449,36 @@ public void toggleHitboxExample(Player viewer, boolean value) { - Type: `String` - Default: `#FFFFFFFF` +- __`HITBOX_FIREBALL_SHOW_HITTABLE_COLOR`__ + - Config Key: `hitbox-fireball-show-hittable-color` + - Values + - Type: `Boolean` + - Default: `false` + +- __`HITBOX_FIREBALL_HITTABLE_COLOR`__ + - Config Key: `hitbox-fireball-hittable-color` + - Values + - Type: `String` + - Default: `#FF00FF00` + +- __`HITBOX_FIREBALL_ONLY_SHOW_HITTABLE`__ + - Config Key: `hitbox-fireball-only-show-hittable` + - Values + - Type: `Boolean` + - Default: `false` + +- __`HITBOX_FIREBALL_SHOW_DAMAGED_COLOR`__ + - Config Key: `hitbox-fireball-show-damaged-color` + - Values + - Type: `Boolean` + - Default: `false` + +- __`HITBOX_FIREBALL_DAMAGED_COLOR`__ + - Config Key: `hitbox-fireball-damaged-color` + - Values + - Type: `String` + - Default: `#FFFF0000` + - __`HITBOX_FIREBALL_LOOK_VECTOR`__ - Config Key: `hitbox-fireball-look-vector` - Values @@ -264,6 +505,36 @@ public void toggleHitboxExample(Player viewer, boolean value) { - Type: `String` - Default: `#FFFFFFFF` +- __`HITBOX_ARROW_SHOW_HITTABLE_COLOR`__ + - Config Key: `hitbox-arrow-show-hittable-color` + - Values + - Type: `Boolean` + - Default: `false` + +- __`HITBOX_ARROW_HITTABLE_COLOR`__ + - Config Key: `hitbox-arrow-hittable-color` + - Values + - Type: `String` + - Default: `#FF00FF00` + +- __`HITBOX_ARROW_ONLY_SHOW_HITTABLE`__ + - Config Key: `hitbox-arrow-only-show-hittable` + - Values + - Type: `Boolean` + - Default: `false` + +- __`HITBOX_ARROW_SHOW_DAMAGED_COLOR`__ + - Config Key: `hitbox-arrow-show-damaged-color` + - Values + - Type: `Boolean` + - Default: `false` + +- __`HITBOX_ARROW_DAMAGED_COLOR`__ + - Config Key: `hitbox-arrow-damaged-color` + - Values + - Type: `String` + - Default: `#FFFF0000` + - __`HITBOX_ARROW_LOOK_VECTOR`__ - Config Key: `hitbox-arrow-look-vector` - Values @@ -290,6 +561,36 @@ public void toggleHitboxExample(Player viewer, boolean value) { - Type: `String` - Default: `#FFFFFFFF` +- __`HITBOX_PROJECTILE_SHOW_HITTABLE_COLOR`__ + - Config Key: `hitbox-projectile-show-hittable-color` + - Values + - Type: `Boolean` + - Default: `false` + +- __`HITBOX_PROJECTILE_HITTABLE_COLOR`__ + - Config Key: `hitbox-projectile-hittable-color` + - Values + - Type: `String` + - Default: `#FF00FF00` + +- __`HITBOX_PROJECTILE_ONLY_SHOW_HITTABLE`__ + - Config Key: `hitbox-projectile-only-show-hittable` + - Values + - Type: `Boolean` + - Default: `false` + +- __`HITBOX_PROJECTILE_SHOW_DAMAGED_COLOR`__ + - Config Key: `hitbox-projectile-show-damaged-color` + - Values + - Type: `Boolean` + - Default: `false` + +- __`HITBOX_PROJECTILE_DAMAGED_COLOR`__ + - Config Key: `hitbox-projectile-damaged-color` + - Values + - Type: `String` + - Default: `#FFFF0000` + - __`HITBOX_PROJECTILE_LOOK_VECTOR`__ - Config Key: `hitbox-projectile-look-vector` - Values @@ -316,6 +617,37 @@ public void toggleHitboxExample(Player viewer, boolean value) { - Type: `String` - Default: `#FFFFFFFF` +- __`HITBOX_MONSTER_SHOW_HITTABLE_COLOR`__ + - Config Key: `hitbox-monster-show-hittable-color` + - Values + - Type: `Boolean` + - Default: `false` + +- __`HITBOX_MONSTER_HITTABLE_COLOR`__ + - Config Key: `hitbox-monster-hittable-color` + - Values + - Type: `String` + - Default: `#FF00FF00` + +- __`HITBOX_MONSTER_ONLY_SHOW_HITTABLE`__ + - Only show the hitbox when the entity is within reach and under your crosshair + - Config Key: `hitbox-monster-only-show-hittable` + - Values + - Type: `Boolean` + - Default: `false` + +- __`HITBOX_MONSTER_SHOW_DAMAGED_COLOR`__ + - Config Key: `hitbox-monster-show-damaged-color` + - Values + - Type: `Boolean` + - Default: `false` + +- __`HITBOX_MONSTER_DAMAGED_COLOR`__ + - Config Key: `hitbox-monster-damaged-color` + - Values + - Type: `String` + - Default: `#FFFF0000` + - __`HITBOX_MONSTER_LOOK_VECTOR`__ - Config Key: `hitbox-monster-look-vector` - Values @@ -342,6 +674,37 @@ public void toggleHitboxExample(Player viewer, boolean value) { - Type: `String` - Default: `#FFFFFFFF` +- __`HITBOX_PASSIVE_SHOW_HITTABLE_COLOR`__ + - Config Key: `hitbox-passive-show-hittable-color` + - Values + - Type: `Boolean` + - Default: `false` + +- __`HITBOX_PASSIVE_HITTABLE_COLOR`__ + - Config Key: `hitbox-passive-hittable-color` + - Values + - Type: `String` + - Default: `#FF00FF00` + +- __`HITBOX_PASSIVE_ONLY_SHOW_HITTABLE`__ + - Only show the hitbox when the entity is within reach and under your crosshair + - Config Key: `hitbox-passive-only-show-hittable` + - Values + - Type: `Boolean` + - Default: `false` + +- __`HITBOX_PASSIVE_SHOW_DAMAGED_COLOR`__ + - Config Key: `hitbox-passive-show-damaged-color` + - Values + - Type: `Boolean` + - Default: `false` + +- __`HITBOX_PASSIVE_DAMAGED_COLOR`__ + - Config Key: `hitbox-passive-damaged-color` + - Values + - Type: `String` + - Default: `#FFFF0000` + - __`HITBOX_PASSIVE_LOOK_VECTOR`__ - Config Key: `hitbox-passive-look-vector` - Values @@ -368,6 +731,36 @@ public void toggleHitboxExample(Player viewer, boolean value) { - Type: `String` - Default: `#FFFFFFFF` +- __`HITBOX_OTHER_SHOW_HITTABLE_COLOR`__ + - Config Key: `hitbox-other-show-hittable-color` + - Values + - Type: `Boolean` + - Default: `false` + +- __`HITBOX_OTHER_HITTABLE_COLOR`__ + - Config Key: `hitbox-other-hittable-color` + - Values + - Type: `String` + - Default: `#FF00FF00` + +- __`HITBOX_OTHER_ONLY_SHOW_HITTABLE`__ + - Config Key: `hitbox-other-only-show-hittable` + - Values + - Type: `Boolean` + - Default: `false` + +- __`HITBOX_OTHER_SHOW_DAMAGED_COLOR`__ + - Config Key: `hitbox-other-show-damaged-color` + - Values + - Type: `Boolean` + - Default: `false` + +- __`HITBOX_OTHER_DAMAGED_COLOR`__ + - Config Key: `hitbox-other-damaged-color` + - Values + - Type: `String` + - Default: `#FFFF0000` + - __`HITBOX_OTHER_LOOK_VECTOR`__ - Config Key: `hitbox-other-look-vector` - Values diff --git a/docs/developers/mods/knockbacktrainer.mdx b/docs/developers/mods/knockbacktrainer.mdx new file mode 100644 index 00000000..8dfc098c --- /dev/null +++ b/docs/developers/mods/knockbacktrainer.mdx @@ -0,0 +1,53 @@ +# Knockback Trainer + +Train jump resets: how close your jump press lands to the tick you were hit. + +## Integration + +### How to toggle the mod + +```java +public void toggleKnockbackTrainerExample(Player viewer, boolean value) { + Optional apolloPlayerOpt = Apollo.getPlayerManager().getPlayer(viewer.getUniqueId()); + apolloPlayerOpt.ifPresent(apolloPlayer -> this.modSettingModule.getOptions().set(apolloPlayer, ModKnockbackTrainer.ENABLED, value)); +} +``` + +## Available options + +- __`ENABLED`__ + - Config Key: `enabled` + - Values + - Type: `Boolean` + - Default: `false` + +- __`TARGET_TICKS`__ + - Config Key: `target-ticks` + - Values + - Type: `Integer` + - Default: `0` + - Minimum: `0` + - Maximum: `6` + +- __`WINDOW_TICKS`__ + - Config Key: `window-ticks` + - Values + - Type: `Integer` + - Default: `5` + - Minimum: `0` + - Maximum: `10` + +- __`FALLING_HIT_SOUND`__ + - Config Key: `falling-hit-sound` + - Values + - Type: `Boolean` + - Default: `true` + +- __`FALLING_HIT_SOUND_VOLUME`__ + - Config Key: `falling-hit-sound-volume` + - Values + - Type: `Float` + - Default: `1.0F` + - Minimum: `0.0F` + - Maximum: `1.0F` + diff --git a/docs/developers/mods/lightoverlay.mdx b/docs/developers/mods/lightoverlay.mdx new file mode 100644 index 00000000..9350a15b --- /dev/null +++ b/docs/developers/mods/lightoverlay.mdx @@ -0,0 +1,121 @@ +# Light Overlay + +Shows the light levels of blocks where mobs can spawn + +## Integration + +### How to toggle the mod + +```java +public void toggleLightOverlayExample(Player viewer, boolean value) { + Optional apolloPlayerOpt = Apollo.getPlayerManager().getPlayer(viewer.getUniqueId()); + apolloPlayerOpt.ifPresent(apolloPlayer -> this.modSettingModule.getOptions().set(apolloPlayer, ModLightOverlay.ENABLED, value)); +} +``` + +## Available options + +- __`ENABLED`__ + - Config Key: `enabled` + - Values + - Type: `Boolean` + - Default: `false` + +- __`RENDER_RANGE_LIMIT`__ + - The rendering limit (in chunks) for light overlay values. §eHigher values might lower your FPS. + - Config Key: `render-range-limit` + - Values + - Type: `Integer` + - Default: `2` + - Minimum: `1` + - Maximum: `12` + +- __`FAST_UPDATES`__ + - With this option on, the overlay updates aren't deferred, and happen as fast as possible. +This looks nicer (less "pop in"), but §eturning this option on comes at a potential performance cost. + - Config Key: `fast-updates` + - Values + - Type: `Boolean` + - Default: `false` + +- __`CULLING`__ + - Reduce the amount of overlays that are rendered, increasing performance, especially at higher rendering ranges. +This comes at the expense of overlays at the edges of the screen sometimes popping in and out as you look around. +It's highly recommended that this option is kept on, especially if using higher rendering ranges. + - Config Key: `culling` + - Values + - Type: `Boolean` + - Default: `true` + +- __`INCLUDE_SKY_LIGHT`__ + - With this option on, the real, effective light value is displayed. With this option off, only the block light is used, completely ignoring the sky/day light. + - Config Key: `include-sky-light` + - Values + - Type: `Boolean` + - Default: `true` + +- __`HIDE_UNSPAWNABLE_LIGHT`__ + - Only show on blocks which have light levels that hostile mobs can spawn on + - Config Key: `hide-unspawnable-light` + - Values + - Type: `Boolean` + - Default: `false` + +- __`CUSTOM_LIGHT_THRESHOLD`__ + - Set a custom threshold for Light Check. This overrides the vanilla hostile mob spawning value, and shows the light overlay on all blocks on which the light level falls below this threshold + - Config Key: `custom-light-threshold` + - Values + - Type: `Boolean` + - Default: `false` + +- __`THRESHOLD`__ + - Config Key: `threshold` + - Values + - Type: `Integer` + - Default: `15` + - Minimum: `0` + - Maximum: `15` + +- __`SHOW_LIGHT_VALUE`__ + - Show a number for the light value of each block. +Turning this option on might lower your FPS. + - Config Key: `show-light-value` + - Values + - Type: `Boolean` + - Default: `false` + +- __`CROSS_THICKNESS`__ + - Config Key: `cross-thickness` + - Values + - Type: `Float` + - Default: `2.0F` + - Minimum: `0.5F` + - Maximum: `10.0F` + +- __`TEXT_COLOR`__ + - Config Key: `text-color` + - Values + - Type: `String` + - Default: `#FFFFFFFF` + +- __`BRIGHT_COLOR`__ + - Color where hostile mobs can't spawn + - Config Key: `bright-color` + - Values + - Type: `String` + - Default: `#FF00FF00` + +- __`DARK_COLOR`__ + - Color where hostile mobs can spawn + - Config Key: `dark-color` + - Values + - Type: `String` + - Default: `#FFFF0000` + +- __`LIGHT_OVERLAY_DYNAMIC_COLOR`__ + - When this is off, the color is picked based on the light level allowing hostile mobs to spawn. When this is on, the color is interpolated smoothly. + - Config Key: `light-overlay-dynamic-color` + - Values + - Type: `Boolean` + - Default: `false` + diff --git a/docs/developers/mods/nametag.mdx b/docs/developers/mods/nametag.mdx index ec4830db..5f17cb2d 100644 --- a/docs/developers/mods/nametag.mdx +++ b/docs/developers/mods/nametag.mdx @@ -55,6 +55,13 @@ public void toggleNametagsExample(Player viewer, boolean value) { - Minimum: `0.0F` - Maximum: `1.0F` +- __`HIDE_NAMETAG_F5PASSENGERS`__ + - With this option enabled, your nametag will be hidden in third person when there is a passenger attached to you. + - Config Key: `hide-nametag-f5-passengers` + - Values + - Type: `Boolean` + - Default: `false` + - __`REPLACE_OWN_NAMETAG_COLOR`__ - Config Key: `replace-own-nametag-color` - Values diff --git a/docs/developers/mods/overlaymod.mdx b/docs/developers/mods/overlaymod.mdx index 0b692ed4..7eb6fe84 100644 --- a/docs/developers/mods/overlaymod.mdx +++ b/docs/developers/mods/overlaymod.mdx @@ -36,6 +36,14 @@ public void toggleOverlayExample(Player viewer, boolean value) { - Minimum: `0.0F` - Maximum: `2.0F` +- __`FIRE_BLOCK_HEIGHT`__ + - Config Key: `fire-block-height` + - Values + - Type: `Float` + - Default: `1.0F` + - Minimum: `0.0F` + - Maximum: `2.0F` + - __`SHIELD_HEIGHT`__ - Config Key: `shield-height` - Values diff --git a/docs/developers/mods/ping.mdx b/docs/developers/mods/ping.mdx index 7f3b9672..63f734c2 100644 --- a/docs/developers/mods/ping.mdx +++ b/docs/developers/mods/ping.mdx @@ -22,11 +22,11 @@ public void togglePingExample(Player viewer, boolean value) { - Default: `false` - __`UPDATE_INTERVAL_SEC`__ - - Faster updates may impact performance + - How often ping is measured. If you have trouble connecting to a server, try increasing this. - Config Key: `update-interval-sec` - Values - Type: `Integer` - - Default: `20` + - Default: `5` - Minimum: `1` - Maximum: `120` diff --git a/docs/developers/mods/potioncounter.mdx b/docs/developers/mods/potioncounter.mdx new file mode 100644 index 00000000..0488005d --- /dev/null +++ b/docs/developers/mods/potioncounter.mdx @@ -0,0 +1,118 @@ +# Potion Counter + +Displays how many healing potions or soups are currently in your inventory on the HUD. + +## Integration + +### How to toggle the mod + +```java +public void togglePotionCounterExample(Player viewer, boolean value) { + Optional apolloPlayerOpt = Apollo.getPlayerManager().getPlayer(viewer.getUniqueId()); + apolloPlayerOpt.ifPresent(apolloPlayer -> this.modSettingModule.getOptions().set(apolloPlayer, ModPotionCounter.ENABLED, value)); +} +``` + +## Available options + +- __`ENABLED`__ + - Config Key: `enabled` + - Values + - Type: `Boolean` + - Default: `false` + +- __`SCALE`__ + - Config Key: `scale` + - Values + - Type: `Float` + - Default: `1.0F` + - Minimum: `0.25F` + - Maximum: `5.0F` + +- __`TEXT_SHADOW`__ + - Adds a shadow to text + - Config Key: `text-shadow` + - Values + - Type: `Boolean` + - Default: `true` + +- __`BRACKETS`__ + - Config Key: `brackets` + - Values + - Type: `Boolean` + - Default: `true` + +- __`BRACKET_COLOR`__ + - Config Key: `bracket-color` + - Values + - Type: `String` + - Default: `#FFFFFFFF` + +- __`BACKGROUND`__ + - Config Key: `background` + - Values + - Type: `Boolean` + - Default: `true` + +- __`STATIC_BACKGROUND_WIDTH`__ + - If this is disabled the background will change size with the text. + - Config Key: `static-background-width` + - Values + - Type: `Boolean` + - Default: `true` + +- __`STATIC_BACKGROUND_HEIGHT`__ + - If this is disabled the background will change size with the text. + - Config Key: `static-background-height` + - Values + - Type: `Boolean` + - Default: `true` + +- __`BACKGROUND_WIDTH`__ + - Config Key: `background-width` + - Values + - Type: `Integer` + - Default: `56` + - Minimum: `40` + - Maximum: `62` + +- __`BACKGROUND_HEIGHT`__ + - Config Key: `background-height` + - Values + - Type: `Integer` + - Default: `18` + - Minimum: `10` + - Maximum: `22` + +- __`BORDER`__ + - Config Key: `border` + - Values + - Type: `Boolean` + - Default: `false` + +- __`BORDER_THICKNESS`__ + - Config Key: `border-thickness` + - Values + - Type: `Float` + - Default: `0.5F` + - Minimum: `0.5F` + - Maximum: `3.0F` + +- __`BORDER_COLOR`__ + - Config Key: `border-color` + - Values + - Type: `String` + - Default: `#9F000000` + +- __`BACKGROUND_COLOR`__ + - Config Key: `background-color` + - Values + - Type: `String` + - Default: `#6F000000` + +- __`TEXT_COLOR`__ + - Config Key: `text-color` + - Values + - Type: `String` + - Default: `#FFFFFFFF` + diff --git a/docs/developers/mods/potioneffects.mdx b/docs/developers/mods/potioneffects.mdx index be3dca9c..568c098e 100644 --- a/docs/developers/mods/potioneffects.mdx +++ b/docs/developers/mods/potioneffects.mdx @@ -21,76 +21,103 @@ public void togglePotionEffectsExample(Player viewer, boolean value) { - Type: `Boolean` - Default: `true` -- __`SCALE`__ - - Config Key: `scale` +- __`HIDE_AMBIENT_DURATION`__ + - Config Key: `hide-ambient-duration` - Values - - Type: `Float` - - Default: `1.0F` - - Minimum: `0.25F` - - Maximum: `5.0F` + - Type: `Boolean` + - Default: `false` -- __`SHOW_IN_INVENTORY`__ - - Config Key: `show-in-inventory` +- __`VANILLA_GROUP_EFFECTS`__ + - Put the good effects and the bad effects on separate lines + - Config Key: `vanilla-group-effects` - Values - Type: `Boolean` - Default: `true` -- __`SHOW_WHILE_TYPING`__ - - Config Key: `show-while-typing` +- __`VANILLA_MODE_HORIZONTAL`__ + - Config Key: `vanilla-mode-horizontal` - Values - Type: `Boolean` - Default: `true` +- __`VANILLA_MODE_TILES_PER_LINE`__ + - Config Key: `vanilla-mode-tiles-per-line` + - Values + - Type: `Integer` + - Default: `10` + - Minimum: `1` + - Maximum: `10` + +- __`MINIMAL_MODE_HORIZONTAL`__ + - Config Key: `minimal-mode-horizontal` + - Values + - Type: `Boolean` + - Default: `false` + +- __`MINIMAL_MODE_TILES_PER_LINE`__ + - Config Key: `minimal-mode-tiles-per-line` + - Values + - Type: `Integer` + - Default: `4` + - Minimum: `1` + - Maximum: `10` + - __`EFFECT_NAME`__ - Config Key: `effect-name` - Values - Type: `Boolean` - Default: `true` -- __`TEXT_SHADOW`__ - - Adds a shadow to text - - Config Key: `text-shadow` +- __`EFFECT_DURATION`__ + - Config Key: `effect-duration` - Values - Type: `Boolean` - Default: `true` -- __`BACKGROUND`__ - - Config Key: `background` +- __`EFFECT_AMPLIFIER`__ + - Config Key: `effect-amplifier` - Values - Type: `Boolean` - Default: `true` -- __`MINIMAL_MODE`__ - - Config Key: `minimal-mode` +- __`SHOW_IN_INVENTORY`__ + - Config Key: `show-in-inventory` - Values - Type: `Boolean` - - Default: `false` + - Default: `true` -- __`MINIMAL_MODE_HORIZONTAL`__ - - Config Key: `minimal-mode-horizontal` +- __`SHOW_WHILE_TYPING`__ + - Config Key: `show-while-typing` - Values - Type: `Boolean` - - Default: `false` + - Default: `true` -- __`BORDER`__ - - Config Key: `border` +- __`POTION_BLINK`__ + - Config Key: `potion-blink` + - Values + - Type: `Boolean` + - Default: `true` + +- __`POTION_BLINK_ICON`__ + - With this enabled, the potion effect icon blinks as well + - Config Key: `potion-blink-icon` - Values - Type: `Boolean` - Default: `false` -- __`BORDER_THICKNESS`__ - - Config Key: `border-thickness` +- __`BLINK_DURATION`__ + - Config Key: `blink-duration` - Values - - Type: `Float` - - Default: `0.5F` - - Minimum: `0.5F` - - Maximum: `3.0F` + - Type: `Integer` + - Default: `10` + - Minimum: `2` + - Maximum: `20` -- __`FORMATTED_DURATIONS`__ - - Config Key: `formatted-durations` +- __`VANILLA_BLINK_COLOR`__ + - Config Key: `vanilla-blink-color` - Values - - Type: `Boolean` - - Default: `false` + - Type: `String` + - Default: `#FFFFFFFF` - __`UPPERCASE_POTION_NAMES`__ - Config Key: `uppercase-potion-names` @@ -104,25 +131,30 @@ public void togglePotionEffectsExample(Player viewer, boolean value) { - Type: `Boolean` - Default: `false` +- __`FORMATTED_DURATIONS`__ + - Config Key: `formatted-durations` + - Values + - Type: `Boolean` + - Default: `false` + - __`HIDE_MODERN_ICONS`__ - Config Key: `hide-modern-icons` - Values - Type: `Boolean` - Default: `true` -- __`POTION_BLINK`__ - - Config Key: `potion-blink` +- __`HIDE_POTION_STATUS`__ + - Completely hide the potion effects mod HUD + - Config Key: `hide-potion-status` - Values - Type: `Boolean` - - Default: `true` + - Default: `false` -- __`BLINK_DURATION`__ - - Config Key: `blink-duration` +- __`BACKGROUND`__ + - Config Key: `background` - Values - - Type: `Integer` - - Default: `10` - - Minimum: `2` - - Maximum: `20` + - Type: `Boolean` + - Default: `true` - __`BACKGROUND_COLOR`__ - Config Key: `background-color` @@ -130,30 +162,87 @@ public void togglePotionEffectsExample(Player viewer, boolean value) { - Type: `String` - Default: `#6F000000` +- __`BORDER`__ + - Config Key: `border` + - Values + - Type: `Boolean` + - Default: `false` + +- __`BORDER_THICKNESS`__ + - Config Key: `border-thickness` + - Values + - Type: `Float` + - Default: `0.5F` + - Minimum: `0.5F` + - Maximum: `3.0F` + - __`BORDER_COLOR`__ - Config Key: `border-color` - Values - Type: `String` - Default: `#9F000000` +- __`TEXT_SHADOW`__ + - Adds a shadow to text + - Config Key: `text-shadow` + - Values + - Type: `Boolean` + - Default: `true` + - __`COLOR_NAME_BASED_ON_EFFECT`__ - Config Key: `color-name-based-on-effect` - Values - Type: `Boolean` - Default: `false` +- __`COLOR_INFO_BASED_ON_EFFECT`__ + - Config Key: `color-info-based-on-effect` + - Values + - Type: `Boolean` + - Default: `false` + +- __`SHOW_EFFECT_BACKGROUND`__ + - Config Key: `show-effect-background` + - Values + - Type: `Boolean` + - Default: `true` + - __`TEXT_COLOR`__ - Config Key: `text-color` - Values - Type: `String` - Default: `#FFFFFFFF` -- __`DURATION_COLOR`__ - - Config Key: `duration-color` +- __`INFO_COLOR`__ + - Config Key: `info-color` - Values - Type: `String` - Default: `#FFFFFFFF` +- __`VANILLA_ICON_SCALE`__ + - Config Key: `vanilla-icon-scale` + - Values + - Type: `Float` + - Default: `1.0F` + - Minimum: `0.5F` + - Maximum: `1.25F` + +- __`VANILLA_TEXT_SCALE`__ + - Config Key: `vanilla-text-scale` + - Values + - Type: `Float` + - Default: `1.0F` + - Minimum: `0.25F` + - Maximum: `2.0F` + +- __`SCALE`__ + - Config Key: `scale` + - Values + - Type: `Float` + - Default: `1.0F` + - Minimum: `0.25F` + - Maximum: `5.0F` + - __`EXCLUDE_PERM`__ - Config Key: `exclude-perm` - Values diff --git a/docs/developers/mods/scoreboard.mdx b/docs/developers/mods/scoreboard.mdx index b5672519..76dc26b6 100644 --- a/docs/developers/mods/scoreboard.mdx +++ b/docs/developers/mods/scoreboard.mdx @@ -62,6 +62,12 @@ public void toggleScoreboardExample(Player viewer, boolean value) { - Type: `Boolean` - Default: `false` +- __`DISPLAY_TOGGLE_MESSAGE`__ + - Config Key: `display-toggle-message` + - Values + - Type: `Boolean` + - Default: `true` + - __`BACKGROUND_COLOR`__ - Config Key: `background-color` - Values diff --git a/docs/developers/mods/screenshot.mdx b/docs/developers/mods/screenshot.mdx index 41283ac9..690e575f 100644 --- a/docs/developers/mods/screenshot.mdx +++ b/docs/developers/mods/screenshot.mdx @@ -45,6 +45,12 @@ public void toggleScreenshotUploaderExample(Player viewer, boolean value) { - Type: `Boolean` - Default: `true` +- __`DELETE_OPTION`__ + - Config Key: `delete-option` + - Values + - Type: `Boolean` + - Default: `true` + - __`WORLD_DETAILS`__ - A screenshot file saved with world details enabled has metadata that contains your player coordinates, the biome, and more. - Config Key: `world-details` diff --git a/docs/developers/mods/skyblock.mdx b/docs/developers/mods/skyblock.mdx index 52ed47b8..a241c529 100644 --- a/docs/developers/mods/skyblock.mdx +++ b/docs/developers/mods/skyblock.mdx @@ -29,16 +29,16 @@ public void toggleHypixelSkyblockExample(Player viewer, boolean value) { - Minimum: `0.2F` - Maximum: `2.5F` -- __`SKYBLOCK_AUTOCOMPLETE_WARPS`__ - - Adds tab completion to the /warp command. - - Config Key: `skyblock-autocomplete-warps` +- __`MIDDLE_CLICK_ARMOR_FIX`__ + - Fixes being unable to use the "Pick Block" keybind on items when it is bound to a mouse button. + - Config Key: `middle-click-armor-fix` - Values - Type: `Boolean` - Default: `true` -- __`MIDDLE_CLICK_ARMOR_FIX`__ - - Fixes being unable to use the "Pick Block" keybind on items when it is bound to a mouse button. - - Config Key: `middle-click-armor-fix` +- __`SKYBLOCK_AUTOCOMPLETE_WARPS`__ + - Adds tab completion to the /warp command. + - Config Key: `skyblock-autocomplete-warps` - Values - Type: `Boolean` - Default: `true` @@ -112,7 +112,7 @@ public void toggleHypixelSkyblockExample(Player viewer, boolean value) { - Config Key: `custom-chime-volume` - Values - Type: `Float` - - Default: `5.0F` + - Default: `0.5F` - Minimum: `0.0F` - Maximum: `1.0F` diff --git a/docs/developers/mods/tiertagger.mdx b/docs/developers/mods/tiertagger.mdx index 704c4f8d..08fa2d9a 100644 --- a/docs/developers/mods/tiertagger.mdx +++ b/docs/developers/mods/tiertagger.mdx @@ -1,6 +1,6 @@ # Tier Tagger -Show player's PvP tier on their Name Tag +Show player's PvP tier on their Name Tag. Also has a /lctiers command to look up player tiers ## Integration @@ -63,6 +63,12 @@ public void toggleTierTaggerExample(Player viewer, boolean value) { - Type: `String` - Default: `#FFFFCF4A` +- __`COLOR_MT1`__ + - Config Key: `color-m-t1` + - Values + - Type: `String` + - Default: `#FFEAC14F` + - __`COLOR_LT1`__ - Config Key: `color-l-t1` - Values @@ -75,6 +81,12 @@ public void toggleTierTaggerExample(Player viewer, boolean value) { - Type: `String` - Default: `#FFA4B3C7` +- __`COLOR_MT2`__ + - Config Key: `color-m-t2` + - Values + - Type: `String` + - Default: `#FF96A0AE` + - __`COLOR_LT2`__ - Config Key: `color-l-t2` - Values @@ -87,6 +99,12 @@ public void toggleTierTaggerExample(Player viewer, boolean value) { - Type: `String` - Default: `#FFDD8849` +- __`COLOR_MT3`__ + - Config Key: `color-m-t3` + - Values + - Type: `String` + - Default: `#FFC8783C` + - __`COLOR_LT3`__ - Config Key: `color-l-t3` - Values @@ -99,6 +117,12 @@ public void toggleTierTaggerExample(Player viewer, boolean value) { - Type: `String` - Default: `#FF655B79` +- __`COLOR_MT4`__ + - Config Key: `color-m-t4` + - Values + - Type: `String` + - Default: `#FF655B79` + - __`COLOR_LT4`__ - Config Key: `color-l-t4` - Values @@ -111,6 +135,12 @@ public void toggleTierTaggerExample(Player viewer, boolean value) { - Type: `String` - Default: `#FF655B79` +- __`COLOR_MT5`__ + - Config Key: `color-m-t5` + - Values + - Type: `String` + - Default: `#FF655B79` + - __`COLOR_LT5`__ - Config Key: `color-l-t5` - Values diff --git a/docs/developers/modules.mdx b/docs/developers/modules.mdx index 16803d54..1d8f8fc7 100644 --- a/docs/developers/modules.mdx +++ b/docs/developers/modules.mdx @@ -16,9 +16,11 @@ These modules are available to all servers using Apollo and do not require any p 🔗 [Entity](/apollo/developers/modules/entity)
🔗 [Glint](/apollo/developers/modules/glint)
🔗 [Glow](/apollo/developers/modules/glow)
+🔗 [Height Limit](/apollo/developers/modules/heightlimit)
🔗 [Hologram](/apollo/developers/modules/hologram)
🔗 [Inventory](/apollo/developers/modules/inventory)
🔗 [Limb](/apollo/developers/modules/limb)
+🔗 [Marker](/apollo/developers/modules/marker)
🔗 [Mod Setting](/apollo/developers/modules/modsetting)
🔗 [Nametag](/apollo/developers/modules/nametag)
🔗 [Nick Hider](/apollo/developers/modules/nickhider)
diff --git a/docs/developers/modules/_meta.json b/docs/developers/modules/_meta.json index 182a8a35..11e872d0 100644 --- a/docs/developers/modules/_meta.json +++ b/docs/developers/modules/_meta.json @@ -9,6 +9,7 @@ "entity": "Entity", "glint": "Glint", "glow": "Glow", + "heightlimit": "Height Limit", "hologram": "Hologram", "inventory": "Inventory", "limb": "Limb", diff --git a/docs/developers/modules/chat.mdx b/docs/developers/modules/chat.mdx index 6065ed97..4dd6fdbf 100644 --- a/docs/developers/modules/chat.mdx +++ b/docs/developers/modules/chat.mdx @@ -8,6 +8,10 @@ The chat module allows you to interact with and modify users chat feeds. - Adds the ability to simulate live updating messages - Grants the ability to remove specific messages for a player +- Display clickable chat buttons in a fixed-size box between the chat input field and the chat log. + - Ability to mix adventure components and icons inside a single button. + - Ability to customize the button shape, size, position, colors and hover colors. + - Ability to run commands or open URLs on click. ![Chat Module Example](/modules/chat/overview.gif#center) @@ -285,3 +289,664 @@ public void removeLiveChatMessageExample() { +## Chat Buttons + +Display server-driven clickable buttons on the chat screen. Buttons live in a single invisible fixed-size box +(`320x20` GUI-scaled pixels) anchored in the strip between the chat input field and the chat log, visible while the chat screen is open. + +Chat buttons are built on Apollo's shared button system: `ChatButton` extends `ApolloButton`. +Read the [buttons utilities page](/apollo/developers/utilities/buttons) for the shared +concepts: content, tooltips, click actions, shapes, sizes, colors and the update semantics. + + + Displaying buttons with the same id replaces the previous button. + + +### Sample Code +Explore each integration by cycling through each tab, to find the best fit for your requirements and needs. + + + + + + +**Apollo API examples.** See [General](/apollo/developers/general) for common patterns and helpers. + + +### Displaying Chat Buttons + +```java +public void displayChatButtonsExample(Player viewer) { + Optional apolloPlayerOpt = Apollo.getPlayerManager().getPlayer(viewer.getUniqueId()); + + apolloPlayerOpt.ifPresent(apolloPlayer -> { + ChatButton teamChat = ChatButton.builder() + .id("team-chat") + .position(HudPosition.of(0, 2)) + .size(ApolloButtonSize.of(70, 16)) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(ChatButton.DEFAULT_BACKGROUND_COLOR) + .borderColor(ChatButton.DEFAULT_BORDER_COLOR) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder() + .itemName("SHIELD") + .build()) + .append(Component.text("Team Chat", NamedTextColor.GREEN)) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.of( + Component.text("Click to switch!", NamedTextColor.YELLOW))) + .onClick(ApolloButtonAction.runCommand("/channel team")) + .build(); + + this.chatModule.displayChatButtons(apolloPlayer, Arrays.asList(teamChat)); + }); +} +``` + +### Removing a Chat Button + +```java +public void removeChatButtonExample(Player viewer) { + Optional apolloPlayerOpt = Apollo.getPlayerManager().getPlayer(viewer.getUniqueId()); + apolloPlayerOpt.ifPresent(apolloPlayer -> this.chatModule.removeChatButton(apolloPlayer, "team-chat")); +} +``` + +### Resetting all Chat Buttons + +```java +public void resetChatButtonsExample(Player viewer) { + Optional apolloPlayerOpt = Apollo.getPlayerManager().getPlayer(viewer.getUniqueId()); + apolloPlayerOpt.ifPresent(this.chatModule::resetChatButtons); +} +``` + +### Updating a Chat Button + +Replaces the content and/or tooltip of a previously displayed button, leaving all other button properties unchanged. +Buttons are matched by id; See the [buttons utilities page](/apollo/developers/utilities/buttons#updating-buttons) for the shared update semantics. + +```java +public void updateChatButtonExample(Player viewer) { + Optional apolloPlayerOpt = Apollo.getPlayerManager().getPlayer(viewer.getUniqueId()); + + apolloPlayerOpt.ifPresent(apolloPlayer -> this.chatModule.updateChatButtonContent(apolloPlayer, "public-chat", + ApolloButtonContent.builder() + .append(ItemStackIcon.builder() + .itemName("PAPER") + .build()) + .append(Component.text("Public Chat", NamedTextColor.AQUA)) + .scale(1.0F) + .build())); +} +``` + +### Live Chat Buttons + +Content parts and tooltips can be **live**: instead of a static value, you provide a resolver that is called +for each viewing player and re-broadcast automatically by the module (see [Live Button Broadcast](#live-button-broadcast) below). + +```java +public void displayLiveChatButtonExample(Player viewer) { + Optional apolloPlayerOpt = Apollo.getPlayerManager().getPlayer(viewer.getUniqueId()); + + apolloPlayerOpt.ifPresent(apolloPlayer -> { + ChatButton unread = ChatButton.builder() + .id("unread") + .position(HudPosition.of(0, 2)) + .size(ChatButton.SIZE_MEDIUM) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(ChatButton.DEFAULT_BACKGROUND_COLOR) + .borderColor(ChatButton.DEFAULT_BORDER_COLOR) + .content(ApolloButtonContent.builder() + .append(Component.text("Unread: ", NamedTextColor.GRAY)) + .append(apolloViewer -> Component.text(getUnreadCount(apolloViewer.getUniqueId()), NamedTextColor.RED), Duration.ofSeconds(1)) + .scale(0.85F) + .build()) + .build(); + + this.chatModule.displayChatButton(apolloPlayer, unread); + }); +} +``` + +### `ChatButton` Options + +`ChatButton` extends `ApolloButton`. All shared options: `.id(...)`, `.shape(...)`, `.backgroundColor(...)` & `.borderColor(...)`, +`.content(...)`, `.tooltip(...)`, `.onClick(...)` and the hovered color overrides are documented on the [buttons utilities page](/apollo/developers/utilities/buttons), +along with the `ApolloButtonContent`, `ApolloButtonTooltip` and `ApolloButtonAction` builders used above. + +`.position(HudPosition)` the button position, in GUI-scaled pixels. The button must fit inside the `320x20` box (`ChatButton.BOX_WIDTH` x `ChatButton.BOX_HEIGHT`), so `x + width <= 320` and `y + height <= 20`. +```java +.position(HudPosition.of(0, 2)) +``` + +`.size(ApolloButtonSize)` the button size, in GUI-scaled pixels. Use one of the suggested chat sizes: +`ChatButton.SIZE_SMALL` (56x16, five fit side by side), `SIZE_MEDIUM` (96x16, three fit side by side) or +`SIZE_ICON` (16x16, for square icon-only buttons) or a fully custom size via `ApolloButtonSize.of(width, height)`. +```java +.size(ChatButton.SIZE_MEDIUM) +.size(ApolloButtonSize.of(56, 16)) +``` + + + + + + +**Lightweight Protobuf examples.** See [Lightweight Protobuf](/apollo/developers/lightweight/protobuf) for setup. + + +**Displaying Chat Buttons** + +```java +public void displayChatButtonsExample(Player viewer) { + ChatButton teamChat = ChatButton.newBuilder() + .setButton(Button.newBuilder() + .setId("team-chat") + .setPosition(HudPosition.newBuilder().setX(0).setY(2).build()) + .setSize(ButtonSize.newBuilder().setWidth(70).setHeight(16).build()) + .setShape(ButtonShape.BUTTON_SHAPE_ROUNDED_SQUARE) + .setBackgroundColor(ProtobufUtil.createColorProto(new Color(0, 0, 0, 128))) + .setBorderColor(ProtobufUtil.createColorProto(new Color(0, 0, 0, 128))) + .setContent(ButtonContent.newBuilder() + .addParts(ButtonContentPart.newBuilder() + .setIcon(Icon.newBuilder() + .setItemStack(ProtobufUtil.createItemStackIconProto("SHIELD", 0)) + .build()) + .build()) + .addParts(ButtonContentPart.newBuilder() + .setAdventureJsonText(AdventureUtil.toJson(Component.text("Team Chat", NamedTextColor.GREEN))) + .build()) + .setScale(1.0F) + .build()) + .setTooltip(ButtonTooltip.newBuilder() + .addAdventureJsonLines(AdventureUtil.toJson(Component.text("Click to switch!", NamedTextColor.YELLOW))) + .build()) + .setRunCommand("/channel team") + .build()) + .build(); + + DisplayChatButtonsMessage message = DisplayChatButtonsMessage.newBuilder() + .addChatButtons(teamChat) + .build(); + + ProtobufPacketUtil.sendPacket(viewer, message); +} +``` + +`run_command`, `open_url` and `client_action` form the button's `on_click`: set at most one; a button without one is purely decorative. `client_action` executes a built-in client action. + +```java +.setClientAction(ButtonClientAction.BUTTON_CLIENT_ACTION_OPEN_MINIMAP_VIEW) +.setClientAction(ButtonClientAction.BUTTON_CLIENT_ACTION_OPEN_WAYPOINTS_MENU) +``` + +**Removing a Chat Button** + +```java +public void removeChatButtonExample(Player viewer) { + RemoveChatButtonMessage message = RemoveChatButtonMessage.newBuilder() + .setId("team-chat") + .build(); + + ProtobufPacketUtil.sendPacket(viewer, message); +} +``` + +**Resetting all Chat Buttons** + +```java +public void resetChatButtonsExample(Player viewer) { + ResetChatButtonsMessage message = ResetChatButtonsMessage.getDefaultInstance(); + ProtobufPacketUtil.sendPacket(viewer, message); +} +``` + +**Updating a Chat Button** + +Replaces the content and/or tooltip of a previously displayed button, leaving all other button properties unchanged. +Buttons are matched by id; See the [buttons utilities page](/apollo/developers/utilities/buttons#updating-buttons) for the shared update semantics. + +```java +public void updateChatButtonExample(Player viewer) { + UpdateChatButtonMessage message = UpdateChatButtonMessage.newBuilder() + .setId("public-chat") + .setUpdate(ButtonUpdate.newBuilder() + .setContent(ButtonContent.newBuilder() + .addParts(ButtonContentPart.newBuilder() + .setIcon(Icon.newBuilder() + .setItemStack(ProtobufUtil.createItemStackIconProto("PAPER", 0)) + .build()) + .build()) + .addParts(ButtonContentPart.newBuilder() + .setAdventureJsonText(AdventureUtil.toJson(Component.text("Public Chat", NamedTextColor.AQUA))) + .build()) + .setScale(1.0F) + .build()) + .build()) + .build(); + + ProtobufPacketUtil.sendPacket(viewer, message); +} +``` + +To keep values live, re-send updates from a repeating task (mirroring the inventory module example) and ideally only to players whose chat is open, +using the serverbound [`PlayerChatOpenMessage`/`PlayerChatCloseMessage`](/apollo/developers/lightweight/protobuf/serverbound-packets) packets from the packet enrichment module: + +```java +Bukkit.getScheduler().runTaskTimerAsynchronously(plugin, this::broadcastLiveButtonUpdates, 60L, 60L); +``` + + + + + + +**Lightweight JSON examples.** See [Lightweight JSON](/apollo/developers/lightweight/json) for setup. + + +**Displaying Chat Buttons** + +```java +public void displayChatButtonsExample(Player viewer) { + JsonObject position = new JsonObject(); + position.addProperty("x", 0); + position.addProperty("y", 2); + + JsonObject size = new JsonObject(); + size.addProperty("width", 70); + size.addProperty("height", 16); + + JsonObject button = new JsonObject(); + button.addProperty("id", "team-chat"); + button.add("position", position); + button.add("size", size); + button.addProperty("shape", "BUTTON_SHAPE_ROUNDED_SQUARE"); + button.add("background_color", JsonUtil.createColorObject(new Color(0, 0, 0, 128))); + button.add("border_color", JsonUtil.createColorObject(new Color(0, 0, 0, 128))); + + JsonObject iconPart = new JsonObject(); + iconPart.add("icon", JsonUtil.createItemStackIconObject("SHIELD", 0)); + + JsonObject textPart = new JsonObject(); + textPart.addProperty("adventure_json_text", AdventureUtil.toJson(Component.text("Team Chat", NamedTextColor.GREEN))); + + JsonArray parts = new JsonArray(); + parts.add(iconPart); + parts.add(textPart); + + JsonObject content = new JsonObject(); + content.add("parts", parts); + content.addProperty("scale", 1.0F); + button.add("content", content); + + JsonArray tooltipLines = new JsonArray(); + tooltipLines.add(AdventureUtil.toJson(Component.text("Click to switch!", NamedTextColor.YELLOW))); + + JsonObject tooltip = new JsonObject(); + tooltip.add("adventure_json_lines", tooltipLines); + button.add("tooltip", tooltip); + + button.addProperty("run_command", "/channel team"); + + JsonObject chatButton = new JsonObject(); + chatButton.add("button", button); + + JsonArray buttons = new JsonArray(); + buttons.add(chatButton); + + JsonObject message = new JsonObject(); + message.addProperty("@type", "type.googleapis.com/lunarclient.apollo.chat.v1.DisplayChatButtonsMessage"); + message.add("chat_buttons", buttons); + + JsonPacketUtil.sendPacket(viewer, message); +} +``` + +`run_command`, `open_url` and `client_action` form the button's `on_click`: set at most one; a button without one is purely decorative. `client_action` executes a built-in client action. + +```java +button.addProperty("client_action", "BUTTON_CLIENT_ACTION_OPEN_MINIMAP_VIEW"); +button.addProperty("client_action", "BUTTON_CLIENT_ACTION_OPEN_WAYPOINTS_MENU"); +``` + +**Removing a Chat Button** + +```java +public void removeChatButtonExample(Player viewer) { + JsonObject message = new JsonObject(); + message.addProperty("@type", "type.googleapis.com/lunarclient.apollo.chat.v1.RemoveChatButtonMessage"); + message.addProperty("id", "team-chat"); + + JsonPacketUtil.sendPacket(viewer, message); +} +``` + +**Resetting all Chat Buttons** + +```java +public void resetChatButtonsExample(Player viewer) { + JsonObject message = new JsonObject(); + message.addProperty("@type", "type.googleapis.com/lunarclient.apollo.chat.v1.ResetChatButtonsMessage"); + + JsonPacketUtil.sendPacket(viewer, message); +} +``` + +**Updating a Chat Button** + +Replaces the content and/or tooltip of a previously displayed button, leaving all other button properties unchanged. +Buttons are matched by id; See the [buttons utilities page](/apollo/developers/utilities/buttons#updating-buttons) for the shared update semantics. + +```java +public void updateChatButtonExample(Player viewer) { + JsonObject iconPart = new JsonObject(); + iconPart.add("icon", JsonUtil.createItemStackIconObject("PAPER", 0)); + + JsonObject textPart = new JsonObject(); + textPart.addProperty("adventure_json_text", AdventureUtil.toJson(Component.text("Public Chat", NamedTextColor.AQUA))); + + JsonArray parts = new JsonArray(); + parts.add(iconPart); + parts.add(textPart); + + JsonObject content = new JsonObject(); + content.add("parts", parts); + content.addProperty("scale", 1.0F); + + JsonObject update = new JsonObject(); + update.add("content", content); + + JsonObject message = new JsonObject(); + message.addProperty("@type", "type.googleapis.com/lunarclient.apollo.chat.v1.UpdateChatButtonMessage"); + message.addProperty("id", "public-chat"); + message.add("update", update); + + JsonPacketUtil.sendPacket(viewer, message); +} +``` + + + + + +## Live Button Broadcast + +Chat buttons displayed through the Apollo API with live content parts or a live tooltip are automatically resent while the `buttons.live-broadcast` option is enabled (disabled by default); no +scheduler code required. The broadcast engine ticks every server tick (50ms) and +sends each live piece whenever its own update interval elapses, refreshing content and tooltip independently. + +Every live part and live tooltip carries its own update interval, set through the content builder's +`append(resolver, Duration)` (or `ApolloButtonContentPart.live(resolver, Duration)`) and `ApolloButtonTooltip.live(resolver, Duration)`. +Lightweight integrations replicate this by re-sending `UpdateChatButtonMessage` from their own repeating task. + + + With only `buttons.live-broadcast` enabled, updates are always sent to **every** player holding live + buttons, even while their chat is closed. Also enable the packet enrichment module and its player chat + open/close packets and events. Apollo then only sends updates to players who currently have their chat + open, and pushes fresh values the moment the chat is opened. + + +```diff + modules: + chat: + enable: true + buttons: +- live-broadcast: false ++ live-broadcast: true + packet_enrichment: +- enable: false ++ enable: true + player-chat-open: +- send-packet: false ++ send-packet: true +- fire-apollo-event: false ++ fire-apollo-event: true + player-chat-close: +- send-packet: false ++ send-packet: true +- fire-apollo-event: false ++ fire-apollo-event: true +``` + +## Default Buttons + +Chat buttons can be defined directly in `config.yml` and displayed automatically when a player joins, without any +plugin code. Set `buttons.send-defaults` to `true` (it is `false` by default) and define the buttons under `buttons.defaults`. + +Config buttons are **static**: text is read as legacy strings (`&`-color codes) and icons as icon +definitions. Live content parts and live tooltips require a resolver and are therefore only available +through the API. + +```yaml +modules: + chat: + buttons: + send-defaults: true + defaults: + - id: team-chat + position: + x: 0.0 + y: 2.0 + size: + width: 70.0 + height: 16.0 + shape: ROUNDED_SQUARE # ROUNDED_SQUARE or CIRCLE + background-color: '#80000000' # '#RRGGBB' or '#AARRGGBB' + border-color: '#80000000' + content: + scale: 1.0 + parts: # each part is a 'text' or an 'icon' + - icon: + name: SHIELD + - text: '&aTeam Chat' + tooltip: + - '&eClick to switch!' + on-click: # one of run-command, open-url or client-action + run-command: /channel team +``` + +## Example Layouts + +The example plugin ships two complete, runnable chat button layouts, each implemented in all three integration flavors. +The Apollo API version of both layouts is shown below, the `apollo-protos` and JSON versions are linked underneath each one, and both share a [`ChatButtonParts`](https://github.com/LunarClient/Apollo/blob/master/example/bukkit/proto/src/main/java/com/lunarclient/apollo/example/proto/module/chatbuttons/ChatButtonParts.java) helper ([JSON variant](https://github.com/LunarClient/Apollo/blob/master/example/bukkit/json/src/main/java/com/lunarclient/apollo/example/json/module/chatbuttons/ChatButtonParts.java)) for the pieces every button needs. + +### Channels Layout + +Chat channel switchers: Team, Public and Party. + +![Channels Layout](/modules/chat/channels.png#center) + +```java +public static void display(ChatModule chatModule, Player viewer) { + Apollo.getPlayerManager().getPlayer(viewer.getUniqueId()).ifPresent(apolloPlayer -> { + ChatButton teamChat = ChatButton.builder() + .id("team-chat") + .position(HudPosition.of(0, 2)) + .size(ApolloButtonSize.of(70, 16)) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(ChatButton.DEFAULT_BACKGROUND_COLOR) + .borderColor(ChatButton.DEFAULT_BORDER_COLOR) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder() + .itemName("SHIELD") + .build()) + .append(Component.text("Team Chat", NamedTextColor.GREEN)) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.of(Component.text("Click to switch!", NamedTextColor.YELLOW))) + .onClick(ApolloButtonAction.runCommand("/channel team")) + .build(); + + ChatButton publicChat = ChatButton.builder() + .id("public-chat") + .position(HudPosition.of(76, 2)) + .size(ApolloButtonSize.of(78, 16)) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(ChatButton.DEFAULT_BACKGROUND_COLOR) + .borderColor(ChatButton.DEFAULT_BORDER_COLOR) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder() + .itemName("OAK_SIGN") + .build()) + .append(Component.text("Public Chat")) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.of(Component.text("Click to switch!", NamedTextColor.YELLOW))) + .onClick(ApolloButtonAction.runCommand("/channel public")) + .build(); + + ChatButton partyChat = ChatButton.builder() + .id("party-chat") + .position(HudPosition.of(160, 2)) + .size(ApolloButtonSize.of(76, 16)) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(ChatButton.DEFAULT_BACKGROUND_COLOR) + .borderColor(ChatButton.DEFAULT_BORDER_COLOR) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder() + .itemName("FIREWORK_ROCKET") + .build()) + .append(Component.text("Party Chat", NamedTextColor.LIGHT_PURPLE)) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.of(Component.text("Click to switch!", NamedTextColor.YELLOW))) + .onClick(ApolloButtonAction.runCommand("/channel party")) + .build(); + + chatModule.displayChatButtons(apolloPlayer, Arrays.asList(teamChat, publicChat, partyChat)); + }); +} +``` + +The same layout built with raw payloads: [apollo-protos implementation](https://github.com/LunarClient/Apollo/blob/master/example/bukkit/proto/src/main/java/com/lunarclient/apollo/example/proto/module/chatbuttons/ChannelsLayout.java) · [JSON implementation](https://github.com/LunarClient/Apollo/blob/master/example/bukkit/json/src/main/java/com/lunarclient/apollo/example/json/module/chatbuttons/ChannelsLayout.java) + +### Staff Chat Layout + +Staff and Public channel switchers plus Clear, Mute and Unmute quick actions. + +![Staff Chat Layout](/modules/chat/staff-chat.png#center) + +```java +public static void display(ChatModule chatModule, Player viewer) { + Apollo.getPlayerManager().getPlayer(viewer.getUniqueId()).ifPresent(apolloPlayer -> { + ChatButton staffChat = ChatButton.builder() + .id("staff-chat") + .position(HudPosition.of(0, 2)) + .size(ApolloButtonSize.of(70, 16)) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(ChatButton.DEFAULT_BACKGROUND_COLOR) + .borderColor(ChatButton.DEFAULT_BORDER_COLOR) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder() + .itemName("COMMAND_BLOCK") + .build()) + .append(Component.text("Staff Chat", NamedTextColor.AQUA)) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.of(Component.text("Click to switch!", NamedTextColor.YELLOW))) + .onClick(ApolloButtonAction.runCommand("/channel staff")) + .build(); + + ChatButton publicChat = ChatButton.builder() + .id("public-chat") + .position(HudPosition.of(76, 2)) + .size(ApolloButtonSize.of(78, 16)) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(ChatButton.DEFAULT_BACKGROUND_COLOR) + .borderColor(ChatButton.DEFAULT_BORDER_COLOR) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder() + .itemName("OAK_SIGN") + .build()) + .append(Component.text("Public Chat")) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.of(Component.text("Click to switch!", NamedTextColor.YELLOW))) + .onClick(ApolloButtonAction.runCommand("/channel public")) + .build(); + + ChatButton clearChat = ChatButton.builder() + .id("clear-chat") + .position(HudPosition.of(160, 2)) + .size(ApolloButtonSize.of(44, 16)) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(ChatButton.DEFAULT_BACKGROUND_COLOR) + .borderColor(ChatButton.DEFAULT_BORDER_COLOR) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder() + .itemName("SPONGE") + .build()) + .append(Component.text("Clear", NamedTextColor.YELLOW)) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.of(Component.text("Clears the public chat", NamedTextColor.GRAY))) + .onClick(ApolloButtonAction.runCommand("/clearchat")) + .build(); + + ChatButton muteChat = ChatButton.builder() + .id("mute-chat") + .position(HudPosition.of(210, 2)) + .size(ApolloButtonSize.of(44, 16)) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(ChatButton.DEFAULT_BACKGROUND_COLOR) + .borderColor(ChatButton.DEFAULT_BORDER_COLOR) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder() + .itemName("BARRIER") + .build()) + .append(Component.text("Mute", NamedTextColor.RED)) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.of(Component.text("Mutes the public chat", NamedTextColor.GRAY))) + .onClick(ApolloButtonAction.runCommand("/mutechat")) + .build(); + + ChatButton unmuteChat = ChatButton.builder() + .id("unmute-chat") + .position(HudPosition.of(260, 2)) + .size(ApolloButtonSize.of(56, 16)) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(ChatButton.DEFAULT_BACKGROUND_COLOR) + .borderColor(ChatButton.DEFAULT_BORDER_COLOR) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder() + .itemName("BELL") + .build()) + .append(Component.text("Unmute", NamedTextColor.GREEN)) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.of(Component.text("Unmutes the public chat", NamedTextColor.GRAY))) + .onClick(ApolloButtonAction.runCommand("/unmutechat")) + .build(); + + chatModule.displayChatButtons(apolloPlayer, Arrays.asList(staffChat, publicChat, + clearChat, muteChat, unmuteChat)); + }); +} +``` + +The same layout built with raw payloads: [apollo-protos implementation](https://github.com/LunarClient/Apollo/blob/master/example/bukkit/proto/src/main/java/com/lunarclient/apollo/example/proto/module/chatbuttons/StaffChatLayout.java) · [JSON implementation](https://github.com/LunarClient/Apollo/blob/master/example/bukkit/json/src/main/java/com/lunarclient/apollo/example/json/module/chatbuttons/StaffChatLayout.java) + +## Available options + +- __`BROADCAST_LIVE_BUTTONS`__ + - Whether live chat button content is automatically re-resolved and re-sent to viewers. + - Values + - Type: `Boolean` + - Default: `false` + +- __`SEND_DEFAULT_BUTTONS`__ + - Whether the default buttons are displayed to players when they join. + - Values + - Type: `Boolean` + - Default: `false` + +- __`DEFAULT_BUTTONS`__ + - The default buttons displayed to joining players while `buttons.send-defaults` is enabled. + - Values + - Type: `List` + - Default: `chat-channels sample buttons` + diff --git a/docs/developers/modules/heightlimit.mdx b/docs/developers/modules/heightlimit.mdx new file mode 100644 index 00000000..b22148dd --- /dev/null +++ b/docs/developers/modules/heightlimit.mdx @@ -0,0 +1,202 @@ +import { Callout, Tab, Tabs } from 'nextra-theme-docs' + +# Height Limit Module + +## Overview + +The height limit module allows servers to control the build-height limit displayed by the Height Limit mod. + +- Adds the ability to set a height limit per world, rendered as a block overlay and HUD display. + + + This module is disabled by default, if you wish to use this module you will need to enable it in `config.yml`. + + + + This module only provides a visual indicator for the player, the server is still responsible for cancelling block placement above the height limit. + + +## Integration + +### Sample Code +Explore each integration by cycling through each tab, to find the best fit for your requirements and needs. + + + + + + +**Apollo API examples.** See [General](/apollo/developers/general) for common patterns and helpers. + + +### Overriding a Height Limit + +```java +public void overrideHeightLimitExample(Player viewer) { + Optional apolloPlayerOpt = Apollo.getPlayerManager().getPlayer(viewer.getUniqueId()); + + apolloPlayerOpt.ifPresent(apolloPlayer -> { + this.heightLimitModule.overrideHeightLimit(apolloPlayer, HeightLimit.builder() + .world("world_the_end") + .limit(150) + .displayName(Component.text("The End", NamedTextColor.DARK_PURPLE)) + .build() + ); + }); +} +``` + +### Removing a Height Limit + +```java +public void removeHeightLimitExample(Player viewer) { + Optional apolloPlayerOpt = Apollo.getPlayerManager().getPlayer(viewer.getUniqueId()); + apolloPlayerOpt.ifPresent(apolloPlayer -> this.heightLimitModule.removeHeightLimit(apolloPlayer, "world_the_end")); +} +``` + +### Resetting all Height Limits + +```java +public void resetHeightLimitsExample(Player viewer) { + Optional apolloPlayerOpt = Apollo.getPlayerManager().getPlayer(viewer.getUniqueId()); + apolloPlayerOpt.ifPresent(this.heightLimitModule::resetHeightLimits); +} +``` + +### `HeightLimit` Options + +`.world(String)` is the world, by name, that you wish to apply the height limit to. Sending a height limit for an already-known world replaces that worlds entry. + +```java +.world("world_the_end") +``` + +`.limit(Integer)` is the Y level where block placement is denied. The highest buildable layer is `limit - 1`. + +```java +.limit(150) +``` + +`.displayName(Component)` is the optional display name shown on the clients height limit HUD. + +```java +.displayName(Component.text("The End", NamedTextColor.DARK_PURPLE)) +``` + + + + + + +**Lightweight Protobuf examples.** See [Lightweight Protobuf](/apollo/developers/lightweight/protobuf) for setup. + + + + Make sure the server is sending the world name to the client as show in the [Player Detection](/apollo/developers/lightweight/protobuf/player-detection) example. + + +**Overriding a Height Limit** + +```java +public void overrideHeightLimitExample(Player viewer) { + OverrideHeightLimitMessage message = OverrideHeightLimitMessage.newBuilder() + .setWorld("world_the_end") + .setLimit(150) + .setDisplayNameAdventureJsonLines(AdventureUtil.toJson( + Component.text("The End", NamedTextColor.DARK_PURPLE) + )) + .build(); + + ProtobufPacketUtil.sendPacket(viewer, message); +} +``` + +**Removing a Height Limit** + +```java +public void removeHeightLimitExample(Player viewer) { + RemoveHeightLimitMessage message = RemoveHeightLimitMessage.newBuilder() + .setWorld("world_the_end") + .build(); + + ProtobufPacketUtil.sendPacket(viewer, message); +} +``` + +**Resetting all Height Limits** + +```java +public void resetHeightLimitsExample(Player viewer) { + ResetHeightLimitsMessage message = ResetHeightLimitsMessage.getDefaultInstance(); + ProtobufPacketUtil.sendPacket(viewer, message); +} +``` + + + + + + +**Lightweight JSON examples.** See [Lightweight JSON](/apollo/developers/lightweight/json) for setup. + + + + Make sure the server is sending the world name to the client as show in the [Player Detection](/apollo/developers/lightweight/json/player-detection) example. + + +**Overriding a Height Limit** + +```java +public void overrideHeightLimitExample(Player viewer) { + JsonObject message = new JsonObject(); + message.addProperty("@type", "type.googleapis.com/lunarclient.apollo.heightlimit.v1.OverrideHeightLimitMessage"); + message.addProperty("world", "world_the_end"); + message.addProperty("limit", 150); + message.addProperty("display_name_adventure_json_lines", AdventureUtil.toJson( + Component.text("The End", NamedTextColor.DARK_PURPLE) + )); + + JsonPacketUtil.sendPacket(viewer, message); +} +``` + +**Removing a Height Limit** + +```java +public void removeHeightLimitExample(Player viewer) { + JsonObject message = new JsonObject(); + message.addProperty("@type", "type.googleapis.com/lunarclient.apollo.heightlimit.v1.RemoveHeightLimitMessage"); + message.addProperty("world", "world_the_end"); + + JsonPacketUtil.sendPacket(viewer, message); +} +``` + +**Resetting all Height Limits** + +```java +public void resetHeightLimitsExample(Player viewer) { + JsonObject message = new JsonObject(); + message.addProperty("@type", "type.googleapis.com/lunarclient.apollo.heightlimit.v1.ResetHeightLimitsMessage"); + + JsonPacketUtil.sendPacket(viewer, message); +} +``` + + + + + +## Available options + +- __`DEFAULT_HEIGHT_LIMITS`__ + - Sets the default height limits to send to the player. + - Values + - Type: `List` + - Default: + ```yaml + - world: world + limit: 200 + display-name: '&6Overworld' + ``` diff --git a/docs/developers/modules/inventory.mdx b/docs/developers/modules/inventory.mdx index 35615fe2..fcd486eb 100644 --- a/docs/developers/modules/inventory.mdx +++ b/docs/developers/modules/inventory.mdx @@ -14,6 +14,10 @@ The inventory module allows you to create customizable and professional user int - Ability to copy to clipboard. - Ability to hide item tooltips. - Ability to hide slot highlighting. +- Display clickable inventory buttons in two fixed-size boxes on each side of the player inventory. + - Ability to mix adventure components and icons inside a single button. + - Ability to customize the button shape, size, position, colors and hover colors. + - Ability to run commands or open URLs on click. This module is disabled by default, if you wish to use this module you will need to enable it in `config.yml`. @@ -34,27 +38,27 @@ Explore each integration by cycling through each tab, to find the best fit for y **Copy To Clipboard Item** -`/summon item ~ ~1 ~ {Item:{id:"minecraft:paper",Count:1b,components:{"minecraft:custom_name":"COPY TO CLIPBOARD","minecraft:custom_data":{lunar:{unclickable:true,copyToClipboard:"lunarclient.com"}}}}}` +`/summon item ~ ~1 ~ {Item:{id:"minecraft:paper",Count:1b,components:{"minecraft:custom_name":"COPY TO CLIPBOARD","minecraft:custom_data":{lunar:{unclickable:true,copy_to_clipboard:"lunarclient.com"}}}}}` **Open URL Item** -`/summon item ~ ~1 ~ {Item:{id:"minecraft:torch",Count:1b,components:{"minecraft:custom_name":"OPEN URL","minecraft:custom_data":{lunar:{unclickable:true,openUrl:"https://lunarclient.com"}}}}}` +`/summon item ~ ~1 ~ {Item:{id:"minecraft:torch",Count:1b,components:{"minecraft:custom_name":"OPEN URL","minecraft:custom_data":{lunar:{unclickable:true,open_url:"https://lunarclient.com"}}}}}` **Suggest Command Item** -`/summon item ~ ~1 ~ {Item:{id:"minecraft:book",Count:1b,components:{"minecraft:custom_name":"SUGGEST COMMAND","minecraft:custom_data":{lunar:{unclickable:true,suggestCommand:"/apollo"}}}}}` +`/summon item ~ ~1 ~ {Item:{id:"minecraft:book",Count:1b,components:{"minecraft:custom_name":"SUGGEST COMMAND","minecraft:custom_data":{lunar:{unclickable:true,suggest_command:"/apollo"}}}}}` **Run Command Item** -`/summon item ~ ~1 ~ {Item:{id:"minecraft:writable_book",Count:1b,components:{"minecraft:custom_name":"RUN COMMAND","minecraft:custom_data":{lunar:{unclickable:true,runCommand:"/apollo"}}}}}` +`/summon item ~ ~1 ~ {Item:{id:"minecraft:writable_book",Count:1b,components:{"minecraft:custom_name":"RUN COMMAND","minecraft:custom_data":{lunar:{unclickable:true,run_command:"/apollo"}}}}}` **Hide Item Tooltip Item** -`/summon item ~ ~1 ~ {Item:{id:"minecraft:sponge",Count:1b,components:{"minecraft:custom_name":"HIDE ITEM TOOLTIP","minecraft:custom_data":{lunar:{unclickable:true,hideItemTooltip:true}}}}}` +`/summon item ~ ~1 ~ {Item:{id:"minecraft:sponge",Count:1b,components:{"minecraft:custom_name":"HIDE ITEM TOOLTIP","minecraft:custom_data":{lunar:{unclickable:true,hide_item_tooltip:true}}}}}` **Hide Slot Highlight Item** -`/summon item ~ ~1 ~ {Item:{id:"minecraft:dirt",Count:1b,components:{"minecraft:custom_name":"HIDE SLOT HIGHTLIGHT","minecraft:custom_data":{lunar:{unclickable:true,hideSlotHighlight:true}}}}}` +`/summon item ~ ~1 ~ {Item:{id:"minecraft:dirt",Count:1b,components:{"minecraft:custom_name":"HIDE SLOT HIGHTLIGHT","minecraft:custom_data":{lunar:{unclickable:true,hide_slot_highlight:true}}}}}` @@ -180,3 +184,1429 @@ public final class ItemUtil { + +## Inventory Buttons + +Display server-driven clickable buttons around the player inventory. Buttons live in two invisible fixed-size +boxes (`92x166` GUI-scaled pixels each) on each side of the player inventory. + +Inventory buttons are built on Apollo's shared button system: `InventoryButton` extends `ApolloButton. +Read the [buttons utilities page](/apollo/developers/utilities/buttons) for the shared +concepts: content, tooltips, click actions, shapes, sizes, colors and the update semantics. + + + Displaying buttons with the same id replaces the previous button. + + +### Sample Code +Explore each integration by cycling through each tab, to find the best fit for your requirements and needs. + + + + + + +**Apollo API examples.** See [General](/apollo/developers/general) for common patterns and helpers. + + +### Displaying Inventory Buttons + +```java +public void displayInventoryExample(Player viewer) { + Optional apolloPlayerOpt = Apollo.getPlayerManager().getPlayer(viewer.getUniqueId()); + + apolloPlayerOpt.ifPresent(apolloPlayer -> { + InventoryButton shop = InventoryButton.builder() + .id("shop") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.LEFT) + .position(HudPosition.of(4, 4)) + .size(InventoryButton.SIZE_MEDIUM) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(InventoryButton.DEFAULT_BACKGROUND_COLOR) + .borderColor(InventoryButton.DEFAULT_BORDER_COLOR) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder() + .itemName("EMERALD") + .build()) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.of( + Component.text("Shop", NamedTextColor.GREEN), + Component.text("Browse categories and buy items", NamedTextColor.GRAY), + Component.text("Click to open", NamedTextColor.YELLOW))) + .onClick(ApolloButtonAction.runCommand("/shop")) + .build(); + + InventoryButton vote = InventoryButton.builder() + .id("vote") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.RIGHT) + .position(HudPosition.of(6, 52)) + .size(InventoryButton.SIZE_WIDE) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(new Color(34, 204, 68, 64)) + .borderColor(new Color(190, 255, 205, 110)) + .hoveredBackgroundColor(new Color(34, 204, 68, 130)) + .hoveredBorderColor(new Color(190, 255, 205, 210)) + .content(ApolloButtonContent.builder() + .append(Component.text("Vote")) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.of( + Component.text("Vote", NamedTextColor.GREEN), + Component.text("Vote daily for rewards", NamedTextColor.GRAY))) + .onClick(ApolloButtonAction.openUrl("https://example.com/vote")) + .build(); + + this.inventoryModule.displayInventoryButtons(apolloPlayer, Arrays.asList(shop, vote)); + }); +} +``` + +### Removing an Inventory Button + +```java +public void removeInventoryButtonExample(Player viewer) { + Optional apolloPlayerOpt = Apollo.getPlayerManager().getPlayer(viewer.getUniqueId()); + + apolloPlayerOpt.ifPresent(apolloPlayer -> { + this.inventoryModule.removeInventoryButton(apolloPlayer, "shop"); + this.inventoryModule.removeInventoryButton(apolloPlayer, "vote"); + }); +} +``` + +### Resetting all Inventory Buttons + +```java +public void resetInventoryExample(Player viewer) { + Optional apolloPlayerOpt = Apollo.getPlayerManager().getPlayer(viewer.getUniqueId()); + apolloPlayerOpt.ifPresent(this.inventoryModule::resetInventoryButtons); +} +``` + +### Updating an Inventory Button + +Replaces the content and/or tooltip of a previously displayed button, leaving all other button properties unchanged. +Buttons are matched by id; See the [buttons utilities page](/apollo/developers/utilities/buttons#updating-buttons) for the shared update semantics. + +```java +public void updateInventoryButtonExample(Player viewer) { + Optional apolloPlayerOpt = Apollo.getPlayerManager().getPlayer(viewer.getUniqueId()); + + apolloPlayerOpt.ifPresent(apolloPlayer -> this.inventoryModule.updateInventoryButton(apolloPlayer, "vote", + ApolloButtonContent.builder() + .append(Component.text("Thanks for voting!", NamedTextColor.GREEN)) + .scale(0.85F) + .build(), + ApolloButtonTooltip.of(Component.text("Come back tomorrow!", NamedTextColor.GRAY)))); +} +``` + +### Live Inventory Buttons + +Content parts and tooltips can be **live**: instead of a static value, you provide a resolver that is called +for each viewing player and re-broadcast automatically by the module (see [Live Button Broadcast](#live-button-broadcast) below). + +```java +public void displayLiveInventoryButtonExample(Player viewer) { + Optional apolloPlayerOpt = Apollo.getPlayerManager().getPlayer(viewer.getUniqueId()); + + apolloPlayerOpt.ifPresent(apolloPlayer -> { + InventoryButton players = InventoryButton.builder() + .id("players") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.LEFT) + .position(HudPosition.of(6, 8)) + .size(InventoryButton.SIZE_WIDE) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(InventoryButton.DEFAULT_BACKGROUND_COLOR) + .borderColor(InventoryButton.DEFAULT_BORDER_COLOR) + .content(ApolloButtonContent.builder() + .append(apolloViewer -> Component.text("Players: ", NamedTextColor.GRAY) + .append(Component.text(Bukkit.getOnlinePlayers().size(), NamedTextColor.GREEN)), + Duration.ofMillis(2500L)) + .build()) + .tooltip(ApolloButtonTooltip.live(apolloViewer -> Arrays.asList( + Component.text("Players currently online", NamedTextColor.GRAY)), Duration.ofMillis(2500L))) + .build(); + + this.inventoryModule.displayInventoryButton(apolloPlayer, players); + }); +} +``` + +### `InventoryButton` Options + +`InventoryButton` extends `ApolloButton`. All shared options: `.id(...)`, `.shape(...)`, `.backgroundColor(...)` & `.borderColor(...)`, +`.content(...)`, `.tooltip(...)`, `.onClick(...)` and the hovered color overrides are documented on the [buttons utilities page](/apollo/developers/utilities/buttons), +along with the `ApolloButtonContent`, `ApolloButtonTooltip` and `ApolloButtonAction` builders used above. + +`.box(InventoryButtonBox)` the box this button is placed in, either `LEFT` or `RIGHT` of the player inventory. +Each box is `92x166` GUI-scaled pixels (`InventoryButton.BOX_WIDTH` x `InventoryButton.BOX_HEIGHT`). +```java +.box(InventoryButtonBox.LEFT) +``` + +`.inventoryType(InventoryType)` the inventory screen this button belongs to. `PLAYER` (the player inventory, +shown on both the survival and creative screens) is the only supported type today. +```java +.inventoryType(InventoryType.PLAYER) +``` + +`.position(HudPosition)` the button position, in GUI-scaled pixels. The button must fit inside the `92x166` box, so `x + width <= 92` and `y + height <= 166`. +```java +.position(HudPosition.of(8, 8)) +``` + +`.size(ApolloButtonSize)` the button size, in GUI-scaled pixels. Use one of the suggested inventory sizes: +`InventoryButton.SIZE_SMALL` (26x26), `SIZE_MEDIUM` (40x40), `SIZE_LARGE` (84x84) or `SIZE_WIDE` (80x26) or +a fully custom size via `ApolloButtonSize.of(width, height)`. +```java +.size(InventoryButton.SIZE_MEDIUM) +.size(ApolloButtonSize.of(56, 24)) +``` + + + + + + +**Lightweight Protobuf examples.** See [Lightweight Protobuf](/apollo/developers/lightweight/protobuf) for setup. + + +**Displaying Inventory Buttons** + +```java +public void displayInventoryExample(Player viewer) { + InventoryButton shop = InventoryButton.newBuilder() + .setButton(Button.newBuilder() + .setId("shop") + .setPosition(HudPosition.newBuilder().setX(4).setY(4).build()) + .setSize(ButtonSize.newBuilder().setWidth(40).setHeight(40).build()) + .setShape(ButtonShape.BUTTON_SHAPE_ROUNDED_SQUARE) + .setBackgroundColor(ProtobufUtil.createColorProto(new Color(255, 255, 255, 40))) + .setBorderColor(ProtobufUtil.createColorProto(new Color(37, 37, 37, 128))) + .setContent(ButtonContent.newBuilder() + .addParts(ButtonContentPart.newBuilder() + .setIcon(Icon.newBuilder() + .setItemStack(ProtobufUtil.createItemStackIconProto("EMERALD", 0)) + .build()) + .build()) + .setScale(1.0F) + .build()) + .setTooltip(ButtonTooltip.newBuilder() + .addAdventureJsonLines(AdventureUtil.toJson(Component.text("Shop", NamedTextColor.GREEN))) + .build()) + .setRunCommand("/shop") + .build()) + .setBox(InventoryButtonBox.INVENTORY_BUTTON_BOX_LEFT) + .build(); + + DisplayInventoryButtonsMessage message = DisplayInventoryButtonsMessage.newBuilder() + .addInventoryButtons(shop) + .build(); + + ProtobufPacketUtil.sendPacket(viewer, message); +} +``` + +`run_command`, `open_url` and `client_action` form the button's `on_click`: set at most one; a button without one is purely decorative. `client_action` executes a built-in client action. + +```java +.setClientAction(ButtonClientAction.BUTTON_CLIENT_ACTION_OPEN_MINIMAP_VIEW) +.setClientAction(ButtonClientAction.BUTTON_CLIENT_ACTION_OPEN_WAYPOINTS_MENU) +``` + +**Removing an Inventory Button** + +```java +public void removeInventoryButtonExample(Player viewer) { + RemoveInventoryButtonMessage message = RemoveInventoryButtonMessage.newBuilder() + .setId("shop") + .build(); + + ProtobufPacketUtil.sendPacket(viewer, message); +} +``` + +**Resetting all Inventory Buttons** + +```java +public void resetInventoryExample(Player viewer) { + ResetInventoryButtonsMessage message = ResetInventoryButtonsMessage.getDefaultInstance(); + ProtobufPacketUtil.sendPacket(viewer, message); +} +``` + +**Updating an Inventory Button** + +Replaces the content and/or tooltip of a previously displayed button, leaving all other button properties unchanged. +Buttons are matched by id; See the [buttons utilities page](/apollo/developers/utilities/buttons#updating-buttons) for the shared update semantics. + +```java +public void updateInventoryButtonExample(Player viewer) { + UpdateInventoryButtonMessage message = UpdateInventoryButtonMessage.newBuilder() + .setId("vote") + .setUpdate(ButtonUpdate.newBuilder() + .setContent(ButtonContent.newBuilder() + .addParts(ButtonContentPart.newBuilder() + .setAdventureJsonText(AdventureUtil.toJson( + Component.text("Thanks for voting!", NamedTextColor.GREEN))) + .build()) + .setScale(0.85F) + .build()) + .setTooltip(ButtonTooltip.newBuilder() + .addAdventureJsonLines(AdventureUtil.toJson( + Component.text("Come back tomorrow!", NamedTextColor.GRAY))) + .build()) + .build()) + .build(); + + ProtobufPacketUtil.sendPacket(viewer, message); +} +``` + +To keep values live, re-send updates from a repeating task (mirroring the team module example) and ideally only to players whose inventory is open, +using the serverbound [`PlayerInventoryOpenMessage`/`PlayerInventoryCloseMessage`](/apollo/developers/lightweight/protobuf/serverbound-packets) packets from the packet enrichment module: + +```java +Bukkit.getScheduler().runTaskTimerAsynchronously(plugin, this::broadcastLiveButtonUpdates, 60L, 60L); +``` + + + + + + +**Lightweight JSON examples.** See [Lightweight JSON](/apollo/developers/lightweight/json) for setup. + + +**Displaying Inventory Buttons** + +```java +public void displayInventoryExample(Player viewer) { + JsonObject position = new JsonObject(); + position.addProperty("x", 4); + position.addProperty("y", 4); + + JsonObject size = new JsonObject(); + size.addProperty("width", 40); + size.addProperty("height", 40); + + JsonObject button = new JsonObject(); + button.addProperty("id", "shop"); + button.add("position", position); + button.add("size", size); + button.addProperty("shape", "BUTTON_SHAPE_ROUNDED_SQUARE"); + button.add("background_color", JsonUtil.createColorObject(new Color(255, 255, 255, 40))); + button.add("border_color", JsonUtil.createColorObject(new Color(37, 37, 37, 128))); + + JsonObject iconPart = new JsonObject(); + iconPart.add("icon", JsonUtil.createItemStackIconObject("EMERALD", 0)); + + JsonArray parts = new JsonArray(); + parts.add(iconPart); + + JsonObject content = new JsonObject(); + content.add("parts", parts); + content.addProperty("scale", 1.0F); + button.add("content", content); + + JsonArray tooltipLines = new JsonArray(); + tooltipLines.add(AdventureUtil.toJson(Component.text("Shop", NamedTextColor.GREEN))); + + JsonObject tooltip = new JsonObject(); + tooltip.add("adventure_json_lines", tooltipLines); + button.add("tooltip", tooltip); + + button.addProperty("run_command", "/shop"); + + JsonObject inventoryButton = new JsonObject(); + inventoryButton.add("button", button); + inventoryButton.addProperty("box", "INVENTORY_BUTTON_BOX_LEFT"); + + JsonArray buttons = new JsonArray(); + buttons.add(inventoryButton); + + JsonObject message = new JsonObject(); + message.addProperty("@type", "type.googleapis.com/lunarclient.apollo.inventory.v1.DisplayInventoryButtonsMessage"); + message.add("inventory_buttons", buttons); + + JsonPacketUtil.sendPacket(viewer, message); +} +``` + +`run_command`, `open_url` and `client_action` form the button's `on_click`: set at most one; a button without one is purely decorative. `client_action` executes a built-in client action. + +```java +button.addProperty("client_action", "BUTTON_CLIENT_ACTION_OPEN_MINIMAP_VIEW"); +button.addProperty("client_action", "BUTTON_CLIENT_ACTION_OPEN_WAYPOINTS_MENU"); +``` + +**Removing an Inventory Button** + +```java +public void removeInventoryButtonExample(Player viewer) { + JsonObject message = new JsonObject(); + message.addProperty("@type", "type.googleapis.com/lunarclient.apollo.inventory.v1.RemoveInventoryButtonMessage"); + message.addProperty("id", "shop"); + + JsonPacketUtil.sendPacket(viewer, message); +} +``` + +**Resetting all Inventory Buttons** + +```java +public void resetInventoryExample(Player viewer) { + JsonObject message = new JsonObject(); + message.addProperty("@type", "type.googleapis.com/lunarclient.apollo.inventory.v1.ResetInventoryButtonsMessage"); + + JsonPacketUtil.sendPacket(viewer, message); +} +``` + +**Updating an Inventory Button** + +Replaces the content and/or tooltip of a previously displayed button, leaving all other button properties unchanged. +Buttons are matched by id; See the [buttons utilities page](/apollo/developers/utilities/buttons#updating-buttons) for the shared update semantics. + +```java +public void updateInventoryButtonExample(Player viewer) { + JsonObject textPart = new JsonObject(); + textPart.addProperty("adventure_json_text", AdventureUtil.toJson( + Component.text("Thanks for voting!", NamedTextColor.GREEN))); + + JsonArray parts = new JsonArray(); + parts.add(textPart); + + JsonObject content = new JsonObject(); + content.add("parts", parts); + content.addProperty("scale", 0.85F); + + JsonArray tooltipLines = new JsonArray(); + tooltipLines.add(AdventureUtil.toJson(Component.text("Come back tomorrow!", NamedTextColor.GRAY))); + + JsonObject tooltip = new JsonObject(); + tooltip.add("adventure_json_lines", tooltipLines); + + JsonObject update = new JsonObject(); + update.add("content", content); + update.add("tooltip", tooltip); + + JsonObject message = new JsonObject(); + message.addProperty("@type", "type.googleapis.com/lunarclient.apollo.inventory.v1.UpdateInventoryButtonMessage"); + message.addProperty("id", "vote"); + message.add("update", update); + + JsonPacketUtil.sendPacket(viewer, message); +} +``` + + + + + +## Live Button Broadcast + +Inventory buttons displayed through the Apollo API with live content parts or a live tooltip are automatically resent while the `buttons.live-broadcast` option is enabled (disabled by default); no +scheduler code required. The broadcast engine ticks every server tick (50ms) and +sends each live piece whenever its own update interval elapses, refreshing content and tooltip independently. + +Every live part and live tooltip carries its own update interval, set through the content builder's +`append(resolver, Duration)` (or `ApolloButtonContentPart.live(resolver, Duration)`) and `ApolloButtonTooltip.live(resolver, Duration)`. +Lightweight integrations replicate this by re-sending `UpdateInventoryButtonMessage` from their own repeating task. + + + With only `buttons.live-broadcast` enabled, updates are always sent to **every** player holding live + buttons, even while their inventory is closed. Also enable the packet enrichment module and its player + inventory open/close packets and events. Apollo then only sends updates to players who currently have their + inventory open, and pushes fresh values the moment the inventory is opened. + + +```diff + modules: + inventory: +- enable: false ++ enable: true + buttons: +- live-broadcast: false ++ live-broadcast: true + packet_enrichment: +- enable: false ++ enable: true + player-inventory-open: +- send-packet: false ++ send-packet: true +- fire-apollo-event: false ++ fire-apollo-event: true + player-inventory-close: +- send-packet: false ++ send-packet: true +- fire-apollo-event: false ++ fire-apollo-event: true +``` + +## Default Buttons + +Inventory buttons can be defined directly in `config.yml` and displayed automatically when a player joins, without any +plugin code. Set `buttons.send-defaults` to `true` (it is `false` by default) and define the buttons under `buttons.defaults`. + +Config buttons are **static**: text is read as legacy strings (`&`-color codes) and icons as icon +definitions. Live content parts and live tooltips require a resolver and are therefore only available +through the API. + +```yaml +modules: + inventory: + enable: true + buttons: + send-defaults: true + defaults: + - id: shop + inventory-type: PLAYER # currently only PLAYER + box: LEFT # LEFT or RIGHT + position: + x: 4.0 + y: 4.0 + size: + width: 40.0 + height: 40.0 + shape: ROUNDED_SQUARE # ROUNDED_SQUARE or CIRCLE + background-color: '#28FFFFFF' # '#RRGGBB' or '#AARRGGBB' + border-color: '#80252525' + content: + scale: 1.0 + parts: # each part is a 'text' or an 'icon' + - icon: + name: EMERALD + tooltip: + - '&aShop' + - '&7Browse categories and buy items' + - '&eClick to open' + on-click: # one of run-command, open-url or client-action + run-command: /shop +``` + +## Example Layouts + +The example plugin ships four complete, runnable inventory button layouts, each implemented in all three integration flavors. +The Apollo API version of every layout is shown below, the `apollo-protos` and JSON versions are linked underneath each one, and all share an [`InventoryButtonParts`](https://github.com/LunarClient/Apollo/blob/master/example/bukkit/proto/src/main/java/com/lunarclient/apollo/example/proto/module/inventorybuttons/InventoryButtonParts.java) helper ([JSON variant](https://github.com/LunarClient/Apollo/blob/master/example/bukkit/json/src/main/java/com/lunarclient/apollo/example/json/module/inventorybuttons/InventoryButtonParts.java)) for the pieces every button needs. + +### Menu Layout + +A full server menu: shop, spawn, warps, ender chest and a live balance readout, profile, settings, vote, Discord and back to lobby buttons. + +![Menu Layout](/modules/inventory/menu.png#center) + +```java +public static void display(InventoryModule inventoryModule, Player viewer) { + // Live parts refresh automatically only while the Apollo config enables + // modules.inventory.buttons.live-broadcast (see the inventory module docs) + Apollo.getPlayerManager().getPlayer(viewer.getUniqueId()).ifPresent(apolloPlayer -> { + InventoryButton shop = InventoryButton.builder() + .id("shop") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.LEFT) + .position(HudPosition.of(4, 4)) + .size(InventoryButton.SIZE_MEDIUM) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(InventoryButton.DEFAULT_BACKGROUND_COLOR) + .borderColor(InventoryButton.DEFAULT_BORDER_COLOR) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder() + .itemName("EMERALD") + .build()) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.of( + Component.text("Shop", NamedTextColor.GREEN), + Component.text("Browse categories and buy items", NamedTextColor.GRAY), + Component.text("Click to open", NamedTextColor.YELLOW))) + .onClick(ApolloButtonAction.runCommand("/shop")) + .build(); + + InventoryButton spawn = InventoryButton.builder() + .id("spawn") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.LEFT) + .position(HudPosition.of(48, 4)) + .size(InventoryButton.SIZE_MEDIUM) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(InventoryButton.DEFAULT_BACKGROUND_COLOR) + .borderColor(InventoryButton.DEFAULT_BORDER_COLOR) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder() + .itemName("RED_BED") + .build()) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.of( + Component.text("Spawn", NamedTextColor.AQUA), + Component.text("Teleport back to spawn", NamedTextColor.GRAY), + Component.text("Click to teleport", NamedTextColor.YELLOW))) + .onClick(ApolloButtonAction.runCommand("/spawn")) + .build(); + + InventoryButton warps = InventoryButton.builder() + .id("warps") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.LEFT) + .position(HudPosition.of(4, 48)) + .size(InventoryButton.SIZE_MEDIUM) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(InventoryButton.DEFAULT_BACKGROUND_COLOR) + .borderColor(InventoryButton.DEFAULT_BORDER_COLOR) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder() + .itemName("COMPASS") + .build()) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.of( + Component.text("Warps", NamedTextColor.AQUA), + Component.text("Browse public warps", NamedTextColor.GRAY), + Component.text("Click to teleport", NamedTextColor.YELLOW))) + .onClick(ApolloButtonAction.runCommand("/warps")) + .build(); + + InventoryButton enderChest = InventoryButton.builder() + .id("enderchest") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.LEFT) + .position(HudPosition.of(48, 48)) + .size(InventoryButton.SIZE_MEDIUM) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(InventoryButton.DEFAULT_BACKGROUND_COLOR) + .borderColor(InventoryButton.DEFAULT_BORDER_COLOR) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder() + .itemName("ENDER_CHEST") + .build()) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.of( + Component.text("Ender Chest", NamedTextColor.LIGHT_PURPLE), + Component.text("Open your personal storage", NamedTextColor.GRAY), + Component.text("Click to open", NamedTextColor.YELLOW))) + .onClick(ApolloButtonAction.runCommand("/enderchest")) + .build(); + + InventoryButton balance = InventoryButton.builder() + .id("balance") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.LEFT) + .position(HudPosition.of(6, 92)) + .size(InventoryButton.SIZE_WIDE) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(InventoryButton.DEFAULT_BACKGROUND_COLOR) + .borderColor(InventoryButton.DEFAULT_BORDER_COLOR) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder() + .itemName("GOLD_INGOT") + .build()) + .append(ApolloButtonContentPart.live(apolloViewer -> Component.text("$" + + String.format("%,d", getBalance(apolloViewer.getUniqueId())), NamedTextColor.GOLD), + Duration.ofMillis(2500L))) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.of(Component.text("Your balance", NamedTextColor.GOLD))) + .build(); + + InventoryButton profile = InventoryButton.builder() + .id("profile") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.RIGHT) + .position(HudPosition.of(4, 4)) + .size(InventoryButton.SIZE_MEDIUM) + .shape(ApolloButtonShape.CIRCLE) + .backgroundColor(InventoryButton.DEFAULT_BACKGROUND_COLOR) + .borderColor(InventoryButton.DEFAULT_BORDER_COLOR) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder() + .itemName("PLAYER_HEAD") // use "skull" for legacy with customModelData set to 3 + .profile(Profile.builder() + .id(UUID.fromString("f17627d8-1a97-487b-92ea-c04f413394bd")) + .texture("e3RleHR1cmVzOntTS0lOOnt1cmw6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvOWQ4MjUwNWJjZjNiYTU5YzJiZTdlMmQzNmY0ZTJiZGE4MzZmMmZkMTk0YjYyMTJhMmExYzRiNGEyYTQ3MWUifX19") + .signature("") + .build()) + .build()) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.of( + Component.text(viewer.getName(), NamedTextColor.GOLD), + Component.text("View your stats", NamedTextColor.GRAY))) + .onClick(ApolloButtonAction.runCommand("/profile")) + .build(); + + InventoryButton settings = InventoryButton.builder() + .id("settings") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.RIGHT) + .position(HudPosition.of(48, 4)) + .size(InventoryButton.SIZE_MEDIUM) + .shape(ApolloButtonShape.CIRCLE) + .backgroundColor(new Color(222, 160, 60, 85)) + .borderColor(new Color(255, 218, 150, 140)) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder() + .itemName("COMPARATOR") + .build()) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.of( + Component.text("Settings", NamedTextColor.WHITE), + Component.text("Server preferences", NamedTextColor.GRAY))) + .onClick(ApolloButtonAction.runCommand("/settings")) + .build(); + + InventoryButton vote = InventoryButton.builder() + .id("vote") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.RIGHT) + .position(HudPosition.of(6, 52)) + .size(InventoryButton.SIZE_WIDE) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(new Color(34, 204, 68, 64)) + .borderColor(new Color(190, 255, 205, 110)) + .hoveredBackgroundColor(new Color(34, 204, 68, 130)) + .hoveredBorderColor(new Color(190, 255, 205, 210)) + .content(ApolloButtonContent.builder() + .append(Component.text("Vote")) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.of( + Component.text("Vote", NamedTextColor.GREEN), + Component.text("Vote daily for rewards", NamedTextColor.GRAY))) + .onClick(ApolloButtonAction.openUrl("https://example.com/vote")) + .build(); + + InventoryButton discord = InventoryButton.builder() + .id("discord") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.RIGHT) + .position(HudPosition.of(6, 84)) + .size(InventoryButton.SIZE_WIDE) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(new Color(88, 101, 242, 90)) + .borderColor(new Color(150, 160, 250, 140)) + .content(ApolloButtonContent.builder() + .append(Component.text("Discord")) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.of( + Component.text("Discord", NamedTextColor.BLUE), + Component.text("Join our community", NamedTextColor.GRAY))) + .onClick(ApolloButtonAction.openUrl("https://lunarclient.dev/discord")) + .build(); + + InventoryButton lobby = InventoryButton.builder() + .id("lobby") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.RIGHT) + .position(HudPosition.of(6, 136)) + .size(InventoryButton.SIZE_WIDE) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(new Color(224, 64, 64, 128)) + .borderColor(new Color(255, 200, 200, 140)) + .content(ApolloButtonContent.builder() + .append(Component.text("Back to Lobby")) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.of( + Component.text("Back to Lobby", NamedTextColor.RED), + Component.text("Return to the main lobby", NamedTextColor.GRAY))) + .onClick(ApolloButtonAction.runCommand("/lobby")) + .build(); + + inventoryModule.displayInventoryButtons(apolloPlayer, Arrays.asList(shop, spawn, warps, enderChest, balance, + profile, settings, vote, discord, lobby)); + }); +} + +// Demo economy: replace with your economy plugin lookup (e.g. Vault) +private static long getBalance(UUID playerIdentifier) { + long drift = (System.currentTimeMillis() / 10_000L) % 250L; + return 1_000L + Math.abs(playerIdentifier.hashCode() % 4_000) + drift; +} +``` + +The same layout built with raw payloads: [apollo-protos implementation](https://github.com/LunarClient/Apollo/blob/master/example/bukkit/proto/src/main/java/com/lunarclient/apollo/example/proto/module/inventorybuttons/MenuLayout.java) · [JSON implementation](https://github.com/LunarClient/Apollo/blob/master/example/bukkit/json/src/main/java/com/lunarclient/apollo/example/json/module/inventorybuttons/MenuLayout.java) + +### Hub Layout + +A hub server selector: Practice, Factions, BedWars and SoupPvP, profile, settings and a changelog button. + +![Hub Layout](/modules/inventory/hub.png#center) + +```java +public static void display(InventoryModule inventoryModule, Player viewer) { + Apollo.getPlayerManager().getPlayer(viewer.getUniqueId()).ifPresent(apolloPlayer -> { + InventoryButton practice = InventoryButton.builder() + .id("practice") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.LEFT) + .position(HudPosition.of(6, 8)) + .size(InventoryButton.SIZE_WIDE) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(InventoryButton.DEFAULT_BACKGROUND_COLOR) + .borderColor(InventoryButton.DEFAULT_BORDER_COLOR) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder() + .itemName("SPLASH_POTION") + .potion("healing") + .build()) + .append(Component.text("Practice", NamedTextColor.LIGHT_PURPLE)) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.of(Component.text("Click to join!", NamedTextColor.YELLOW))) + .onClick(ApolloButtonAction.runCommand("/server practice")) + .build(); + + InventoryButton factions = InventoryButton.builder() + .id("factions") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.LEFT) + .position(HudPosition.of(6, 40)) + .size(InventoryButton.SIZE_WIDE) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(InventoryButton.DEFAULT_BACKGROUND_COLOR) + .borderColor(InventoryButton.DEFAULT_BORDER_COLOR) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder() + .itemName("TNT") + .build()) + .append(Component.text("Factions", NamedTextColor.RED)) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.of(Component.text("Click to join!", NamedTextColor.YELLOW))) + .onClick(ApolloButtonAction.runCommand("/server factions")) + .build(); + + InventoryButton bedWars = InventoryButton.builder() + .id("bedwars") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.LEFT) + .position(HudPosition.of(6, 72)) + .size(InventoryButton.SIZE_WIDE) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(InventoryButton.DEFAULT_BACKGROUND_COLOR) + .borderColor(InventoryButton.DEFAULT_BORDER_COLOR) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder() + .itemName("RED_BED") + .build()) + .append(Component.text("BedWars", NamedTextColor.AQUA)) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.of(Component.text("Click to join!", NamedTextColor.YELLOW))) + .onClick(ApolloButtonAction.runCommand("/server bedwars")) + .build(); + + InventoryButton soupPvP = InventoryButton.builder() + .id("souppvp") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.LEFT) + .position(HudPosition.of(6, 104)) + .size(InventoryButton.SIZE_WIDE) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(InventoryButton.DEFAULT_BACKGROUND_COLOR) + .borderColor(InventoryButton.DEFAULT_BORDER_COLOR) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder() + .itemName("MUSHROOM_STEW") + .build()) + .append(Component.text("SoupPvP", NamedTextColor.GOLD)) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.of(Component.text("Click to join!", NamedTextColor.YELLOW))) + .onClick(ApolloButtonAction.runCommand("/server souppvp")) + .build(); + + InventoryButton profile = InventoryButton.builder() + .id("profile") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.RIGHT) + .position(HudPosition.of(4, 4)) + .size(InventoryButton.SIZE_MEDIUM) + .shape(ApolloButtonShape.CIRCLE) + .backgroundColor(InventoryButton.DEFAULT_BACKGROUND_COLOR) + .borderColor(InventoryButton.DEFAULT_BORDER_COLOR) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder() + .itemName("PLAYER_HEAD") // use "skull" for legacy with customModelData set to 3 + .profile(Profile.builder() + .id(UUID.fromString("f17627d8-1a97-487b-92ea-c04f413394bd")) + .texture("e3RleHR1cmVzOntTS0lOOnt1cmw6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvOWQ4MjUwNWJjZjNiYTU5YzJiZTdlMmQzNmY0ZTJiZGE4MzZmMmZkMTk0YjYyMTJhMmExYzRiNGEyYTQ3MWUifX19") + .signature("") + .build()) + .build()) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.of( + Component.text(viewer.getName(), NamedTextColor.GOLD), + Component.text("View your stats", NamedTextColor.GRAY))) + .onClick(ApolloButtonAction.runCommand("/profile")) + .build(); + + InventoryButton settings = InventoryButton.builder() + .id("settings") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.RIGHT) + .position(HudPosition.of(48, 4)) + .size(InventoryButton.SIZE_MEDIUM) + .shape(ApolloButtonShape.CIRCLE) + .backgroundColor(new Color(222, 160, 60, 85)) + .borderColor(new Color(255, 218, 150, 140)) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder() + .itemName("COMPARATOR") + .build()) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.of( + Component.text("Settings", NamedTextColor.WHITE), + Component.text("Server preferences", NamedTextColor.GRAY))) + .onClick(ApolloButtonAction.runCommand("/settings")) + .build(); + + InventoryButton changelog = InventoryButton.builder() + .id("changelog") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.RIGHT) + .position(HudPosition.of(6, 52)) + .size(InventoryButton.SIZE_WIDE) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(InventoryButton.DEFAULT_BACKGROUND_COLOR) + .borderColor(InventoryButton.DEFAULT_BORDER_COLOR) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder() + .itemName("WRITABLE_BOOK") + .build()) + .append(Component.text("Changelog")) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.of( + Component.text("🌙 Apollo - v1.2.8", NamedTextColor.GOLD), + Component.empty(), + Component.text("• Released Markers Module", NamedTextColor.GRAY), + Component.text("• Added ALLOW_DIG_AND_USE & DISABLE_BLOCK_MISS_PENALTY", NamedTextColor.GRAY), + Component.text(" options to Combat Module", NamedTextColor.GRAY), + Component.text("• Added configurable Server Link Button placement", NamedTextColor.GRAY), + Component.text("• Added API option to auto-enable Staff Mods", NamedTextColor.GRAY), + Component.text(" when unlocked via the Staff Mod Module", NamedTextColor.GRAY), + Component.text("• Improved performance with various optimizations", NamedTextColor.GRAY), + Component.empty(), + Component.text("Read the full changelog at", NamedTextColor.YELLOW), + Component.text("https://github.com/LunarClient/Apollo/releases/tag/v1.2.8", NamedTextColor.YELLOW))) + .onClick(ApolloButtonAction.openUrl("https://github.com/LunarClient/Apollo/releases/tag/v1.2.8")) + .build(); + + inventoryModule.displayInventoryButtons(apolloPlayer, Arrays.asList(practice, factions, bedWars, + soupPvP, profile, settings, changelog)); + }); +} +``` + +The same layout built with raw payloads: [apollo-protos implementation](https://github.com/LunarClient/Apollo/blob/master/example/bukkit/proto/src/main/java/com/lunarclient/apollo/example/proto/module/inventorybuttons/HubLayout.java) · [JSON implementation](https://github.com/LunarClient/Apollo/blob/master/example/bukkit/json/src/main/java/com/lunarclient/apollo/example/json/module/inventorybuttons/HubLayout.java) + +### Minigame Layout + +A minigame overlay: map info, a live kill counter and mod-aware Show Map / Waypoints buttons using client actions, profile, settings and back to lobby buttons. + +![Minigame Layout](/modules/inventory/minigame.png#center) + +```java +public static void display(InventoryModule inventoryModule, Player viewer) { + // Live parts refresh automatically only while the Apollo config enables + // modules.inventory.buttons.live-broadcast (see the inventory module docs) + Apollo.getPlayerManager().getPlayer(viewer.getUniqueId()).ifPresent(apolloPlayer -> { + InventoryButton mapInfo = InventoryButton.builder() + .id("map-info") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.LEFT) + .position(HudPosition.of(6, 8)) + .size(InventoryButton.SIZE_WIDE) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(InventoryButton.DEFAULT_BACKGROUND_COLOR) + .borderColor(InventoryButton.DEFAULT_BORDER_COLOR) + .content(ApolloButtonContent.builder() + .append(Component.text("Map: Apollo", NamedTextColor.AQUA)) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.of( + Component.text("Built by the Lunar Client Team"), + Component.text("Released in 2024", NamedTextColor.GRAY))) + .build(); + + InventoryButton kills = InventoryButton.builder() + .id("kills") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.LEFT) + .position(HudPosition.of(6, 40)) + .size(InventoryButton.SIZE_WIDE) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(InventoryButton.DEFAULT_BACKGROUND_COLOR) + .borderColor(InventoryButton.DEFAULT_BORDER_COLOR) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder() + .itemName("IRON_SWORD") + .build()) + .append(apolloViewer -> Component.text("Kills: ", NamedTextColor.GRAY) + .append(Component.text(getKills(apolloViewer), NamedTextColor.RED)), + Duration.ofMillis(2500L)) + .scale(1.0F) + .build()) + .build(); + + InventoryButton lobby = InventoryButton.builder() + .id("lobby") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.RIGHT) + .position(HudPosition.of(6, 136)) + .size(InventoryButton.SIZE_WIDE) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(new Color(224, 64, 64, 128)) + .borderColor(new Color(255, 200, 200, 140)) + .content(ApolloButtonContent.builder() + .append(Component.text("Back to Lobby")) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.of( + Component.text("Back to Lobby", NamedTextColor.RED), + Component.text("Return to the main lobby", NamedTextColor.GRAY))) + .onClick(ApolloButtonAction.runCommand("/lobby")) + .build(); + + InventoryButton profile = InventoryButton.builder() + .id("profile") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.RIGHT) + .position(HudPosition.of(4, 4)) + .size(InventoryButton.SIZE_MEDIUM) + .shape(ApolloButtonShape.CIRCLE) + .backgroundColor(InventoryButton.DEFAULT_BACKGROUND_COLOR) + .borderColor(InventoryButton.DEFAULT_BORDER_COLOR) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder() + .itemName("PLAYER_HEAD") // use "skull" for legacy with customModelData set to 3 + .profile(Profile.builder() + .id(UUID.fromString("f17627d8-1a97-487b-92ea-c04f413394bd")) + .texture("e3RleHR1cmVzOntTS0lOOnt1cmw6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvOWQ4MjUwNWJjZjNiYTU5YzJiZTdlMmQzNmY0ZTJiZGE4MzZmMmZkMTk0YjYyMTJhMmExYzRiNGEyYTQ3MWUifX19") + .signature("") + .build()) + .build()) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.of( + Component.text(viewer.getName(), NamedTextColor.GOLD), + Component.text("View your stats", NamedTextColor.GRAY))) + .onClick(ApolloButtonAction.runCommand("/profile")) + .build(); + + InventoryButton settings = InventoryButton.builder() + .id("settings") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.RIGHT) + .position(HudPosition.of(48, 4)) + .size(InventoryButton.SIZE_MEDIUM) + .shape(ApolloButtonShape.CIRCLE) + .backgroundColor(new Color(222, 160, 60, 85)) + .borderColor(new Color(255, 218, 150, 140)) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder() + .itemName("COMPARATOR") + .build()) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.of( + Component.text("Settings", NamedTextColor.WHITE), + Component.text("Server preferences", NamedTextColor.GRAY))) + .onClick(ApolloButtonAction.runCommand("/settings")) + .build(); + + ModSettingModule modSettingModule = Apollo.getModuleManager().getModule(ModSettingModule.class); + boolean minimapEnabled = modSettingModule.getStatus(apolloPlayer, ModMinimap.ENABLED); + boolean waypointsEnabled = modSettingModule.getStatus(apolloPlayer, ModWaypoints.ENABLED); + + InventoryButton.InventoryButtonBuilder showMapBuilder = InventoryButton.builder() + .id("show-map") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.RIGHT) + .position(HudPosition.of(6, 52)) + .size(InventoryButton.SIZE_WIDE) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder() + .itemName("FILLED_MAP") + .build()) + .append(Component.text("Show Map")) + .scale(1.0F) + .build()); + + if (minimapEnabled) { + showMapBuilder + .backgroundColor(InventoryButton.DEFAULT_BACKGROUND_COLOR) + .borderColor(InventoryButton.DEFAULT_BORDER_COLOR) + .tooltip(ApolloButtonTooltip.of( + Component.text("Show Map", NamedTextColor.AQUA), + Component.text("Open the fullscreen minimap view", NamedTextColor.GRAY))) + .onClick(ApolloButtonAction.clientAction(ApolloButtonClientAction.OPEN_MINIMAP_VIEW)); + } else { + showMapBuilder + .backgroundColor(new Color(224, 64, 64, 128)) + .borderColor(new Color(255, 200, 200, 140)) + .tooltip(ApolloButtonTooltip.of(Component.text("Minimap mod must be enabled", NamedTextColor.RED))); + } + + InventoryButton showMap = showMapBuilder.build(); + + InventoryButton.InventoryButtonBuilder waypointsBuilder = InventoryButton.builder() + .id("waypoints") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.RIGHT) + .position(HudPosition.of(6, 84)) + .size(InventoryButton.SIZE_WIDE) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder() + .itemName("LODESTONE") + .build()) + .append(Component.text("Waypoints")) + .scale(1.0F) + .build()); + + if (waypointsEnabled) { + waypointsBuilder + .backgroundColor(InventoryButton.DEFAULT_BACKGROUND_COLOR) + .borderColor(InventoryButton.DEFAULT_BORDER_COLOR) + .tooltip(ApolloButtonTooltip.of( + Component.text("Waypoints", NamedTextColor.GOLD), + Component.text("Manage your waypoints", NamedTextColor.GRAY))) + .onClick(ApolloButtonAction.clientAction(ApolloButtonClientAction.OPEN_WAYPOINTS_MENU)); + } else { + waypointsBuilder + .backgroundColor(new Color(224, 64, 64, 128)) + .borderColor(new Color(255, 200, 200, 140)) + .tooltip(ApolloButtonTooltip.of(Component.text("Waypoints mod must be enabled", NamedTextColor.RED))); + } + + InventoryButton waypoints = waypointsBuilder.build(); + + inventoryModule.displayInventoryButtons(apolloPlayer, Arrays.asList(mapInfo, kills, lobby, + profile, settings, showMap, waypoints)); + }); +} + +private static int getKills(ApolloPlayer apolloViewer) { + Player player = Bukkit.getPlayer(apolloViewer.getUniqueId()); + return player != null ? player.getStatistic(Statistic.PLAYER_KILLS) : 0; +} +``` + +The same layout built with raw payloads: [apollo-protos implementation](https://github.com/LunarClient/Apollo/blob/master/example/bukkit/proto/src/main/java/com/lunarclient/apollo/example/proto/module/inventorybuttons/MinigameLayout.java) · [JSON implementation](https://github.com/LunarClient/Apollo/blob/master/example/bukkit/json/src/main/java/com/lunarclient/apollo/example/json/module/inventorybuttons/MinigameLayout.java) + +### Staff Layout + +A live server-stats dashboard: player count, TPS, CPU and RAM refreshing every second (requires `buttons.live-broadcast`), gamemode switch buttons. + +![Staff Layout](/modules/inventory/staff.png#center) + +```java +private static final DateTimeFormatter TIME_FORMAT = DateTimeFormatter.ofPattern("HH:mm:ss"); + +public static void display(InventoryModule inventoryModule, Player viewer) { + // Live parts refresh automatically only while the Apollo config enables + // modules.inventory.buttons.live-broadcast (see the inventory module docs) + Apollo.getPlayerManager().getPlayer(viewer.getUniqueId()).ifPresent(apolloPlayer -> { + InventoryButton players = InventoryButton.builder() + .id("players") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.LEFT) + .position(HudPosition.of(6, 8)) + .size(InventoryButton.SIZE_WIDE) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(InventoryButton.DEFAULT_BACKGROUND_COLOR) + .borderColor(InventoryButton.DEFAULT_BORDER_COLOR) + .content(ApolloButtonContent.builder() + .append(apolloViewer -> Component.text("Players: ", NamedTextColor.GRAY) + .append(Component.text(Bukkit.getOnlinePlayers().size(), NamedTextColor.GREEN)), + Duration.ofSeconds(1)) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.live(apolloViewer -> Arrays.asList( + Component.text("Players currently online", NamedTextColor.GRAY), + Component.empty(), refreshedLine()), + Duration.ofSeconds(1))) + .build(); + + InventoryButton tps = InventoryButton.builder() + .id("tps") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.LEFT) + .position(HudPosition.of(6, 40)) + .size(InventoryButton.SIZE_WIDE) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(InventoryButton.DEFAULT_BACKGROUND_COLOR) + .borderColor(InventoryButton.DEFAULT_BORDER_COLOR) + .content(ApolloButtonContent.builder() + .append(apolloViewer -> tpsContent(), Duration.ofSeconds(1)) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.live(apolloViewer -> tpsTooltip(), Duration.ofSeconds(1))) + .build(); + + InventoryButton cpu = InventoryButton.builder() + .id("cpu") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.LEFT) + .position(HudPosition.of(6, 72)) + .size(InventoryButton.SIZE_WIDE) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(InventoryButton.DEFAULT_BACKGROUND_COLOR) + .borderColor(InventoryButton.DEFAULT_BORDER_COLOR) + .content(ApolloButtonContent.builder() + .append(apolloViewer -> cpuContent(), Duration.ofSeconds(1)) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.live(apolloViewer -> cpuTooltip(), Duration.ofSeconds(1))) + .build(); + + InventoryButton ram = InventoryButton.builder() + .id("ram") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.LEFT) + .position(HudPosition.of(6, 104)) + .size(InventoryButton.SIZE_WIDE) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(InventoryButton.DEFAULT_BACKGROUND_COLOR) + .borderColor(InventoryButton.DEFAULT_BORDER_COLOR) + .content(ApolloButtonContent.builder() + .append(apolloViewer -> ramContent(), Duration.ofSeconds(1)) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.live(apolloViewer -> ramTooltip(), Duration.ofSeconds(1))) + .build(); + + InventoryButton survival = InventoryButton.builder() + .id("survival") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.RIGHT) + .position(HudPosition.of(6, 8)) + .size(InventoryButton.SIZE_WIDE) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(InventoryButton.DEFAULT_BACKGROUND_COLOR) + .borderColor(InventoryButton.DEFAULT_BORDER_COLOR) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder() + .itemName("IRON_SWORD") + .build()) + .append(Component.text("Survival")) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.of(Component.text("Click to switch!", NamedTextColor.YELLOW))) + .onClick(ApolloButtonAction.runCommand("/gamemode survival")) + .build(); + + InventoryButton creative = InventoryButton.builder() + .id("creative") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.RIGHT) + .position(HudPosition.of(6, 40)) + .size(InventoryButton.SIZE_WIDE) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(InventoryButton.DEFAULT_BACKGROUND_COLOR) + .borderColor(InventoryButton.DEFAULT_BORDER_COLOR) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder() + .itemName("GRASS_BLOCK") + .build()) + .append(Component.text("Creative")) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.of(Component.text("Click to switch!", NamedTextColor.YELLOW))) + .onClick(ApolloButtonAction.runCommand("/gamemode creative")) + .build(); + + InventoryButton adventure = InventoryButton.builder() + .id("adventure") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.RIGHT) + .position(HudPosition.of(6, 72)) + .size(InventoryButton.SIZE_WIDE) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(InventoryButton.DEFAULT_BACKGROUND_COLOR) + .borderColor(InventoryButton.DEFAULT_BORDER_COLOR) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder() + .itemName("FILLED_MAP") + .build()) + .append(Component.text("Adventure")) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.of(Component.text("Click to switch!", NamedTextColor.YELLOW))) + .onClick(ApolloButtonAction.runCommand("/gamemode adventure")) + .build(); + + InventoryButton spectator = InventoryButton.builder() + .id("spectator") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.RIGHT) + .position(HudPosition.of(6, 104)) + .size(InventoryButton.SIZE_WIDE) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(InventoryButton.DEFAULT_BACKGROUND_COLOR) + .borderColor(InventoryButton.DEFAULT_BORDER_COLOR) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder() + .itemName("ENDER_EYE") + .build()) + .append(Component.text("Spectator")) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.of(Component.text("Click to switch!", NamedTextColor.YELLOW))) + .onClick(ApolloButtonAction.runCommand("/gamemode spectator")) + .build(); + + inventoryModule.displayInventoryButtons(apolloPlayer, Arrays.asList(players, tps, cpu, ram, + survival, creative, adventure, spectator)); + }); +} + +private static Component tpsContent() { + double[] tps = ServerStatsUtil.getTps(); + if (tps == null || tps.length == 0) { + return Component.text("TPS: N/A", NamedTextColor.GRAY); + } + + double recent = Math.min(20.0D, tps[0]); + return Component.text("TPS: ", NamedTextColor.GRAY) + .append(Component.text(String.format("%.1f", recent), tpsColor(recent))); +} + +private static List tpsTooltip() { + double[] tps = ServerStatsUtil.getTps(); + if (tps == null || tps.length < 3) { + return Arrays.asList( + Component.text("TPS averages require a Paper based server", NamedTextColor.GRAY), + Component.empty(), + refreshedLine()); + } + + return Arrays.asList( + tpsAverageLine("1m", tps[0]), + tpsAverageLine("5m", tps[1]), + tpsAverageLine("15m", tps[2]), + Component.empty(), + refreshedLine()); +} + +private static Component tpsAverageLine(String window, double average) { + double tps = Math.min(20.0D, average); + return Component.text(window + ": ", NamedTextColor.GRAY) + .append(Component.text(String.format("%.2f", tps), tpsColor(tps))); +} + +private static NamedTextColor tpsColor(double tps) { + if (tps >= 18.0D) { + return NamedTextColor.GREEN; + } + + return tps >= 15.0D ? NamedTextColor.YELLOW : NamedTextColor.RED; +} + +private static Component cpuContent() { + double load = ServerStatsUtil.getSystemLoadAverage(); + if (load < 0.0D) { + return Component.text("CPU: N/A", NamedTextColor.GRAY); + } + + return Component.text("CPU: ", NamedTextColor.GRAY) + .append(Component.text(String.format("%.2f", load), cpuColor(load))); +} + +private static List cpuTooltip() { + double load = ServerStatsUtil.getSystemLoadAverage(); + if (load < 0.0D) { + return Arrays.asList( + Component.text("The system load average is unavailable", NamedTextColor.GRAY), + Component.empty(), + refreshedLine()); + } + + int cores = ServerStatsUtil.getAvailableProcessors(); + double perCore = load * 100.0D / cores; + return Arrays.asList( + Component.text("System load average (last minute)", NamedTextColor.GRAY), + Component.text("Cores: ", NamedTextColor.GRAY) + .append(Component.text(cores, NamedTextColor.WHITE)), + Component.text("Per core: ", NamedTextColor.GRAY) + .append(Component.text(String.format("%.0f%%", perCore), cpuColor(load))), + Component.empty(), + refreshedLine()); +} + +private static NamedTextColor cpuColor(double load) { + double perCore = load / ServerStatsUtil.getAvailableProcessors(); + if (perCore < 0.5D) { + return NamedTextColor.GREEN; + } + + return perCore < 1.0D ? NamedTextColor.YELLOW : NamedTextColor.RED; +} + +private static Component ramContent() { + long used = ServerStatsUtil.getUsedRamMb(); + long max = ServerStatsUtil.getMaxRamMb(); + long percent = max <= 0 ? 0 : used * 100 / max; + + return Component.text("RAM: ", NamedTextColor.GRAY) + .append(Component.text(percent + "%", ramColor(percent))); +} + +private static List ramTooltip() { + return Arrays.asList( + Component.text("Used: ", NamedTextColor.GRAY) + .append(Component.text(ServerStatsUtil.getUsedRamMb() + " MB", NamedTextColor.WHITE)), + Component.text("Max: ", NamedTextColor.GRAY) + .append(Component.text(ServerStatsUtil.getMaxRamMb() + " MB", NamedTextColor.WHITE)), + Component.empty(), + refreshedLine()); +} + +private static NamedTextColor ramColor(long percent) { + if (percent < 60) { + return NamedTextColor.GREEN; + } + + return percent < 85 ? NamedTextColor.YELLOW : NamedTextColor.RED; +} + +private static Component refreshedLine() { + return Component.text("Updated at " + LocalTime.now().format(TIME_FORMAT), NamedTextColor.YELLOW, TextDecoration.ITALIC); +} +``` + +The same layout built with raw payloads: [apollo-protos implementation](https://github.com/LunarClient/Apollo/blob/master/example/bukkit/proto/src/main/java/com/lunarclient/apollo/example/proto/module/inventorybuttons/StaffLayout.java) · [JSON implementation](https://github.com/LunarClient/Apollo/blob/master/example/bukkit/json/src/main/java/com/lunarclient/apollo/example/json/module/inventorybuttons/StaffLayout.java) + +## Available options + +- __`BROADCAST_LIVE_BUTTONS`__ + - Whether live inventory button content is automatically re-resolved and re-sent to viewers. + - Values + - Type: `Boolean` + - Default: `false` + +- __`SEND_DEFAULT_BUTTONS`__ + - Whether the default buttons are displayed to players when they join. + - Values + - Type: `Boolean` + - Default: `false` + +- __`DEFAULT_BUTTONS`__ + - The default buttons displayed to joining players while `buttons.send-defaults` is enabled. + - Values + - Type: `List` + - Default: `menu-style sample buttons` diff --git a/docs/developers/modules/nametag.mdx b/docs/developers/modules/nametag.mdx index 081f8acd..0c8ecd3d 100644 --- a/docs/developers/modules/nametag.mdx +++ b/docs/developers/modules/nametag.mdx @@ -50,6 +50,7 @@ public void overrideNametagExample(Player target) { .color(NamedTextColor.RED) .build() )) + .visibilityOverride(NametagVisibilityOverride.NONE) .build() ); } @@ -100,6 +101,15 @@ public void resetNametagsExample(Player viewer) { )) ``` +`.visibilityOverride(NametagVisibilityOverride)` overrides the vanilla team-based nametag visibility outcome for the target player, from the viewpoint of the receiving player. +- `SHOWN` displays the nametag as if the target's team nametag visibility were `always` (still respecting invisibility) +- `HIDDEN` hides the nametag as if it were `never`, even when the target is not on any team. +- `NONE` keeps the vanilla behavior. + +```java +.visibilityOverride(NametagVisibilityOverride.NONE) +``` + @@ -129,6 +139,7 @@ public void overrideNametagExample(Player target) { OverrideNametagMessage message = OverrideNametagMessage.newBuilder() .setPlayerUuid(ProtobufUtil.createUuidProto(target.getUniqueId())) .addAllAdventureJsonLines(lines) + .setVisibilityOverride(NametagVisibilityOverride.NAMETAG_VISIBILITY_OVERRIDE_NONE) .build(); ProtobufPacketUtil.broadcastPacket(message); @@ -186,6 +197,7 @@ public void overrideNametagExample(Player target) { message.addProperty("@type", "type.googleapis.com/lunarclient.apollo.nametag.v1.OverrideNametagMessage"); message.add("player_uuid", JsonUtil.createUuidObject(target.getUniqueId())); message.add("adventure_json_lines", lines); + message.addProperty("visibility_override", "NAMETAG_VISIBILITY_OVERRIDE_NONE"); JsonPacketUtil.broadcastPacket(message); } diff --git a/docs/developers/modules/packetenrichment.mdx b/docs/developers/modules/packetenrichment.mdx index 3aba0e1c..728cf986 100644 --- a/docs/developers/modules/packetenrichment.mdx +++ b/docs/developers/modules/packetenrichment.mdx @@ -30,6 +30,8 @@ The majority of this module is handled through Apollo's [event system](/apollo/d The following events are related to the packet enrichment module, you can find more information about each event on the [events page](/apollo/developers/events). * `ApolloPlayerChatCloseEvent` * `ApolloPlayerChatOpenEvent` +* `ApolloPlayerInventoryCloseEvent` +* `ApolloPlayerInventoryOpenEvent` * `ApolloPlayerAttackEvent` * `ApolloPlayerUseItemEvent` * `ApolloPlayerUseItemBucketEvent` @@ -89,6 +91,32 @@ Visit [Apollo Serverbound packets](/apollo/developers/lightweight/protobuf/serve - Type: `Boolean` - Default: `false` +- __`PLAYER_INVENTORY_OPEN_PACKET`__ + - Controls whether the client sends an additional player inventory open packet to the server. + - Values + - Type: `Boolean` + - Default: `false` + +- __`PLAYER_INVENTORY_OPEN_EVENT`__ + - Controls whether Apollo fires `ApolloPlayerInventoryOpenEvent` when the packet is received. + - Disable this and handle the packet yourself if you require asynchronous or off-thread processing. + - Values + - Type: `Boolean` + - Default: `false` + +- __`PLAYER_INVENTORY_CLOSE_PACKET`__ + - Controls whether the client sends an additional player inventory close packet to the server. + - Values + - Type: `Boolean` + - Default: `false` + +- __`PLAYER_INVENTORY_CLOSE_EVENT`__ + - Controls whether Apollo fires `ApolloPlayerInventoryCloseEvent` when the packet is received. + - Disable this and handle the packet yourself if you require asynchronous or off-thread processing. + - Values + - Type: `Boolean` + - Default: `false` + - __`PLAYER_USE_ITEM_PACKET`__ - Controls whether the client sends an additional player use item packet to the server. - Values diff --git a/docs/developers/modules/transfer.mdx b/docs/developers/modules/transfer.mdx index b2ea55b0..b099d973 100644 --- a/docs/developers/modules/transfer.mdx +++ b/docs/developers/modules/transfer.mdx @@ -119,6 +119,7 @@ public void transferExample(Player viewer) { You can provide up to `10` different addresses per ping packet. + Requests with more addresses are rejected with an `IllegalArgumentException`. @@ -209,6 +210,7 @@ public void transferExample(Player player) { You can provide up to `10` different addresses per ping packet. + Addresses beyond the first `10` are reported as `STATUS_TIMED_OUT` instead of being pinged. ```java diff --git a/docs/developers/modules/waypoint.mdx b/docs/developers/modules/waypoint.mdx index d693cd68..78642822 100644 --- a/docs/developers/modules/waypoint.mdx +++ b/docs/developers/modules/waypoint.mdx @@ -433,7 +433,18 @@ public void resetWaypointsExample(Player viewer) { - Sets the default waypoints to send to the player. - Values - Type: `List` - - Default: `Empty List` + - Default: + ```yaml + - name: Spawn + location: + world: world + x: 0 + y: 100 + z: 0 + color: '#FF0000' + prevent-removal: false + hidden: false + ``` ## Automatic Waypoint Creation from Chat diff --git a/docs/developers/utilities/_meta.json b/docs/developers/utilities/_meta.json index 9007de2b..8f08d627 100644 --- a/docs/developers/utilities/_meta.json +++ b/docs/developers/utilities/_meta.json @@ -1,4 +1,5 @@ { + "buttons": "Buttons", "colors": "Colors", "cuboids": "Cuboids", "icons": "Icons", diff --git a/docs/developers/utilities/buttons.mdx b/docs/developers/utilities/buttons.mdx new file mode 100644 index 00000000..d85e985a --- /dev/null +++ b/docs/developers/utilities/buttons.mdx @@ -0,0 +1,306 @@ +import { Callout } from 'nextra-theme-docs' + +# Buttons + +## Overview + +Apollo provides a shared button system in the `com.lunarclient.apollo.common.button` package. The abstract +`ApolloButton` carries everything a clickable GUI button needs: content, tooltip, colors, shape, size and a +click action; independently of where the button is displayed. Each *surface* then defines the placement. + +Two surfaces are available today: the [inventory module](/apollo/developers/modules/inventory)'s inventory +buttons, placed in two fixed-size boxes on each side of the player inventory, and the +[chat module](/apollo/developers/modules/chat)'s chat buttons, placed in a strip between the chat input and +the chat log. + +Buttons are always built through a surface type (e.g. `InventoryButton.builder()`), which adds the surface's +placement properties and defines the container the button `position` is measured against. There is no +standalone `ApolloButton.builder()`. + +## `ApolloButton` Properties + +Every surface builder inherits the following properties from `ApolloButton`. + +```java +public abstract class ApolloButton { + + + /** + * Returns the button {@link String} id, unique within a single + * display batch. + * + *

Displaying another button with the same id replaces the + * previous one.

+ * + * @since 1.2.9 + */ + @NotNull String id; + + /** + * Returns the {@link HudPosition} of this button, relative to the + * top-left corner of the container it is placed in. + * + *

The button must fit inside the container: {@code 0 <= x}, + * {@code 0 <= y}, {@code x + width <= container width} and + * {@code y + height <= container height}. See the surface type for + * its container dimensions (e.g. {@code InventoryButton#BOX_WIDTH}).

+ * + * @since 1.2.9 + */ + @NotNull HudPosition position; + + /** + * Returns the {@link ApolloButtonSize} of this button. + * + *

Use one of the surface's suggested sizes (e.g. + * {@code InventoryButton.SIZE_MEDIUM}) or a fully custom + * {@link ApolloButtonSize#of(float, float)}.

+ * + * @return the button size + * @since 1.2.9 + */ + @NotNull ApolloButtonSize size; + + /** + * Returns the {@link ApolloButtonShape} of this button. + * + * @since 1.2.9 + */ + @NotNull ApolloButtonShape shape; + + /** + * Returns the {@link ApolloButtonContent} rendered inside this button. + * + *

Built via {@code ApolloButtonContent.builder()}, appending static + * components, icons or live per-player parts that are re-resolved + * whenever the content is sent (see the owning module's live button + * broadcast option, e.g. {@code InventoryModule#BROADCAST_LIVE_BUTTONS}).

+ * + * @return the button content + * @since 1.2.9 + */ + @NotNull ApolloButtonContent content; + + /** + * Returns the {@link ApolloButtonTooltip} shown while this button is hovered. + * + *

Built via {@code ApolloButtonTooltip.of(...)} for static lines, + * or {@code ApolloButtonTooltip.live(...)} for per-player lines that + * are re-resolved whenever the button content is sent (see the owning + * module's live button broadcast option, e.g. + * {@code InventoryModule#BROADCAST_LIVE_BUTTONS}).

+ * + * @return the tooltip, or {@code null} for no tooltip + * @since 1.2.9 + */ + @Builder.Default + @Nullable ApolloButtonTooltip tooltip = null; + + /** + * Returns the {@link ApolloButtonAction} executed when this button + * is clicked. + * + *

Built via {@link ApolloButtonAction#runCommand(String)}, + * {@link ApolloButtonAction#openUrl(String)} or + * {@link ApolloButtonAction#clientAction(ApolloButtonClientAction)}.

+ * + * @return the click action, or {@code null} + * @since 1.2.9 + */ + @Builder.Default + @Nullable ApolloButtonAction onClick = null; + + /** + * Returns the background {@link Color} used while this button is hovered. + * + * @return the hovered background color, or {@code null} + * @since 1.2.9 + */ + @Builder.Default + @Nullable Color hoveredBackgroundColor = null; + + /** + * Returns the border {@link Color} used while this button is hovered. + * + * @return the hovered border color, or {@code null} + * @since 1.2.9 + */ + @Builder.Default + @Nullable Color hoveredBorderColor = null; + + /** + * Returns the background {@link Color} of this button. + * + * @return the background color + * @since 1.2.9 + */ + public abstract Color getBackgroundColor(); + + /** + * Returns the border {@link Color} of this button. + * + * @return the border color + * @since 1.2.9 + */ + public abstract Color getBorderColor(); + +} +``` + +### Sample Code + +The chain below builds an inventory button; `.box(...)` is the inventory surface's placement property, while +everything else is inherited from `ApolloButton`. + +```java +public void displayButtonExample(Player viewer) { + Optional apolloPlayerOpt = Apollo.getPlayerManager().getPlayer(viewer.getUniqueId()); + + apolloPlayerOpt.ifPresent(apolloPlayer -> { + InventoryButton vote = InventoryButton.builder() + .id("vote") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.RIGHT) + .position(HudPosition.of(6, 52)) + .size(InventoryButton.SIZE_WIDE) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(InventoryButton.DEFAULT_BACKGROUND_COLOR) + .borderColor(InventoryButton.DEFAULT_BORDER_COLOR) + .content(ApolloButtonContent.builder() + .append(Component.text("Vote")) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.of( + Component.text("Vote", NamedTextColor.GREEN), + Component.text("Vote daily for rewards", NamedTextColor.GRAY))) + .onClick(ApolloButtonAction.openUrl("https://example.com/vote")) + .build(); + + this.inventoryModule.displayInventoryButton(apolloPlayer, vote); + }); +} +``` + +## `ApolloButtonContent` Builder + +Button content is an ordered sequence of adventure components and icons, rendered as a single centered row. +At least one part is required, and content supports at most 30 parts (`ApolloButtonContent.MAX_PARTS`) + +`.append(Component)` appends an adventure component to the content row. +```java +.append(Component.text("Vote for us!")) +``` + +`.append(Icon)` appends an icon to the content row. Read the [icons utilities page](/apollo/developers/utilities/icons) to learn more about icons. +```java +.append(ItemStackIcon.builder().itemName("NETHER_STAR").build()) +``` + +`.append(Function, Duration)` appends a live part, resolved into a component for each viewing +player whenever the content is sent: at the owning module's live button broadcast (e.g. the inventory module's [live button broadcast](/apollo/developers/modules/inventory#live-button-broadcast)) +and refreshed at the given interval. The interval must be positive and is quantized to server ticks (50ms). +Shorthand for `append(ApolloButtonContentPart.live(resolver, updateInterval))`. +```java +.append(apolloViewer -> Component.text(Bukkit.getOnlinePlayers().size(), NamedTextColor.GREEN), Duration.ofMillis(2500L)) +``` + +`.append(ApolloButtonContentPart)` appends a pre-built content part; see the `ApolloButtonContentPart` factories (`component(...)`, `icon(...)`, `live(...)`). +```java +.append(ApolloButtonContentPart.live( + apolloViewer -> Component.text(getBalance(apolloViewer.getUniqueId()), NamedTextColor.GOLD), + Duration.ofMillis(2500L))) +``` + +`.scale(float)` sets the scale factor applied to the content row. Defaults to `1.0` and must be between `0.25` and `4`. +```java +.scale(1.0F) +``` + +### Sample Code + +```java +public static ApolloButtonContent buttonContentExample() { + return ApolloButtonContent.builder() + .append(ItemStackIcon.builder().itemName("GOLD_INGOT").build()) + .append(Component.text("Balance: ", NamedTextColor.GRAY)) + .append(ApolloButtonContentPart.live( + apolloViewer -> Component.text(getBalance(apolloViewer.getUniqueId()), NamedTextColor.GOLD), + Duration.ofMillis(2500L))) + .scale(1.0F) + .build(); +} +``` + +## `ApolloButtonTooltip` + +The tooltip shown while a button is hovered, rendered like a vanilla item tooltip at the mouse. Built via +`ApolloButtonTooltip.of(...)` for static lines (accepting either varargs or a `List`), or +`ApolloButtonTooltip.live(resolver, Duration)` for a per-player resolver that is re-resolved whenever the +button content is sent, refreshed at the given interval. The interval must be positive and is quantized to +server ticks (50ms). Tooltips support at most 100 lines (`ApolloButtonTooltip.MAX_LINES`). + +```java +ApolloButtonTooltip.of( + Component.text("Shop", NamedTextColor.GREEN), + Component.text("Browse the server shop", NamedTextColor.GRAY)); + +ApolloButtonTooltip.live(apolloViewer -> Arrays.asList( + Component.text("Updated " + LocalTime.now(), NamedTextColor.DARK_GRAY)), + Duration.ofMillis(2500L)); +``` + +## `ApolloButtonAction` + +The action executed when a button is clicked. A button without an action is purely decorative. Built via one +of three factories, each returning a dedicated `ApolloButtonAction` subtype (`RunCommandAction`, `OpenUrlAction`, `ClientAction`): + +- `ApolloButtonAction.runCommand(String)` runs the command as the player. Must start with `/`. The client + shows a confirmation prompt before running the command. +- `ApolloButtonAction.openUrl(String)` opens the URL. Respects the player's chat links setting and Apollo + link-prompt settings. +- `ApolloButtonAction.clientAction(ApolloButtonClientAction)` executes a built-in client action: + `OPEN_MINIMAP_VIEW` opens Lunar's fullscreen minimap view (does nothing when the player has the MiniMap mod + disabled) or `OPEN_WAYPOINTS_MENU` opens the waypoints menu. + +```java +.onClick(ApolloButtonAction.runCommand("/shop")) +.onClick(ApolloButtonAction.openUrl("https://example.com/vote")) +.onClick(ApolloButtonAction.clientAction(ApolloButtonClientAction.OPEN_MINIMAP_VIEW)) +``` + +## `ApolloButtonShape` + +The button shape, either `ROUNDED_SQUARE` or `CIRCLE`. Rounded squares render with slightly rounded corners; +circles use the smaller of the button's `width` and `height` as their diameter, centered within the button +bounds. + +```java +.shape(ApolloButtonShape.ROUNDED_SQUARE) +``` + +## `ApolloButtonSize` + +The button size, in GUI-scaled pixels, created via `ApolloButtonSize.of(width, height)`. + +```java +.size(ApolloButtonSize.of(56, 24)) +.size(ApolloButtonSize.of(40)) +``` + +Suggested size presets are per-surface, tuned to the surface's container dimensions; for inventory buttons they live +on `InventoryButton` (`SIZE_SMALL`, `SIZE_MEDIUM`, `SIZE_LARGE`, `SIZE_WIDE`) and for chat buttons on `ChatButton` (`SIZE_SMALL`, `SIZE_MEDIUM`, `SIZE_ICON`); +see the [inventory module page](/apollo/developers/modules/inventory#inventorybutton-options) and the [chat module page](/apollo/developers/modules/chat#chat-buttons). + +## Updating Buttons + +Modules expose update methods that replace the content and/or tooltip of a previously displayed button, +leaving all other button properties unchanged (e.g. `InventoryModule#updateInventoryButton`, which takes an +`ApolloButtonContent` and an `ApolloButtonTooltip`). Buttons are matched by id. + +The partial-update semantics are the same for every surface: + +- An unset `content` keeps the previous content; its parts and its scale; a present content replaces both. +- An unset `tooltip` keeps the previous tooltip; a present tooltip fully replaces it, and a present tooltip with zero lines clears it. + +Live content parts and live tooltips are resolved per recipient before sending, both on manual updates and by the owning +module's automatic live button broadcast. The broadcast refreshes content and tooltip independently, each on its own update interval. diff --git a/docs/developers/utilities/icons.mdx b/docs/developers/utilities/icons.mdx index 28eba917..1d29d9e3 100644 --- a/docs/developers/utilities/icons.mdx +++ b/docs/developers/utilities/icons.mdx @@ -9,7 +9,9 @@ Apollo adds three different icon builders, `ItemStackIcon`, `SimpleResourceLocat ## `ItemStackIcon` Builder The `ItemStackIcon` builder is used to assign an icon using a specified ItemStack name or ID. This will utilize the texture present in the player's resource pack as the icon. -If you're using a custom resource pack and want to make the icon appear as a model, you can set the `customModelData` to the models data value. On versions below 1.13 `customModelData` sets the durability instead. +If you're using a custom resource pack and want to make the icon appear as a model, you can set the `customModelDataObject` field to a `CustomModelData` object holding the model's data values. On versions below 1.13 the custom model data sets the durability instead. + +For potion items, set `potion` to a potion id e.g. `ItemStackIcon.builder().itemName("SPLASH_POTION").potion("healing").build()`. If your server accepts players on Minecraft versions higher than `1.8.8` then you need to use `itemName`. @@ -50,6 +52,14 @@ public final class ItemStackIcon extends Icon { */ @Nullable Profile profile; + /** + * Returns the icon {@link String} potion id (e.g. {@code "healing"}). + * + * @return the icon potion id + * @since 1.2.9 + */ + @Nullable String potion; + } ``` diff --git a/docs/public/modules/chat/channels.png b/docs/public/modules/chat/channels.png new file mode 100644 index 00000000..0bf3fb34 Binary files /dev/null and b/docs/public/modules/chat/channels.png differ diff --git a/docs/public/modules/chat/staff-chat.png b/docs/public/modules/chat/staff-chat.png new file mode 100644 index 00000000..cb892dcd Binary files /dev/null and b/docs/public/modules/chat/staff-chat.png differ diff --git a/docs/public/modules/inventory/hub.png b/docs/public/modules/inventory/hub.png new file mode 100644 index 00000000..8a12da8c Binary files /dev/null and b/docs/public/modules/inventory/hub.png differ diff --git a/docs/public/modules/inventory/menu.png b/docs/public/modules/inventory/menu.png new file mode 100644 index 00000000..5ad5c178 Binary files /dev/null and b/docs/public/modules/inventory/menu.png differ diff --git a/docs/public/modules/inventory/minigame.png b/docs/public/modules/inventory/minigame.png new file mode 100644 index 00000000..cbb444e7 Binary files /dev/null and b/docs/public/modules/inventory/minigame.png differ diff --git a/docs/public/modules/inventory/staff.png b/docs/public/modules/inventory/staff.png new file mode 100644 index 00000000..241f085a Binary files /dev/null and b/docs/public/modules/inventory/staff.png differ diff --git a/example/bukkit/api/src/main/java/com/lunarclient/apollo/example/api/ApolloApiExamplePlatform.java b/example/bukkit/api/src/main/java/com/lunarclient/apollo/example/api/ApolloApiExamplePlatform.java index 2ae26a66..d9124449 100644 --- a/example/bukkit/api/src/main/java/com/lunarclient/apollo/example/api/ApolloApiExamplePlatform.java +++ b/example/bukkit/api/src/main/java/com/lunarclient/apollo/example/api/ApolloApiExamplePlatform.java @@ -40,7 +40,9 @@ import com.lunarclient.apollo.example.api.module.CosmeticApiExample; import com.lunarclient.apollo.example.api.module.EntityApiExample; import com.lunarclient.apollo.example.api.module.GlowApiExample; +import com.lunarclient.apollo.example.api.module.HeightLimitApiExample; import com.lunarclient.apollo.example.api.module.HologramApiExample; +import com.lunarclient.apollo.example.api.module.InventoryApiExample; import com.lunarclient.apollo.example.api.module.LimbApiExample; import com.lunarclient.apollo.example.api.module.MarkerApiExample; import com.lunarclient.apollo.example.api.module.ModSettingsApiExample; @@ -87,12 +89,14 @@ public void registerModuleExamples() { this.setBeamExample(new BeamApiExample()); this.setBorderExample(new BorderApiExample()); this.setChatExample(new ChatApiExample()); + this.setInventoryExample(new InventoryApiExample()); this.setCosmeticExample(new CosmeticApiExample()); this.setColoredFireExample(new ColoredFireApiExample()); this.setCombatExample(new CombatApiExample()); this.setCooldownExample(new CooldownApiExample()); this.setEntityExample(new EntityApiExample()); this.setGlowExample(new GlowApiExample()); + this.setHeightLimitExample(new HeightLimitApiExample()); this.setHologramExample(new HologramApiExample()); this.setLimbExample(new LimbApiExample()); this.setMarkerExample(new MarkerApiExample()); diff --git a/example/bukkit/api/src/main/java/com/lunarclient/apollo/example/api/listener/ApolloPlayerApiListener.java b/example/bukkit/api/src/main/java/com/lunarclient/apollo/example/api/listener/ApolloPlayerApiListener.java index d0cb1938..068ff039 100644 --- a/example/bukkit/api/src/main/java/com/lunarclient/apollo/example/api/listener/ApolloPlayerApiListener.java +++ b/example/bukkit/api/src/main/java/com/lunarclient/apollo/example/api/listener/ApolloPlayerApiListener.java @@ -82,6 +82,11 @@ private void onApolloRegister(ApolloRegisterPlayerEvent event) { for (CommandCosmetic spec : npc.getCosmetics()) { cosmeticExample.equipNpcCosmeticToViewer(player, npc.getUuid(), spec); } + + PlayerNpc.ActiveEmote emote = npc.getActiveEmote(); + if (emote != null && npc.getViewers().contains(player.getUniqueId())) { + cosmeticExample.startNpcEmoteToViewer(player, npc.getUuid(), emote.getEmoteId(), emote.getMetadata()); + } } } diff --git a/example/bukkit/api/src/main/java/com/lunarclient/apollo/example/api/module/ChatApiExample.java b/example/bukkit/api/src/main/java/com/lunarclient/apollo/example/api/module/ChatApiExample.java index 13f325a1..e420411a 100644 --- a/example/bukkit/api/src/main/java/com/lunarclient/apollo/example/api/module/ChatApiExample.java +++ b/example/bukkit/api/src/main/java/com/lunarclient/apollo/example/api/module/ChatApiExample.java @@ -24,15 +24,22 @@ package com.lunarclient.apollo.example.api.module; import com.lunarclient.apollo.Apollo; +import com.lunarclient.apollo.common.button.content.ApolloButtonContent; +import com.lunarclient.apollo.common.icon.ItemStackIcon; import com.lunarclient.apollo.example.ApolloExamplePlugin; +import com.lunarclient.apollo.example.api.module.chatbuttons.ChannelsLayout; +import com.lunarclient.apollo.example.api.module.chatbuttons.StaffChatLayout; import com.lunarclient.apollo.example.module.impl.ChatExample; import com.lunarclient.apollo.example.util.ServerUtil; import com.lunarclient.apollo.module.chat.ChatModule; +import com.lunarclient.apollo.player.ApolloPlayer; import com.lunarclient.apollo.recipients.Recipients; +import java.util.Optional; import java.util.concurrent.atomic.AtomicInteger; import net.kyori.adventure.text.Component; import net.kyori.adventure.text.format.NamedTextColor; import org.bukkit.Bukkit; +import org.bukkit.entity.Player; import org.bukkit.scheduler.BukkitRunnable; public class ChatApiExample extends ChatExample { @@ -99,6 +106,42 @@ private void runFoliaChatMessageTask() { }, 1L, 20L); } + @Override + public void displayChannelsLayoutExample(Player viewer) { + ChannelsLayout.display(this.chatModule, viewer); + } + + @Override + public void displayStaffChatLayoutExample(Player viewer) { + StaffChatLayout.display(this.chatModule, viewer); + } + + @Override + public void resetChatButtonsExample(Player viewer) { + Optional apolloPlayerOpt = Apollo.getPlayerManager().getPlayer(viewer.getUniqueId()); + apolloPlayerOpt.ifPresent(this.chatModule::resetChatButtons); + } + + @Override + public void updateChatButtonExample(Player viewer) { + Optional apolloPlayerOpt = Apollo.getPlayerManager().getPlayer(viewer.getUniqueId()); + + apolloPlayerOpt.ifPresent(apolloPlayer -> this.chatModule.updateChatButtonContent(apolloPlayer, "public-chat", + ApolloButtonContent.builder() + .append(ItemStackIcon.builder() + .itemName("PAPER") + .build()) + .append(Component.text("Public Chat", NamedTextColor.AQUA)) + .scale(1.0F) + .build())); + } + + @Override + public void removeChatButtonExample(Player viewer) { + Optional apolloPlayerOpt = Apollo.getPlayerManager().getPlayer(viewer.getUniqueId()); + apolloPlayerOpt.ifPresent(apolloPlayer -> this.chatModule.removeChatButton(apolloPlayer, "party-chat")); + } + @Override public void removeLiveChatMessageExample() { this.chatModule.removeLiveChatMessage(Recipients.ofEveryone(), 13); diff --git a/example/bukkit/api/src/main/java/com/lunarclient/apollo/example/api/module/CosmeticApiExample.java b/example/bukkit/api/src/main/java/com/lunarclient/apollo/example/api/module/CosmeticApiExample.java index 0c82c2ca..98608354 100644 --- a/example/bukkit/api/src/main/java/com/lunarclient/apollo/example/api/module/CosmeticApiExample.java +++ b/example/bukkit/api/src/main/java/com/lunarclient/apollo/example/api/module/CosmeticApiExample.java @@ -175,13 +175,30 @@ public void startNpcEmoteExample(Player viewer, UUID npcUuid) { } @Override - public void startNpcEmoteInternal(Player viewer, UUID npcUuid, int emoteId, int metadata) { + public void startNpcEmoteInternal(UUID npcUuid, int emoteId, int metadata) { + List viewers = this.getApolloViewers(npcUuid); + if (viewers.isEmpty()) { + return; + } + Emote emote = Emote.builder() .id(emoteId) .metadata(metadata) .build(); - this.cosmeticModule.startNpcEmote(Recipients.ofEveryone(), npcUuid, emote); + this.cosmeticModule.startNpcEmote(Recipients.of(viewers), npcUuid, emote); + } + + @Override + public void startNpcEmoteToViewer(Player viewer, UUID npcUuid, int emoteId, int metadata) { + Apollo.getPlayerManager().getPlayer(viewer.getUniqueId()).ifPresent(apolloPlayer -> { + Emote emote = Emote.builder() + .id(emoteId) + .metadata(metadata) + .build(); + + this.cosmeticModule.startNpcEmote(apolloPlayer, npcUuid, emote); + }); } @Override @@ -189,6 +206,31 @@ public void stopNpcEmoteExample(Player viewer, UUID npcUuid) { this.cosmeticModule.stopNpcEmote(Recipients.ofEveryone(), npcUuid); } + @Override + public void stopNpcEmoteInternal(UUID npcUuid) { + List viewers = this.getApolloViewers(npcUuid); + if (viewers.isEmpty()) { + return; + } + + this.cosmeticModule.stopNpcEmote(Recipients.of(viewers), npcUuid); + } + + @Override + public void stopNpcEmoteToViewer(Player viewer, UUID npcUuid) { + Apollo.getPlayerManager().getPlayer(viewer.getUniqueId()).ifPresent(apolloPlayer -> + this.cosmeticModule.stopNpcEmote(apolloPlayer, npcUuid)); + } + + private List getApolloViewers(UUID npcUuid) { + List viewers = new ArrayList<>(); + for (Player player : this.getNpcViewers(npcUuid)) { + Apollo.getPlayerManager().getPlayer(player.getUniqueId()).ifPresent(viewers::add); + } + + return viewers; + } + @Override public void resetNpcEmotesExample() { this.cosmeticModule.resetNpcEmotes(Recipients.ofEveryone()); diff --git a/example/bukkit/api/src/main/java/com/lunarclient/apollo/example/api/module/HeightLimitApiExample.java b/example/bukkit/api/src/main/java/com/lunarclient/apollo/example/api/module/HeightLimitApiExample.java new file mode 100644 index 00000000..39955281 --- /dev/null +++ b/example/bukkit/api/src/main/java/com/lunarclient/apollo/example/api/module/HeightLimitApiExample.java @@ -0,0 +1,66 @@ +/* + * This file is part of Apollo, licensed under the MIT License. + * + * Copyright (c) 2026 Moonsworth + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +package com.lunarclient.apollo.example.api.module; + +import com.lunarclient.apollo.Apollo; +import com.lunarclient.apollo.example.module.impl.HeightLimitExample; +import com.lunarclient.apollo.module.heightlimit.HeightLimit; +import com.lunarclient.apollo.module.heightlimit.HeightLimitModule; +import com.lunarclient.apollo.player.ApolloPlayer; +import java.util.Optional; +import net.kyori.adventure.text.Component; +import net.kyori.adventure.text.format.NamedTextColor; +import org.bukkit.entity.Player; + +public class HeightLimitApiExample extends HeightLimitExample { + + private final HeightLimitModule heightLimitModule = Apollo.getModuleManager().getModule(HeightLimitModule.class); + + @Override + public void overrideHeightLimitExample(Player viewer) { + Optional apolloPlayerOpt = Apollo.getPlayerManager().getPlayer(viewer.getUniqueId()); + + apolloPlayerOpt.ifPresent(apolloPlayer -> { + this.heightLimitModule.overrideHeightLimit(apolloPlayer, HeightLimit.builder() + .world("world_the_end") + .limit(150) + .displayName(Component.text("The End", NamedTextColor.DARK_PURPLE)) + .build() + ); + }); + } + + @Override + public void removeHeightLimitExample(Player viewer) { + Optional apolloPlayerOpt = Apollo.getPlayerManager().getPlayer(viewer.getUniqueId()); + apolloPlayerOpt.ifPresent(apolloPlayer -> this.heightLimitModule.removeHeightLimit(apolloPlayer, "world_the_end")); + } + + @Override + public void resetHeightLimitsExample(Player viewer) { + Optional apolloPlayerOpt = Apollo.getPlayerManager().getPlayer(viewer.getUniqueId()); + apolloPlayerOpt.ifPresent(this.heightLimitModule::resetHeightLimits); + } + +} diff --git a/example/bukkit/api/src/main/java/com/lunarclient/apollo/example/api/module/InventoryApiExample.java b/example/bukkit/api/src/main/java/com/lunarclient/apollo/example/api/module/InventoryApiExample.java new file mode 100644 index 00000000..016dd510 --- /dev/null +++ b/example/bukkit/api/src/main/java/com/lunarclient/apollo/example/api/module/InventoryApiExample.java @@ -0,0 +1,141 @@ +/* + * This file is part of Apollo, licensed under the MIT License. + * + * Copyright (c) 2026 Moonsworth + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +package com.lunarclient.apollo.example.api.module; + +import com.lunarclient.apollo.Apollo; +import com.lunarclient.apollo.common.button.ApolloButtonTooltip; +import com.lunarclient.apollo.common.button.content.ApolloButtonContent; +import com.lunarclient.apollo.event.ApolloListener; +import com.lunarclient.apollo.event.EventBus; +import com.lunarclient.apollo.event.Listen; +import com.lunarclient.apollo.event.modsetting.ApolloUpdateModOptionEvent; +import com.lunarclient.apollo.example.ApolloExamplePlugin; +import com.lunarclient.apollo.example.api.module.inventorybuttons.HubLayout; +import com.lunarclient.apollo.example.api.module.inventorybuttons.MenuLayout; +import com.lunarclient.apollo.example.api.module.inventorybuttons.MinigameLayout; +import com.lunarclient.apollo.example.api.module.inventorybuttons.StaffLayout; +import com.lunarclient.apollo.example.module.impl.InventoryExample; +import com.lunarclient.apollo.mods.impl.ModMinimap; +import com.lunarclient.apollo.mods.impl.ModWaypoints; +import com.lunarclient.apollo.module.inventory.InventoryModule; +import com.lunarclient.apollo.player.ApolloPlayer; +import java.util.HashSet; +import java.util.Optional; +import java.util.Set; +import java.util.UUID; +import net.kyori.adventure.text.Component; +import net.kyori.adventure.text.format.NamedTextColor; +import org.bukkit.Bukkit; +import org.bukkit.entity.Player; +import org.bukkit.event.EventHandler; +import org.bukkit.event.Listener; +import org.bukkit.event.player.PlayerQuitEvent; + +public class InventoryApiExample extends InventoryExample implements ApolloListener, Listener { + + private final InventoryModule inventoryModule = Apollo.getModuleManager().getModule(InventoryModule.class); + + private final Set minigameViewers = new HashSet<>(); + + public InventoryApiExample() { + EventBus.getBus().register(this); + Bukkit.getPluginManager().registerEvents(this, ApolloExamplePlugin.getInstance()); + } + + @Override + public void displayMenuLayoutExample(Player viewer) { + MenuLayout.display(this.inventoryModule, viewer); + } + + @Override + public void displayHubLayoutExample(Player viewer) { + HubLayout.display(this.inventoryModule, viewer); + } + + @Override + public void displayMinigameLayoutExample(Player viewer) { + this.minigameViewers.add(viewer.getUniqueId()); + MinigameLayout.display(this.inventoryModule, viewer); + } + + @Override + public void displayStaffLayoutExample(Player viewer) { + StaffLayout.display(this.inventoryModule, viewer); + } + + @Override + public void removeInventoryButtonExample(Player viewer) { + Optional apolloPlayerOpt = Apollo.getPlayerManager().getPlayer(viewer.getUniqueId()); + + apolloPlayerOpt.ifPresent(apolloPlayer -> { + this.inventoryModule.removeInventoryButton(apolloPlayer, "shop"); + this.inventoryModule.removeInventoryButton(apolloPlayer, "vote"); + }); + } + + @Override + public void updateInventoryButtonExample(Player viewer) { + Optional apolloPlayerOpt = Apollo.getPlayerManager().getPlayer(viewer.getUniqueId()); + + apolloPlayerOpt.ifPresent(apolloPlayer -> this.inventoryModule.updateInventoryButton(apolloPlayer, "vote", + ApolloButtonContent.builder() + .append(Component.text("Thanks for voting!", NamedTextColor.GREEN)) + .scale(0.85F) + .build(), + ApolloButtonTooltip.of(Component.text("Come back tomorrow!", NamedTextColor.GRAY)))); + } + + @Override + public void resetInventoryButtonsExample(Player viewer) { + this.minigameViewers.remove(viewer.getUniqueId()); + + Optional apolloPlayerOpt = Apollo.getPlayerManager().getPlayer(viewer.getUniqueId()); + apolloPlayerOpt.ifPresent(this.inventoryModule::resetInventoryButtons); + } + + @EventHandler + private void onPlayerQuit(PlayerQuitEvent event) { + this.minigameViewers.remove(event.getPlayer().getUniqueId()); + } + + // Update Minigame layout if the player toggles their Minimap or Waypoint mod + @Listen + private void onApolloUpdateModOption(ApolloUpdateModOptionEvent event) { + String optionKey = event.getOption().getKey(); + if (!ModMinimap.ENABLED.getKey().equals(optionKey) && !ModWaypoints.ENABLED.getKey().equals(optionKey)) { + return; + } + + UUID playerIdentifier = event.getPlayer().getUniqueId(); + if (!this.minigameViewers.contains(playerIdentifier)) { + return; + } + + Player viewer = Bukkit.getPlayer(playerIdentifier); + if (viewer != null) { + MinigameLayout.display(this.inventoryModule, viewer); + } + } + +} diff --git a/example/bukkit/api/src/main/java/com/lunarclient/apollo/example/api/module/NametagApiExample.java b/example/bukkit/api/src/main/java/com/lunarclient/apollo/example/api/module/NametagApiExample.java index 132d5d86..a6af0c60 100644 --- a/example/bukkit/api/src/main/java/com/lunarclient/apollo/example/api/module/NametagApiExample.java +++ b/example/bukkit/api/src/main/java/com/lunarclient/apollo/example/api/module/NametagApiExample.java @@ -28,6 +28,7 @@ import com.lunarclient.apollo.example.module.impl.NametagExample; import com.lunarclient.apollo.module.nametag.Nametag; import com.lunarclient.apollo.module.nametag.NametagModule; +import com.lunarclient.apollo.module.nametag.NametagVisibilityOverride; import com.lunarclient.apollo.player.ApolloPlayer; import com.lunarclient.apollo.recipients.Recipients; import java.util.Optional; @@ -54,6 +55,7 @@ public void overrideNametagExample(Player target) { .color(NamedTextColor.RED) .build() )) + .visibilityOverride(NametagVisibilityOverride.NONE) .build() ); } diff --git a/example/bukkit/api/src/main/java/com/lunarclient/apollo/example/api/module/chatbuttons/ChannelsLayout.java b/example/bukkit/api/src/main/java/com/lunarclient/apollo/example/api/module/chatbuttons/ChannelsLayout.java new file mode 100644 index 00000000..816a6608 --- /dev/null +++ b/example/bukkit/api/src/main/java/com/lunarclient/apollo/example/api/module/chatbuttons/ChannelsLayout.java @@ -0,0 +1,106 @@ +/* + * This file is part of Apollo, licensed under the MIT License. + * + * Copyright (c) 2026 Moonsworth + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +package com.lunarclient.apollo.example.api.module.chatbuttons; + +import com.lunarclient.apollo.Apollo; +import com.lunarclient.apollo.common.button.ApolloButtonShape; +import com.lunarclient.apollo.common.button.ApolloButtonSize; +import com.lunarclient.apollo.common.button.ApolloButtonTooltip; +import com.lunarclient.apollo.common.button.action.ApolloButtonAction; +import com.lunarclient.apollo.common.button.content.ApolloButtonContent; +import com.lunarclient.apollo.common.icon.ItemStackIcon; +import com.lunarclient.apollo.common.location.HudPosition; +import com.lunarclient.apollo.module.chat.ChatButton; +import com.lunarclient.apollo.module.chat.ChatModule; +import java.util.Arrays; +import net.kyori.adventure.text.Component; +import net.kyori.adventure.text.format.NamedTextColor; +import org.bukkit.entity.Player; + +public final class ChannelsLayout { + + public static void display(ChatModule chatModule, Player viewer) { + Apollo.getPlayerManager().getPlayer(viewer.getUniqueId()).ifPresent(apolloPlayer -> { + ChatButton teamChat = ChatButton.builder() + .id("team-chat") + .position(HudPosition.of(0, 2)) + .size(ApolloButtonSize.of(70, 16)) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(ChatButton.DEFAULT_BACKGROUND_COLOR) + .borderColor(ChatButton.DEFAULT_BORDER_COLOR) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder() + .itemName("SHIELD") + .build()) + .append(Component.text("Team Chat", NamedTextColor.GREEN)) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.of(Component.text("Click to switch!", NamedTextColor.YELLOW))) + .onClick(ApolloButtonAction.runCommand("/channel team")) + .build(); + + ChatButton publicChat = ChatButton.builder() + .id("public-chat") + .position(HudPosition.of(76, 2)) + .size(ApolloButtonSize.of(78, 16)) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(ChatButton.DEFAULT_BACKGROUND_COLOR) + .borderColor(ChatButton.DEFAULT_BORDER_COLOR) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder() + .itemName("OAK_SIGN") + .build()) + .append(Component.text("Public Chat")) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.of(Component.text("Click to switch!", NamedTextColor.YELLOW))) + .onClick(ApolloButtonAction.runCommand("/channel public")) + .build(); + + ChatButton partyChat = ChatButton.builder() + .id("party-chat") + .position(HudPosition.of(160, 2)) + .size(ApolloButtonSize.of(76, 16)) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(ChatButton.DEFAULT_BACKGROUND_COLOR) + .borderColor(ChatButton.DEFAULT_BORDER_COLOR) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder() + .itemName("FIREWORK_ROCKET") + .build()) + .append(Component.text("Party Chat", NamedTextColor.LIGHT_PURPLE)) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.of(Component.text("Click to switch!", NamedTextColor.YELLOW))) + .onClick(ApolloButtonAction.runCommand("/channel party")) + .build(); + + chatModule.displayChatButtons(apolloPlayer, Arrays.asList(teamChat, publicChat, partyChat)); + }); + } + + private ChannelsLayout() { + } + +} diff --git a/example/bukkit/api/src/main/java/com/lunarclient/apollo/example/api/module/chatbuttons/StaffChatLayout.java b/example/bukkit/api/src/main/java/com/lunarclient/apollo/example/api/module/chatbuttons/StaffChatLayout.java new file mode 100644 index 00000000..c72a559e --- /dev/null +++ b/example/bukkit/api/src/main/java/com/lunarclient/apollo/example/api/module/chatbuttons/StaffChatLayout.java @@ -0,0 +1,143 @@ +/* + * This file is part of Apollo, licensed under the MIT License. + * + * Copyright (c) 2026 Moonsworth + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +package com.lunarclient.apollo.example.api.module.chatbuttons; + +import com.lunarclient.apollo.Apollo; +import com.lunarclient.apollo.common.button.ApolloButtonShape; +import com.lunarclient.apollo.common.button.ApolloButtonSize; +import com.lunarclient.apollo.common.button.ApolloButtonTooltip; +import com.lunarclient.apollo.common.button.action.ApolloButtonAction; +import com.lunarclient.apollo.common.button.content.ApolloButtonContent; +import com.lunarclient.apollo.common.icon.ItemStackIcon; +import com.lunarclient.apollo.common.location.HudPosition; +import com.lunarclient.apollo.module.chat.ChatButton; +import com.lunarclient.apollo.module.chat.ChatModule; +import java.util.Arrays; +import net.kyori.adventure.text.Component; +import net.kyori.adventure.text.format.NamedTextColor; +import org.bukkit.entity.Player; + +public final class StaffChatLayout { + + public static void display(ChatModule chatModule, Player viewer) { + Apollo.getPlayerManager().getPlayer(viewer.getUniqueId()).ifPresent(apolloPlayer -> { + ChatButton staffChat = ChatButton.builder() + .id("staff-chat") + .position(HudPosition.of(0, 2)) + .size(ApolloButtonSize.of(70, 16)) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(ChatButton.DEFAULT_BACKGROUND_COLOR) + .borderColor(ChatButton.DEFAULT_BORDER_COLOR) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder() + .itemName("COMMAND_BLOCK") + .build()) + .append(Component.text("Staff Chat", NamedTextColor.AQUA)) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.of(Component.text("Click to switch!", NamedTextColor.YELLOW))) + .onClick(ApolloButtonAction.runCommand("/channel staff")) + .build(); + + ChatButton publicChat = ChatButton.builder() + .id("public-chat") + .position(HudPosition.of(76, 2)) + .size(ApolloButtonSize.of(78, 16)) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(ChatButton.DEFAULT_BACKGROUND_COLOR) + .borderColor(ChatButton.DEFAULT_BORDER_COLOR) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder() + .itemName("OAK_SIGN") + .build()) + .append(Component.text("Public Chat")) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.of(Component.text("Click to switch!", NamedTextColor.YELLOW))) + .onClick(ApolloButtonAction.runCommand("/channel public")) + .build(); + + ChatButton clearChat = ChatButton.builder() + .id("clear-chat") + .position(HudPosition.of(160, 2)) + .size(ApolloButtonSize.of(44, 16)) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(ChatButton.DEFAULT_BACKGROUND_COLOR) + .borderColor(ChatButton.DEFAULT_BORDER_COLOR) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder() + .itemName("SPONGE") + .build()) + .append(Component.text("Clear", NamedTextColor.YELLOW)) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.of(Component.text("Clears the public chat", NamedTextColor.GRAY))) + .onClick(ApolloButtonAction.runCommand("/clearchat")) + .build(); + + ChatButton muteChat = ChatButton.builder() + .id("mute-chat") + .position(HudPosition.of(210, 2)) + .size(ApolloButtonSize.of(44, 16)) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(ChatButton.DEFAULT_BACKGROUND_COLOR) + .borderColor(ChatButton.DEFAULT_BORDER_COLOR) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder() + .itemName("BARRIER") + .build()) + .append(Component.text("Mute", NamedTextColor.RED)) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.of(Component.text("Mutes the public chat", NamedTextColor.GRAY))) + .onClick(ApolloButtonAction.runCommand("/mutechat")) + .build(); + + ChatButton unmuteChat = ChatButton.builder() + .id("unmute-chat") + .position(HudPosition.of(260, 2)) + .size(ApolloButtonSize.of(56, 16)) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(ChatButton.DEFAULT_BACKGROUND_COLOR) + .borderColor(ChatButton.DEFAULT_BORDER_COLOR) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder() + .itemName("BELL") + .build()) + .append(Component.text("Unmute", NamedTextColor.GREEN)) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.of(Component.text("Unmutes the public chat", NamedTextColor.GRAY))) + .onClick(ApolloButtonAction.runCommand("/unmutechat")) + .build(); + + chatModule.displayChatButtons(apolloPlayer, Arrays.asList(staffChat, publicChat, + clearChat, muteChat, unmuteChat)); + }); + } + + private StaffChatLayout() { + } + +} diff --git a/example/bukkit/api/src/main/java/com/lunarclient/apollo/example/api/module/inventorybuttons/HubLayout.java b/example/bukkit/api/src/main/java/com/lunarclient/apollo/example/api/module/inventorybuttons/HubLayout.java new file mode 100644 index 00000000..3cf5e35a --- /dev/null +++ b/example/bukkit/api/src/main/java/com/lunarclient/apollo/example/api/module/inventorybuttons/HubLayout.java @@ -0,0 +1,217 @@ +/* + * This file is part of Apollo, licensed under the MIT License. + * + * Copyright (c) 2026 Moonsworth + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +package com.lunarclient.apollo.example.api.module.inventorybuttons; + +import com.lunarclient.apollo.Apollo; +import com.lunarclient.apollo.common.button.ApolloButtonShape; +import com.lunarclient.apollo.common.button.ApolloButtonTooltip; +import com.lunarclient.apollo.common.button.action.ApolloButtonAction; +import com.lunarclient.apollo.common.button.content.ApolloButtonContent; +import com.lunarclient.apollo.common.icon.ItemStackIcon; +import com.lunarclient.apollo.common.location.HudPosition; +import com.lunarclient.apollo.common.profile.Profile; +import com.lunarclient.apollo.module.inventory.InventoryButton; +import com.lunarclient.apollo.module.inventory.InventoryButtonBox; +import com.lunarclient.apollo.module.inventory.InventoryModule; +import com.lunarclient.apollo.module.inventory.InventoryType; +import java.awt.Color; +import java.util.Arrays; +import java.util.UUID; +import net.kyori.adventure.text.Component; +import net.kyori.adventure.text.format.NamedTextColor; +import org.bukkit.entity.Player; + +public final class HubLayout { + + public static void display(InventoryModule inventoryModule, Player viewer) { + Apollo.getPlayerManager().getPlayer(viewer.getUniqueId()).ifPresent(apolloPlayer -> { + InventoryButton practice = InventoryButton.builder() + .id("practice") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.LEFT) + .position(HudPosition.of(6, 8)) + .size(InventoryButton.SIZE_WIDE) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(InventoryButton.DEFAULT_BACKGROUND_COLOR) + .borderColor(InventoryButton.DEFAULT_BORDER_COLOR) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder() + .itemName("SPLASH_POTION") + .potion("healing") + .build()) + .append(Component.text("Practice", NamedTextColor.LIGHT_PURPLE)) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.of(Component.text("Click to join!", NamedTextColor.YELLOW))) + .onClick(ApolloButtonAction.runCommand("/server practice")) + .build(); + + InventoryButton factions = InventoryButton.builder() + .id("factions") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.LEFT) + .position(HudPosition.of(6, 40)) + .size(InventoryButton.SIZE_WIDE) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(InventoryButton.DEFAULT_BACKGROUND_COLOR) + .borderColor(InventoryButton.DEFAULT_BORDER_COLOR) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder() + .itemName("TNT") + .build()) + .append(Component.text("Factions", NamedTextColor.RED)) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.of(Component.text("Click to join!", NamedTextColor.YELLOW))) + .onClick(ApolloButtonAction.runCommand("/server factions")) + .build(); + + InventoryButton bedWars = InventoryButton.builder() + .id("bedwars") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.LEFT) + .position(HudPosition.of(6, 72)) + .size(InventoryButton.SIZE_WIDE) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(InventoryButton.DEFAULT_BACKGROUND_COLOR) + .borderColor(InventoryButton.DEFAULT_BORDER_COLOR) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder() + .itemName("RED_BED") + .build()) + .append(Component.text("BedWars", NamedTextColor.AQUA)) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.of(Component.text("Click to join!", NamedTextColor.YELLOW))) + .onClick(ApolloButtonAction.runCommand("/server bedwars")) + .build(); + + InventoryButton soupPvP = InventoryButton.builder() + .id("souppvp") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.LEFT) + .position(HudPosition.of(6, 104)) + .size(InventoryButton.SIZE_WIDE) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(InventoryButton.DEFAULT_BACKGROUND_COLOR) + .borderColor(InventoryButton.DEFAULT_BORDER_COLOR) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder() + .itemName("MUSHROOM_STEW") + .build()) + .append(Component.text("SoupPvP", NamedTextColor.GOLD)) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.of(Component.text("Click to join!", NamedTextColor.YELLOW))) + .onClick(ApolloButtonAction.runCommand("/server souppvp")) + .build(); + + InventoryButton profile = InventoryButton.builder() + .id("profile") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.RIGHT) + .position(HudPosition.of(4, 4)) + .size(InventoryButton.SIZE_MEDIUM) + .shape(ApolloButtonShape.CIRCLE) + .backgroundColor(InventoryButton.DEFAULT_BACKGROUND_COLOR) + .borderColor(InventoryButton.DEFAULT_BORDER_COLOR) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder() + .itemName("PLAYER_HEAD") // use "skull" for legacy with customModelData set to 3 + .profile(Profile.builder() + .id(UUID.fromString("f17627d8-1a97-487b-92ea-c04f413394bd")) + .texture("e3RleHR1cmVzOntTS0lOOnt1cmw6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvOWQ4MjUwNWJjZjNiYTU5YzJiZTdlMmQzNmY0ZTJiZGE4MzZmMmZkMTk0YjYyMTJhMmExYzRiNGEyYTQ3MWUifX19") + .signature("") + .build()) + .build()) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.of( + Component.text(viewer.getName(), NamedTextColor.GOLD), + Component.text("View your stats", NamedTextColor.GRAY))) + .onClick(ApolloButtonAction.runCommand("/profile")) + .build(); + + InventoryButton settings = InventoryButton.builder() + .id("settings") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.RIGHT) + .position(HudPosition.of(48, 4)) + .size(InventoryButton.SIZE_MEDIUM) + .shape(ApolloButtonShape.CIRCLE) + .backgroundColor(new Color(222, 160, 60, 85)) + .borderColor(new Color(255, 218, 150, 140)) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder() + .itemName("COMPARATOR") + .build()) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.of( + Component.text("Settings", NamedTextColor.WHITE), + Component.text("Server preferences", NamedTextColor.GRAY))) + .onClick(ApolloButtonAction.runCommand("/settings")) + .build(); + + InventoryButton changelog = InventoryButton.builder() + .id("changelog") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.RIGHT) + .position(HudPosition.of(6, 52)) + .size(InventoryButton.SIZE_WIDE) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(InventoryButton.DEFAULT_BACKGROUND_COLOR) + .borderColor(InventoryButton.DEFAULT_BORDER_COLOR) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder() + .itemName("WRITABLE_BOOK") + .build()) + .append(Component.text("Changelog")) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.of( + Component.text("🌙 Apollo - v1.2.8", NamedTextColor.GOLD), + Component.empty(), + Component.text("• Released Markers Module", NamedTextColor.GRAY), + Component.text("• Added ALLOW_DIG_AND_USE & DISABLE_BLOCK_MISS_PENALTY", NamedTextColor.GRAY), + Component.text(" options to Combat Module", NamedTextColor.GRAY), + Component.text("• Added configurable Server Link Button placement", NamedTextColor.GRAY), + Component.text("• Added API option to auto-enable Staff Mods", NamedTextColor.GRAY), + Component.text(" when unlocked via the Staff Mod Module", NamedTextColor.GRAY), + Component.text("• Improved performance with various optimizations", NamedTextColor.GRAY), + Component.empty(), + Component.text("Read the full changelog at", NamedTextColor.YELLOW), + Component.text("https://github.com/LunarClient/Apollo/releases/tag/v1.2.8", NamedTextColor.YELLOW))) + .onClick(ApolloButtonAction.openUrl("https://github.com/LunarClient/Apollo/releases/tag/v1.2.8")) + .build(); + + inventoryModule.displayInventoryButtons(apolloPlayer, Arrays.asList(practice, factions, bedWars, + soupPvP, profile, settings, changelog)); + }); + } + + private HubLayout() { + } + +} diff --git a/example/bukkit/api/src/main/java/com/lunarclient/apollo/example/api/module/inventorybuttons/MenuLayout.java b/example/bukkit/api/src/main/java/com/lunarclient/apollo/example/api/module/inventorybuttons/MenuLayout.java new file mode 100644 index 00000000..8bb5dace --- /dev/null +++ b/example/bukkit/api/src/main/java/com/lunarclient/apollo/example/api/module/inventorybuttons/MenuLayout.java @@ -0,0 +1,282 @@ +/* + * This file is part of Apollo, licensed under the MIT License. + * + * Copyright (c) 2026 Moonsworth + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +package com.lunarclient.apollo.example.api.module.inventorybuttons; + +import com.lunarclient.apollo.Apollo; +import com.lunarclient.apollo.common.button.ApolloButtonShape; +import com.lunarclient.apollo.common.button.ApolloButtonTooltip; +import com.lunarclient.apollo.common.button.action.ApolloButtonAction; +import com.lunarclient.apollo.common.button.content.ApolloButtonContent; +import com.lunarclient.apollo.common.button.content.ApolloButtonContentPart; +import com.lunarclient.apollo.common.icon.ItemStackIcon; +import com.lunarclient.apollo.common.location.HudPosition; +import com.lunarclient.apollo.common.profile.Profile; +import com.lunarclient.apollo.module.inventory.InventoryButton; +import com.lunarclient.apollo.module.inventory.InventoryButtonBox; +import com.lunarclient.apollo.module.inventory.InventoryModule; +import com.lunarclient.apollo.module.inventory.InventoryType; +import java.awt.Color; +import java.time.Duration; +import java.util.Arrays; +import java.util.UUID; +import net.kyori.adventure.text.Component; +import net.kyori.adventure.text.format.NamedTextColor; +import org.bukkit.entity.Player; + +public final class MenuLayout { + + public static void display(InventoryModule inventoryModule, Player viewer) { + // Live parts refresh automatically only while the Apollo config enables + // modules.inventory.buttons.live-broadcast (see the inventory module docs) + Apollo.getPlayerManager().getPlayer(viewer.getUniqueId()).ifPresent(apolloPlayer -> { + InventoryButton shop = InventoryButton.builder() + .id("shop") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.LEFT) + .position(HudPosition.of(4, 4)) + .size(InventoryButton.SIZE_MEDIUM) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(InventoryButton.DEFAULT_BACKGROUND_COLOR) + .borderColor(InventoryButton.DEFAULT_BORDER_COLOR) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder() + .itemName("EMERALD") + .build()) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.of( + Component.text("Shop", NamedTextColor.GREEN), + Component.text("Browse categories and buy items", NamedTextColor.GRAY), + Component.text("Click to open", NamedTextColor.YELLOW))) + .onClick(ApolloButtonAction.runCommand("/shop")) + .build(); + + InventoryButton spawn = InventoryButton.builder() + .id("spawn") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.LEFT) + .position(HudPosition.of(48, 4)) + .size(InventoryButton.SIZE_MEDIUM) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(InventoryButton.DEFAULT_BACKGROUND_COLOR) + .borderColor(InventoryButton.DEFAULT_BORDER_COLOR) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder() + .itemName("RED_BED") + .build()) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.of( + Component.text("Spawn", NamedTextColor.AQUA), + Component.text("Teleport back to spawn", NamedTextColor.GRAY), + Component.text("Click to teleport", NamedTextColor.YELLOW))) + .onClick(ApolloButtonAction.runCommand("/spawn")) + .build(); + + InventoryButton warps = InventoryButton.builder() + .id("warps") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.LEFT) + .position(HudPosition.of(4, 48)) + .size(InventoryButton.SIZE_MEDIUM) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(InventoryButton.DEFAULT_BACKGROUND_COLOR) + .borderColor(InventoryButton.DEFAULT_BORDER_COLOR) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder() + .itemName("COMPASS") + .build()) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.of( + Component.text("Warps", NamedTextColor.AQUA), + Component.text("Browse public warps", NamedTextColor.GRAY), + Component.text("Click to teleport", NamedTextColor.YELLOW))) + .onClick(ApolloButtonAction.runCommand("/warps")) + .build(); + + InventoryButton enderChest = InventoryButton.builder() + .id("enderchest") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.LEFT) + .position(HudPosition.of(48, 48)) + .size(InventoryButton.SIZE_MEDIUM) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(InventoryButton.DEFAULT_BACKGROUND_COLOR) + .borderColor(InventoryButton.DEFAULT_BORDER_COLOR) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder() + .itemName("ENDER_CHEST") + .build()) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.of( + Component.text("Ender Chest", NamedTextColor.LIGHT_PURPLE), + Component.text("Open your personal storage", NamedTextColor.GRAY), + Component.text("Click to open", NamedTextColor.YELLOW))) + .onClick(ApolloButtonAction.runCommand("/enderchest")) + .build(); + + InventoryButton balance = InventoryButton.builder() + .id("balance") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.LEFT) + .position(HudPosition.of(6, 92)) + .size(InventoryButton.SIZE_WIDE) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(InventoryButton.DEFAULT_BACKGROUND_COLOR) + .borderColor(InventoryButton.DEFAULT_BORDER_COLOR) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder() + .itemName("GOLD_INGOT") + .build()) + .append(ApolloButtonContentPart.live(apolloViewer -> Component.text("$" + + String.format("%,d", getBalance(apolloViewer.getUniqueId())), NamedTextColor.GOLD), + Duration.ofMillis(2500L))) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.of(Component.text("Your balance", NamedTextColor.GOLD))) + .build(); + + InventoryButton profile = InventoryButton.builder() + .id("profile") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.RIGHT) + .position(HudPosition.of(4, 4)) + .size(InventoryButton.SIZE_MEDIUM) + .shape(ApolloButtonShape.CIRCLE) + .backgroundColor(InventoryButton.DEFAULT_BACKGROUND_COLOR) + .borderColor(InventoryButton.DEFAULT_BORDER_COLOR) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder() + .itemName("PLAYER_HEAD") // use "skull" for legacy with customModelData set to 3 + .profile(Profile.builder() + .id(UUID.fromString("f17627d8-1a97-487b-92ea-c04f413394bd")) + .texture("e3RleHR1cmVzOntTS0lOOnt1cmw6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvOWQ4MjUwNWJjZjNiYTU5YzJiZTdlMmQzNmY0ZTJiZGE4MzZmMmZkMTk0YjYyMTJhMmExYzRiNGEyYTQ3MWUifX19") + .signature("") + .build()) + .build()) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.of( + Component.text(viewer.getName(), NamedTextColor.GOLD), + Component.text("View your stats", NamedTextColor.GRAY))) + .onClick(ApolloButtonAction.runCommand("/profile")) + .build(); + + InventoryButton settings = InventoryButton.builder() + .id("settings") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.RIGHT) + .position(HudPosition.of(48, 4)) + .size(InventoryButton.SIZE_MEDIUM) + .shape(ApolloButtonShape.CIRCLE) + .backgroundColor(new Color(222, 160, 60, 85)) + .borderColor(new Color(255, 218, 150, 140)) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder() + .itemName("COMPARATOR") + .build()) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.of( + Component.text("Settings", NamedTextColor.WHITE), + Component.text("Server preferences", NamedTextColor.GRAY))) + .onClick(ApolloButtonAction.runCommand("/settings")) + .build(); + + InventoryButton vote = InventoryButton.builder() + .id("vote") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.RIGHT) + .position(HudPosition.of(6, 52)) + .size(InventoryButton.SIZE_WIDE) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(new Color(34, 204, 68, 64)) + .borderColor(new Color(190, 255, 205, 110)) + .hoveredBackgroundColor(new Color(34, 204, 68, 130)) + .hoveredBorderColor(new Color(190, 255, 205, 210)) + .content(ApolloButtonContent.builder() + .append(Component.text("Vote")) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.of( + Component.text("Vote", NamedTextColor.GREEN), + Component.text("Vote daily for rewards", NamedTextColor.GRAY))) + .onClick(ApolloButtonAction.openUrl("https://example.com/vote")) + .build(); + + InventoryButton discord = InventoryButton.builder() + .id("discord") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.RIGHT) + .position(HudPosition.of(6, 84)) + .size(InventoryButton.SIZE_WIDE) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(new Color(88, 101, 242, 90)) + .borderColor(new Color(150, 160, 250, 140)) + .content(ApolloButtonContent.builder() + .append(Component.text("Discord")) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.of( + Component.text("Discord", NamedTextColor.BLUE), + Component.text("Join our community", NamedTextColor.GRAY))) + .onClick(ApolloButtonAction.openUrl("https://lunarclient.dev/discord")) + .build(); + + InventoryButton lobby = InventoryButton.builder() + .id("lobby") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.RIGHT) + .position(HudPosition.of(6, 136)) + .size(InventoryButton.SIZE_WIDE) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(new Color(224, 64, 64, 128)) + .borderColor(new Color(255, 200, 200, 140)) + .content(ApolloButtonContent.builder() + .append(Component.text("Back to Lobby")) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.of( + Component.text("Back to Lobby", NamedTextColor.RED), + Component.text("Return to the main lobby", NamedTextColor.GRAY))) + .onClick(ApolloButtonAction.runCommand("/lobby")) + .build(); + + inventoryModule.displayInventoryButtons(apolloPlayer, Arrays.asList(shop, spawn, warps, enderChest, balance, + profile, settings, vote, discord, lobby)); + }); + } + + // Demo economy: replace with your economy plugin lookup (e.g. Vault) + private static long getBalance(UUID playerIdentifier) { + long drift = (System.currentTimeMillis() / 10_000L) % 250L; + return 1_000L + Math.abs(playerIdentifier.hashCode() % 4_000) + drift; + } + + private MenuLayout() { + } + +} diff --git a/example/bukkit/api/src/main/java/com/lunarclient/apollo/example/api/module/inventorybuttons/MinigameLayout.java b/example/bukkit/api/src/main/java/com/lunarclient/apollo/example/api/module/inventorybuttons/MinigameLayout.java new file mode 100644 index 00000000..dc1633db --- /dev/null +++ b/example/bukkit/api/src/main/java/com/lunarclient/apollo/example/api/module/inventorybuttons/MinigameLayout.java @@ -0,0 +1,244 @@ +/* + * This file is part of Apollo, licensed under the MIT License. + * + * Copyright (c) 2026 Moonsworth + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +package com.lunarclient.apollo.example.api.module.inventorybuttons; + +import com.lunarclient.apollo.Apollo; +import com.lunarclient.apollo.common.button.ApolloButtonShape; +import com.lunarclient.apollo.common.button.ApolloButtonTooltip; +import com.lunarclient.apollo.common.button.action.ApolloButtonAction; +import com.lunarclient.apollo.common.button.action.ApolloButtonClientAction; +import com.lunarclient.apollo.common.button.content.ApolloButtonContent; +import com.lunarclient.apollo.common.icon.ItemStackIcon; +import com.lunarclient.apollo.common.location.HudPosition; +import com.lunarclient.apollo.common.profile.Profile; +import com.lunarclient.apollo.mods.impl.ModMinimap; +import com.lunarclient.apollo.mods.impl.ModWaypoints; +import com.lunarclient.apollo.module.inventory.InventoryButton; +import com.lunarclient.apollo.module.inventory.InventoryButtonBox; +import com.lunarclient.apollo.module.inventory.InventoryModule; +import com.lunarclient.apollo.module.inventory.InventoryType; +import com.lunarclient.apollo.module.modsetting.ModSettingModule; +import com.lunarclient.apollo.player.ApolloPlayer; +import java.awt.Color; +import java.time.Duration; +import java.util.Arrays; +import java.util.UUID; +import net.kyori.adventure.text.Component; +import net.kyori.adventure.text.format.NamedTextColor; +import org.bukkit.Bukkit; +import org.bukkit.Statistic; +import org.bukkit.entity.Player; + +public final class MinigameLayout { + + public static void display(InventoryModule inventoryModule, Player viewer) { + // Live parts refresh automatically only while the Apollo config enables + // modules.inventory.buttons.live-broadcast (see the inventory module docs) + Apollo.getPlayerManager().getPlayer(viewer.getUniqueId()).ifPresent(apolloPlayer -> { + InventoryButton mapInfo = InventoryButton.builder() + .id("map-info") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.LEFT) + .position(HudPosition.of(6, 8)) + .size(InventoryButton.SIZE_WIDE) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(InventoryButton.DEFAULT_BACKGROUND_COLOR) + .borderColor(InventoryButton.DEFAULT_BORDER_COLOR) + .content(ApolloButtonContent.builder() + .append(Component.text("Map: Apollo", NamedTextColor.AQUA)) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.of( + Component.text("Built by the Lunar Client Team"), + Component.text("Released in 2024", NamedTextColor.GRAY))) + .build(); + + InventoryButton kills = InventoryButton.builder() + .id("kills") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.LEFT) + .position(HudPosition.of(6, 40)) + .size(InventoryButton.SIZE_WIDE) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(InventoryButton.DEFAULT_BACKGROUND_COLOR) + .borderColor(InventoryButton.DEFAULT_BORDER_COLOR) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder() + .itemName("IRON_SWORD") + .build()) + .append(apolloViewer -> Component.text("Kills: ", NamedTextColor.GRAY) + .append(Component.text(getKills(apolloViewer), NamedTextColor.RED)), + Duration.ofMillis(2500L)) + .scale(1.0F) + .build()) + .build(); + + InventoryButton lobby = InventoryButton.builder() + .id("lobby") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.RIGHT) + .position(HudPosition.of(6, 136)) + .size(InventoryButton.SIZE_WIDE) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(new Color(224, 64, 64, 128)) + .borderColor(new Color(255, 200, 200, 140)) + .content(ApolloButtonContent.builder() + .append(Component.text("Back to Lobby")) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.of( + Component.text("Back to Lobby", NamedTextColor.RED), + Component.text("Return to the main lobby", NamedTextColor.GRAY))) + .onClick(ApolloButtonAction.runCommand("/lobby")) + .build(); + + InventoryButton profile = InventoryButton.builder() + .id("profile") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.RIGHT) + .position(HudPosition.of(4, 4)) + .size(InventoryButton.SIZE_MEDIUM) + .shape(ApolloButtonShape.CIRCLE) + .backgroundColor(InventoryButton.DEFAULT_BACKGROUND_COLOR) + .borderColor(InventoryButton.DEFAULT_BORDER_COLOR) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder() + .itemName("PLAYER_HEAD") // use "skull" for legacy with customModelData set to 3 + .profile(Profile.builder() + .id(UUID.fromString("f17627d8-1a97-487b-92ea-c04f413394bd")) + .texture("e3RleHR1cmVzOntTS0lOOnt1cmw6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvOWQ4MjUwNWJjZjNiYTU5YzJiZTdlMmQzNmY0ZTJiZGE4MzZmMmZkMTk0YjYyMTJhMmExYzRiNGEyYTQ3MWUifX19") + .signature("") + .build()) + .build()) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.of( + Component.text(viewer.getName(), NamedTextColor.GOLD), + Component.text("View your stats", NamedTextColor.GRAY))) + .onClick(ApolloButtonAction.runCommand("/profile")) + .build(); + + InventoryButton settings = InventoryButton.builder() + .id("settings") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.RIGHT) + .position(HudPosition.of(48, 4)) + .size(InventoryButton.SIZE_MEDIUM) + .shape(ApolloButtonShape.CIRCLE) + .backgroundColor(new Color(222, 160, 60, 85)) + .borderColor(new Color(255, 218, 150, 140)) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder() + .itemName("COMPARATOR") + .build()) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.of( + Component.text("Settings", NamedTextColor.WHITE), + Component.text("Server preferences", NamedTextColor.GRAY))) + .onClick(ApolloButtonAction.runCommand("/settings")) + .build(); + + ModSettingModule modSettingModule = Apollo.getModuleManager().getModule(ModSettingModule.class); + boolean minimapEnabled = modSettingModule.getStatus(apolloPlayer, ModMinimap.ENABLED); + boolean waypointsEnabled = modSettingModule.getStatus(apolloPlayer, ModWaypoints.ENABLED); + + InventoryButton.InventoryButtonBuilder showMapBuilder = InventoryButton.builder() + .id("show-map") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.RIGHT) + .position(HudPosition.of(6, 52)) + .size(InventoryButton.SIZE_WIDE) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder() + .itemName("FILLED_MAP") + .build()) + .append(Component.text("Show Map")) + .scale(1.0F) + .build()); + + if (minimapEnabled) { + showMapBuilder + .backgroundColor(InventoryButton.DEFAULT_BACKGROUND_COLOR) + .borderColor(InventoryButton.DEFAULT_BORDER_COLOR) + .tooltip(ApolloButtonTooltip.of( + Component.text("Show Map", NamedTextColor.AQUA), + Component.text("Open the fullscreen minimap view", NamedTextColor.GRAY))) + .onClick(ApolloButtonAction.clientAction(ApolloButtonClientAction.OPEN_MINIMAP_VIEW)); + } else { + showMapBuilder + .backgroundColor(new Color(224, 64, 64, 128)) + .borderColor(new Color(255, 200, 200, 140)) + .tooltip(ApolloButtonTooltip.of(Component.text("Minimap mod must be enabled", NamedTextColor.RED))); + } + + InventoryButton showMap = showMapBuilder.build(); + + InventoryButton.InventoryButtonBuilder waypointsBuilder = InventoryButton.builder() + .id("waypoints") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.RIGHT) + .position(HudPosition.of(6, 84)) + .size(InventoryButton.SIZE_WIDE) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder() + .itemName("LODESTONE") + .build()) + .append(Component.text("Waypoints")) + .scale(1.0F) + .build()); + + if (waypointsEnabled) { + waypointsBuilder + .backgroundColor(InventoryButton.DEFAULT_BACKGROUND_COLOR) + .borderColor(InventoryButton.DEFAULT_BORDER_COLOR) + .tooltip(ApolloButtonTooltip.of( + Component.text("Waypoints", NamedTextColor.GOLD), + Component.text("Manage your waypoints", NamedTextColor.GRAY))) + .onClick(ApolloButtonAction.clientAction(ApolloButtonClientAction.OPEN_WAYPOINTS_MENU)); + } else { + waypointsBuilder + .backgroundColor(new Color(224, 64, 64, 128)) + .borderColor(new Color(255, 200, 200, 140)) + .tooltip(ApolloButtonTooltip.of(Component.text("Waypoints mod must be enabled", NamedTextColor.RED))); + } + + InventoryButton waypoints = waypointsBuilder.build(); + + inventoryModule.displayInventoryButtons(apolloPlayer, Arrays.asList(mapInfo, kills, lobby, + profile, settings, showMap, waypoints)); + }); + } + + private static int getKills(ApolloPlayer apolloViewer) { + Player player = Bukkit.getPlayer(apolloViewer.getUniqueId()); + return player != null ? player.getStatistic(Statistic.PLAYER_KILLS) : 0; + } + + private MinigameLayout() { + } + +} diff --git a/example/bukkit/api/src/main/java/com/lunarclient/apollo/example/api/module/inventorybuttons/StaffLayout.java b/example/bukkit/api/src/main/java/com/lunarclient/apollo/example/api/module/inventorybuttons/StaffLayout.java new file mode 100644 index 00000000..71922aca --- /dev/null +++ b/example/bukkit/api/src/main/java/com/lunarclient/apollo/example/api/module/inventorybuttons/StaffLayout.java @@ -0,0 +1,327 @@ +/* + * This file is part of Apollo, licensed under the MIT License. + * + * Copyright (c) 2026 Moonsworth + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +package com.lunarclient.apollo.example.api.module.inventorybuttons; + +import com.lunarclient.apollo.Apollo; +import com.lunarclient.apollo.common.button.ApolloButtonShape; +import com.lunarclient.apollo.common.button.ApolloButtonTooltip; +import com.lunarclient.apollo.common.button.action.ApolloButtonAction; +import com.lunarclient.apollo.common.button.content.ApolloButtonContent; +import com.lunarclient.apollo.common.icon.ItemStackIcon; +import com.lunarclient.apollo.common.location.HudPosition; +import com.lunarclient.apollo.example.util.ServerStatsUtil; +import com.lunarclient.apollo.module.inventory.InventoryButton; +import com.lunarclient.apollo.module.inventory.InventoryButtonBox; +import com.lunarclient.apollo.module.inventory.InventoryModule; +import com.lunarclient.apollo.module.inventory.InventoryType; +import java.time.Duration; +import java.time.LocalTime; +import java.time.format.DateTimeFormatter; +import java.util.Arrays; +import java.util.List; +import net.kyori.adventure.text.Component; +import net.kyori.adventure.text.format.NamedTextColor; +import net.kyori.adventure.text.format.TextDecoration; +import org.bukkit.Bukkit; +import org.bukkit.entity.Player; + +public final class StaffLayout { + + private static final DateTimeFormatter TIME_FORMAT = DateTimeFormatter.ofPattern("HH:mm:ss"); + + public static void display(InventoryModule inventoryModule, Player viewer) { + // Live parts refresh automatically only while the Apollo config enables + // modules.inventory.buttons.live-broadcast (see the inventory module docs) + Apollo.getPlayerManager().getPlayer(viewer.getUniqueId()).ifPresent(apolloPlayer -> { + InventoryButton players = InventoryButton.builder() + .id("players") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.LEFT) + .position(HudPosition.of(6, 8)) + .size(InventoryButton.SIZE_WIDE) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(InventoryButton.DEFAULT_BACKGROUND_COLOR) + .borderColor(InventoryButton.DEFAULT_BORDER_COLOR) + .content(ApolloButtonContent.builder() + .append(apolloViewer -> Component.text("Players: ", NamedTextColor.GRAY) + .append(Component.text(Bukkit.getOnlinePlayers().size(), NamedTextColor.GREEN)), + Duration.ofSeconds(1)) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.live(apolloViewer -> Arrays.asList( + Component.text("Players currently online", NamedTextColor.GRAY), + Component.empty(), refreshedLine()), + Duration.ofSeconds(1))) + .build(); + + InventoryButton tps = InventoryButton.builder() + .id("tps") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.LEFT) + .position(HudPosition.of(6, 40)) + .size(InventoryButton.SIZE_WIDE) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(InventoryButton.DEFAULT_BACKGROUND_COLOR) + .borderColor(InventoryButton.DEFAULT_BORDER_COLOR) + .content(ApolloButtonContent.builder() + .append(apolloViewer -> tpsContent(), Duration.ofSeconds(1)) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.live(apolloViewer -> tpsTooltip(), Duration.ofSeconds(1))) + .build(); + + InventoryButton cpu = InventoryButton.builder() + .id("cpu") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.LEFT) + .position(HudPosition.of(6, 72)) + .size(InventoryButton.SIZE_WIDE) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(InventoryButton.DEFAULT_BACKGROUND_COLOR) + .borderColor(InventoryButton.DEFAULT_BORDER_COLOR) + .content(ApolloButtonContent.builder() + .append(apolloViewer -> cpuContent(), Duration.ofSeconds(1)) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.live(apolloViewer -> cpuTooltip(), Duration.ofSeconds(1))) + .build(); + + InventoryButton ram = InventoryButton.builder() + .id("ram") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.LEFT) + .position(HudPosition.of(6, 104)) + .size(InventoryButton.SIZE_WIDE) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(InventoryButton.DEFAULT_BACKGROUND_COLOR) + .borderColor(InventoryButton.DEFAULT_BORDER_COLOR) + .content(ApolloButtonContent.builder() + .append(apolloViewer -> ramContent(), Duration.ofSeconds(1)) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.live(apolloViewer -> ramTooltip(), Duration.ofSeconds(1))) + .build(); + + InventoryButton survival = InventoryButton.builder() + .id("survival") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.RIGHT) + .position(HudPosition.of(6, 8)) + .size(InventoryButton.SIZE_WIDE) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(InventoryButton.DEFAULT_BACKGROUND_COLOR) + .borderColor(InventoryButton.DEFAULT_BORDER_COLOR) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder() + .itemName("IRON_SWORD") + .build()) + .append(Component.text("Survival")) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.of(Component.text("Click to switch!", NamedTextColor.YELLOW))) + .onClick(ApolloButtonAction.runCommand("/gamemode survival")) + .build(); + + InventoryButton creative = InventoryButton.builder() + .id("creative") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.RIGHT) + .position(HudPosition.of(6, 40)) + .size(InventoryButton.SIZE_WIDE) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(InventoryButton.DEFAULT_BACKGROUND_COLOR) + .borderColor(InventoryButton.DEFAULT_BORDER_COLOR) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder() + .itemName("GRASS_BLOCK") + .build()) + .append(Component.text("Creative")) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.of(Component.text("Click to switch!", NamedTextColor.YELLOW))) + .onClick(ApolloButtonAction.runCommand("/gamemode creative")) + .build(); + + InventoryButton adventure = InventoryButton.builder() + .id("adventure") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.RIGHT) + .position(HudPosition.of(6, 72)) + .size(InventoryButton.SIZE_WIDE) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(InventoryButton.DEFAULT_BACKGROUND_COLOR) + .borderColor(InventoryButton.DEFAULT_BORDER_COLOR) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder() + .itemName("FILLED_MAP") + .build()) + .append(Component.text("Adventure")) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.of(Component.text("Click to switch!", NamedTextColor.YELLOW))) + .onClick(ApolloButtonAction.runCommand("/gamemode adventure")) + .build(); + + InventoryButton spectator = InventoryButton.builder() + .id("spectator") + .inventoryType(InventoryType.PLAYER) + .box(InventoryButtonBox.RIGHT) + .position(HudPosition.of(6, 104)) + .size(InventoryButton.SIZE_WIDE) + .shape(ApolloButtonShape.ROUNDED_SQUARE) + .backgroundColor(InventoryButton.DEFAULT_BACKGROUND_COLOR) + .borderColor(InventoryButton.DEFAULT_BORDER_COLOR) + .content(ApolloButtonContent.builder() + .append(ItemStackIcon.builder() + .itemName("ENDER_EYE") + .build()) + .append(Component.text("Spectator")) + .scale(1.0F) + .build()) + .tooltip(ApolloButtonTooltip.of(Component.text("Click to switch!", NamedTextColor.YELLOW))) + .onClick(ApolloButtonAction.runCommand("/gamemode spectator")) + .build(); + + inventoryModule.displayInventoryButtons(apolloPlayer, Arrays.asList(players, tps, cpu, ram, + survival, creative, adventure, spectator)); + }); + } + + private static Component tpsContent() { + double[] tps = ServerStatsUtil.getTps(); + if (tps == null || tps.length == 0) { + return Component.text("TPS: N/A", NamedTextColor.GRAY); + } + + double recent = Math.min(20.0D, tps[0]); + return Component.text("TPS: ", NamedTextColor.GRAY) + .append(Component.text(String.format("%.1f", recent), tpsColor(recent))); + } + + private static List tpsTooltip() { + double[] tps = ServerStatsUtil.getTps(); + if (tps == null || tps.length < 3) { + return Arrays.asList( + Component.text("TPS averages require a Paper based server", NamedTextColor.GRAY), + Component.empty(), + refreshedLine()); + } + + return Arrays.asList( + tpsAverageLine("1m", tps[0]), + tpsAverageLine("5m", tps[1]), + tpsAverageLine("15m", tps[2]), + Component.empty(), + refreshedLine()); + } + + private static Component tpsAverageLine(String window, double average) { + double tps = Math.min(20.0D, average); + return Component.text(window + ": ", NamedTextColor.GRAY) + .append(Component.text(String.format("%.2f", tps), tpsColor(tps))); + } + + private static NamedTextColor tpsColor(double tps) { + if (tps >= 18.0D) { + return NamedTextColor.GREEN; + } + + return tps >= 15.0D ? NamedTextColor.YELLOW : NamedTextColor.RED; + } + + private static Component cpuContent() { + double load = ServerStatsUtil.getSystemLoadAverage(); + if (load < 0.0D) { + return Component.text("CPU: N/A", NamedTextColor.GRAY); + } + + return Component.text("CPU: ", NamedTextColor.GRAY) + .append(Component.text(String.format("%.2f", load), cpuColor(load))); + } + + private static List cpuTooltip() { + double load = ServerStatsUtil.getSystemLoadAverage(); + if (load < 0.0D) { + return Arrays.asList( + Component.text("The system load average is unavailable", NamedTextColor.GRAY), + Component.empty(), + refreshedLine()); + } + + int cores = ServerStatsUtil.getAvailableProcessors(); + double perCore = load * 100.0D / cores; + return Arrays.asList( + Component.text("System load average (last minute)", NamedTextColor.GRAY), + Component.text("Cores: ", NamedTextColor.GRAY) + .append(Component.text(cores, NamedTextColor.WHITE)), + Component.text("Per core: ", NamedTextColor.GRAY) + .append(Component.text(String.format("%.0f%%", perCore), cpuColor(load))), + Component.empty(), + refreshedLine()); + } + + private static NamedTextColor cpuColor(double load) { + double perCore = load / ServerStatsUtil.getAvailableProcessors(); + if (perCore < 0.5D) { + return NamedTextColor.GREEN; + } + + return perCore < 1.0D ? NamedTextColor.YELLOW : NamedTextColor.RED; + } + + private static Component ramContent() { + long used = ServerStatsUtil.getUsedRamMb(); + long max = ServerStatsUtil.getMaxRamMb(); + long percent = max <= 0 ? 0 : used * 100 / max; + + return Component.text("RAM: ", NamedTextColor.GRAY) + .append(Component.text(percent + "%", ramColor(percent))); + } + + private static List ramTooltip() { + return Arrays.asList( + Component.text("Used: ", NamedTextColor.GRAY) + .append(Component.text(ServerStatsUtil.getUsedRamMb() + " MB", NamedTextColor.WHITE)), + Component.text("Max: ", NamedTextColor.GRAY) + .append(Component.text(ServerStatsUtil.getMaxRamMb() + " MB", NamedTextColor.WHITE)), + Component.empty(), + refreshedLine()); + } + + private static NamedTextColor ramColor(long percent) { + if (percent < 60) { + return NamedTextColor.GREEN; + } + + return percent < 85 ? NamedTextColor.YELLOW : NamedTextColor.RED; + } + + private static Component refreshedLine() { + return Component.text("Updated at " + LocalTime.now().format(TIME_FORMAT), NamedTextColor.YELLOW, TextDecoration.ITALIC); + } + + private StaffLayout() { + } + +} diff --git a/example/bukkit/api/src/main/resources/plugin.yml b/example/bukkit/api/src/main/resources/plugin.yml index 9ba142c0..9ac047c9 100644 --- a/example/bukkit/api/src/main/resources/plugin.yml +++ b/example/bukkit/api/src/main/resources/plugin.yml @@ -1,6 +1,6 @@ name: Apollo-API-Example main: com.lunarclient.apollo.example.api.ApolloApiExamplePlatform -version: 1.2.8 +version: 1.2.9 author: Moonsworth softdepend: [ Apollo-Bukkit, Apollo-Folia ] api-version: 1.13 @@ -36,6 +36,8 @@ commands: description: "Glint!" glow: description: "Glow!" + heightlimit: + description: "Height Limit!" hologram: description: "Holograms!" inventory: diff --git a/example/bukkit/common/src/main/java/com/lunarclient/apollo/example/ApolloExamplePlugin.java b/example/bukkit/common/src/main/java/com/lunarclient/apollo/example/ApolloExamplePlugin.java index c39d80f2..a116a259 100644 --- a/example/bukkit/common/src/main/java/com/lunarclient/apollo/example/ApolloExamplePlugin.java +++ b/example/bukkit/common/src/main/java/com/lunarclient/apollo/example/ApolloExamplePlugin.java @@ -34,6 +34,7 @@ import com.lunarclient.apollo.example.command.EntityCommand; import com.lunarclient.apollo.example.command.GlintCommand; import com.lunarclient.apollo.example.command.GlowCommand; +import com.lunarclient.apollo.example.command.HeightLimitCommand; import com.lunarclient.apollo.example.command.HologramCommand; import com.lunarclient.apollo.example.command.InventoryCommand; import com.lunarclient.apollo.example.command.LimbCommand; @@ -68,6 +69,7 @@ import com.lunarclient.apollo.example.module.impl.EntityExample; import com.lunarclient.apollo.example.module.impl.GlintExample; import com.lunarclient.apollo.example.module.impl.GlowExample; +import com.lunarclient.apollo.example.module.impl.HeightLimitExample; import com.lunarclient.apollo.example.module.impl.HologramExample; import com.lunarclient.apollo.example.module.impl.InventoryExample; import com.lunarclient.apollo.example.module.impl.LimbExample; @@ -91,6 +93,7 @@ import com.lunarclient.apollo.example.module.impl.VignetteExample; import com.lunarclient.apollo.example.module.impl.WaypointExample; import com.lunarclient.apollo.example.nms.NpcManager; +import com.lunarclient.apollo.example.nms.PlayerNpc; import lombok.Getter; import lombok.Setter; import org.bukkit.plugin.java.JavaPlugin; @@ -114,6 +117,7 @@ public abstract class ApolloExamplePlugin extends JavaPlugin { private EntityExample entityExample; private GlintExample glintExample; private GlowExample glowExample; + private HeightLimitExample heightLimitExample; private HologramExample hologramExample; private InventoryExample inventoryExample; private LimbExample limbExample; @@ -150,6 +154,13 @@ public void onEnable() { this.registerCommands(); this.registerModuleExamples(); this.registerListeners(); + + this.npcManager.addViewerListener((viewer, npc) -> { + PlayerNpc.ActiveEmote emote = npc.getActiveEmote(); + if (emote != null && this.cosmeticExample != null) { + this.cosmeticExample.startNpcEmoteToViewer(viewer, npc.getUuid(), emote.getEmoteId(), emote.getMetadata()); + } + }); } @Override @@ -173,6 +184,7 @@ private void registerCommonCommands() { this.getCommand("entity").setExecutor(new EntityCommand()); this.getCommand("glint").setExecutor(new GlintCommand()); this.getCommand("glow").setExecutor(new GlowCommand()); + this.getCommand("heightlimit").setExecutor(new HeightLimitCommand()); this.getCommand("hologram").setExecutor(new HologramCommand()); this.getCommand("inventory").setExecutor(new InventoryCommand()); this.getCommand("limb").setExecutor(new LimbCommand()); @@ -199,7 +211,6 @@ private void registerCommonCommands() { private void registerCommonModulesExamples() { this.glintExample = new GlintExample(); - this.inventoryExample = new InventoryExample(); this.saturationExample = new SaturationExample(); } diff --git a/example/bukkit/common/src/main/java/com/lunarclient/apollo/example/command/ChatCommand.java b/example/bukkit/common/src/main/java/com/lunarclient/apollo/example/command/ChatCommand.java index 140060cb..871f0f3b 100644 --- a/example/bukkit/common/src/main/java/com/lunarclient/apollo/example/command/ChatCommand.java +++ b/example/bukkit/common/src/main/java/com/lunarclient/apollo/example/command/ChatCommand.java @@ -43,7 +43,7 @@ public boolean onCommand(@NotNull CommandSender sender, @NotNull Command command Player player = (Player) sender; if (args.length != 1) { - player.sendMessage("Usage: /chat "); + this.sendUsage(player); return true; } @@ -62,12 +62,52 @@ public boolean onCommand(@NotNull CommandSender sender, @NotNull Command command break; } + case "displaychannels": { + chatExample.displayChannelsLayoutExample(player); + player.sendMessage("Displaying channel chat buttons...."); + break; + } + + case "displaystaff": { + chatExample.displayStaffChatLayoutExample(player); + player.sendMessage("Displaying staff chat buttons...."); + break; + } + + case "updatebutton": { + chatExample.updateChatButtonExample(player); + player.sendMessage("Updating the public chat button...."); + break; + } + + case "removebutton": { + chatExample.removeChatButtonExample(player); + player.sendMessage("Removing the party chat button...."); + break; + } + + case "resetbuttons": { + chatExample.resetChatButtonsExample(player); + player.sendMessage("Resetting chat buttons...."); + break; + } + default: { - player.sendMessage("Usage: /chat "); + this.sendUsage(player); break; } } return true; } + + private void sendUsage(Player player) { + player.sendMessage("Usage: /chat display"); + player.sendMessage("Usage: /chat remove"); + player.sendMessage("Usage: /chat displayChannels"); + player.sendMessage("Usage: /chat displayStaff"); + player.sendMessage("Usage: /chat updateButton"); + player.sendMessage("Usage: /chat removeButton"); + player.sendMessage("Usage: /chat resetButtons"); + } } diff --git a/example/bukkit/common/src/main/java/com/lunarclient/apollo/example/command/CosmeticCommand.java b/example/bukkit/common/src/main/java/com/lunarclient/apollo/example/command/CosmeticCommand.java index ad8057e8..92817e47 100644 --- a/example/bukkit/common/src/main/java/com/lunarclient/apollo/example/command/CosmeticCommand.java +++ b/example/bukkit/common/src/main/java/com/lunarclient/apollo/example/command/CosmeticCommand.java @@ -222,7 +222,12 @@ private boolean handleEmote(Player player, CosmeticExample example, String[] arg } } - example.startNpcEmoteInternal(player, uuid, emoteId, metadata); + example.startNpcEmoteInternal(uuid, emoteId, metadata); + + int emoteMetadata = metadata; + ApolloExamplePlugin.getInstance().getNpcManager().findByUuid(uuid) + .ifPresent(npc -> npc.setActiveEmote(new PlayerNpc.ActiveEmote(emoteId, emoteMetadata))); + player.sendMessage(ChatColor.GREEN + "Started emote " + emoteId + " on NPC " + args[2]); break; } @@ -238,13 +243,22 @@ private boolean handleEmote(Player player, CosmeticExample example, String[] arg return true; } - example.stopNpcEmoteExample(player, uuid); + example.stopNpcEmoteInternal(uuid); + + ApolloExamplePlugin.getInstance().getNpcManager().findByUuid(uuid) + .ifPresent(npc -> npc.setActiveEmote(null)); + player.sendMessage(ChatColor.GREEN + "Stopped emote on NPC " + args[2]); break; } case "reset": { example.resetNpcEmotesExample(); + + for (PlayerNpc npc : ApolloExamplePlugin.getInstance().getNpcManager().getNpcs()) { + npc.setActiveEmote(null); + } + player.sendMessage(ChatColor.GREEN + "Reset all NPC emotes"); break; } diff --git a/example/bukkit/common/src/main/java/com/lunarclient/apollo/example/command/HeightLimitCommand.java b/example/bukkit/common/src/main/java/com/lunarclient/apollo/example/command/HeightLimitCommand.java new file mode 100644 index 00000000..7a4a3e68 --- /dev/null +++ b/example/bukkit/common/src/main/java/com/lunarclient/apollo/example/command/HeightLimitCommand.java @@ -0,0 +1,79 @@ +/* + * This file is part of Apollo, licensed under the MIT License. + * + * Copyright (c) 2026 Moonsworth + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +package com.lunarclient.apollo.example.command; + +import com.lunarclient.apollo.example.ApolloExamplePlugin; +import com.lunarclient.apollo.example.module.impl.HeightLimitExample; +import org.bukkit.command.Command; +import org.bukkit.command.CommandExecutor; +import org.bukkit.command.CommandSender; +import org.bukkit.entity.Player; +import org.jetbrains.annotations.NotNull; + +public class HeightLimitCommand implements CommandExecutor { + + @Override + public boolean onCommand(@NotNull CommandSender sender, @NotNull Command command, @NotNull String label, @NotNull String[] args) { + if (!(sender instanceof Player)) { + sender.sendMessage("Player only!"); + return true; + } + + Player player = (Player) sender; + + if (args.length != 1) { + player.sendMessage("Usage: /heightlimit "); + return true; + } + + HeightLimitExample heightLimitExample = ApolloExamplePlugin.getInstance().getHeightLimitExample(); + + switch (args[0].toLowerCase()) { + case "override": { + heightLimitExample.overrideHeightLimitExample(player); + player.sendMessage("Overriding height limit...."); + break; + } + + case "remove": { + heightLimitExample.removeHeightLimitExample(player); + player.sendMessage("Removing height limit...."); + break; + } + + case "reset": { + heightLimitExample.resetHeightLimitsExample(player); + player.sendMessage("Resetting height limits..."); + break; + } + + default: { + player.sendMessage("Usage: /heightlimit "); + break; + } + } + + return true; + } +} diff --git a/example/bukkit/common/src/main/java/com/lunarclient/apollo/example/command/InventoryCommand.java b/example/bukkit/common/src/main/java/com/lunarclient/apollo/example/command/InventoryCommand.java index 9f55e94b..089b1be1 100644 --- a/example/bukkit/common/src/main/java/com/lunarclient/apollo/example/command/InventoryCommand.java +++ b/example/bukkit/common/src/main/java/com/lunarclient/apollo/example/command/InventoryCommand.java @@ -41,14 +41,84 @@ public boolean onCommand(@NotNull CommandSender sender, @NotNull Command command } Player player = (Player) sender; + + if (args.length == 0) { + this.sendUsage(player); + return true; + } + InventoryExample inventoryExample = ApolloExamplePlugin.getInstance().getInventoryExample(); - if (inventoryExample.inventoryModuleExample(player)) { - player.sendMessage("Giving items..."); - } else { - player.sendMessage("Displaying menu..."); + switch (args[0].toLowerCase()) { + case "giveitems": { + if (inventoryExample.inventoryModuleExample(player)) { + player.sendMessage("Giving items..."); + } else { + player.sendMessage("Displaying menu..."); + } + + break; + } + + case "displaymenu": { + inventoryExample.displayMenuLayoutExample(player); + player.sendMessage("Displaying menu layout buttons..."); + break; + } + + case "displayhub": { + inventoryExample.displayHubLayoutExample(player); + player.sendMessage("Displaying hub layout buttons..."); + break; + } + + case "displayminigame": { + inventoryExample.displayMinigameLayoutExample(player); + player.sendMessage("Displaying minigame layout buttons..."); + break; + } + + case "displaystaff": { + inventoryExample.displayStaffLayoutExample(player); + player.sendMessage("Displaying staff layout buttons..."); + break; + } + + case "removebutton": { + inventoryExample.removeInventoryButtonExample(player); + player.sendMessage("Removing buttons..."); + break; + } + + case "updatebutton": { + inventoryExample.updateInventoryButtonExample(player); + player.sendMessage("Updating the vote button..."); + break; + } + + case "resetbuttons": { + inventoryExample.resetInventoryButtonsExample(player); + player.sendMessage("Resetting buttons..."); + break; + } + + default: { + this.sendUsage(player); + break; + } } return true; } + + private void sendUsage(Player player) { + player.sendMessage("Usage: /inventory giveItems"); + player.sendMessage("Usage: /inventory displayMenu"); + player.sendMessage("Usage: /inventory displayHub"); + player.sendMessage("Usage: /inventory displayMinigame"); + player.sendMessage("Usage: /inventory displayStaff"); + player.sendMessage("Usage: /inventory removeButton"); + player.sendMessage("Usage: /inventory updateButton"); + player.sendMessage("Usage: /inventory resetButtons"); + } } diff --git a/example/bukkit/common/src/main/java/com/lunarclient/apollo/example/module/impl/ChatExample.java b/example/bukkit/common/src/main/java/com/lunarclient/apollo/example/module/impl/ChatExample.java index 8efd7311..0bc3ee06 100644 --- a/example/bukkit/common/src/main/java/com/lunarclient/apollo/example/module/impl/ChatExample.java +++ b/example/bukkit/common/src/main/java/com/lunarclient/apollo/example/module/impl/ChatExample.java @@ -24,6 +24,7 @@ package com.lunarclient.apollo.example.module.impl; import com.lunarclient.apollo.example.module.ApolloModuleExample; +import org.bukkit.entity.Player; public abstract class ChatExample extends ApolloModuleExample { @@ -31,4 +32,14 @@ public abstract class ChatExample extends ApolloModuleExample { public abstract void removeLiveChatMessageExample(); + public abstract void displayChannelsLayoutExample(Player viewer); + + public abstract void displayStaffChatLayoutExample(Player viewer); + + public abstract void updateChatButtonExample(Player viewer); + + public abstract void removeChatButtonExample(Player viewer); + + public abstract void resetChatButtonsExample(Player viewer); + } diff --git a/example/bukkit/common/src/main/java/com/lunarclient/apollo/example/module/impl/CosmeticExample.java b/example/bukkit/common/src/main/java/com/lunarclient/apollo/example/module/impl/CosmeticExample.java index 0e56b672..b6e33e20 100644 --- a/example/bukkit/common/src/main/java/com/lunarclient/apollo/example/module/impl/CosmeticExample.java +++ b/example/bukkit/common/src/main/java/com/lunarclient/apollo/example/module/impl/CosmeticExample.java @@ -23,6 +23,7 @@ */ package com.lunarclient.apollo.example.module.impl; +import com.lunarclient.apollo.example.ApolloExamplePlugin; import com.lunarclient.apollo.example.module.ApolloModuleExample; import com.lunarclient.apollo.example.nms.CommandCosmetic; import java.util.Collections; @@ -54,12 +55,30 @@ public void equipNpcCosmeticToViewer(Player viewer, UUID npcUuid, CommandCosmeti public abstract void startNpcEmoteExample(Player viewer, UUID npcUuid); - public abstract void startNpcEmoteInternal(Player viewer, UUID npcUuid, int emoteId, int metadata); + public void startNpcEmoteInternal(UUID npcUuid, int emoteId, int metadata) { + for (Player viewer : this.getNpcViewers(npcUuid)) { + this.startNpcEmoteToViewer(viewer, npcUuid, emoteId, metadata); + } + } + + public abstract void startNpcEmoteToViewer(Player viewer, UUID npcUuid, int emoteId, int metadata); public abstract void stopNpcEmoteExample(Player viewer, UUID npcUuid); + public void stopNpcEmoteInternal(UUID npcUuid) { + for (Player viewer : this.getNpcViewers(npcUuid)) { + this.stopNpcEmoteToViewer(viewer, npcUuid); + } + } + + public abstract void stopNpcEmoteToViewer(Player viewer, UUID npcUuid); + public abstract void resetNpcEmotesExample(); + protected List getNpcViewers(UUID npcUuid) { + return ApolloExamplePlugin.getInstance().getNpcManager().getViewers(npcUuid); + } + public abstract void displaySprayExample(Player viewer, int sprayId); public abstract void removeSprayExample(int sprayId); diff --git a/example/bukkit/common/src/main/java/com/lunarclient/apollo/example/module/impl/HeightLimitExample.java b/example/bukkit/common/src/main/java/com/lunarclient/apollo/example/module/impl/HeightLimitExample.java new file mode 100644 index 00000000..9246625f --- /dev/null +++ b/example/bukkit/common/src/main/java/com/lunarclient/apollo/example/module/impl/HeightLimitExample.java @@ -0,0 +1,37 @@ +/* + * This file is part of Apollo, licensed under the MIT License. + * + * Copyright (c) 2026 Moonsworth + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +package com.lunarclient.apollo.example.module.impl; + +import com.lunarclient.apollo.example.module.ApolloModuleExample; +import org.bukkit.entity.Player; + +public abstract class HeightLimitExample extends ApolloModuleExample { + + public abstract void overrideHeightLimitExample(Player viewer); + + public abstract void removeHeightLimitExample(Player viewer); + + public abstract void resetHeightLimitsExample(Player viewer); + +} diff --git a/example/bukkit/common/src/main/java/com/lunarclient/apollo/example/module/impl/InventoryExample.java b/example/bukkit/common/src/main/java/com/lunarclient/apollo/example/module/impl/InventoryExample.java index 37e62f7c..32064984 100644 --- a/example/bukkit/common/src/main/java/com/lunarclient/apollo/example/module/impl/InventoryExample.java +++ b/example/bukkit/common/src/main/java/com/lunarclient/apollo/example/module/impl/InventoryExample.java @@ -32,7 +32,7 @@ import org.bukkit.inventory.Inventory; import org.bukkit.inventory.ItemStack; -public class InventoryExample extends NMSExample { +public abstract class InventoryExample extends NMSExample { public boolean inventoryModuleExample(Player player) { if (this.isOneEight()) { @@ -46,12 +46,12 @@ public boolean inventoryModuleExample(Player player) { public void inventoryModuleCommandExample(Player player) { player.performCommand("summon item ~ ~1 ~ {Item:{id:\"minecraft:stone\",Count:1b,components:{\"minecraft:custom_name\":\"UNCLICKABLE\",\"minecraft:custom_data\":{lunar:{unclickable:true}}}}}"); - player.performCommand("summon item ~ ~1 ~ {Item:{id:\"minecraft:paper\",Count:1b,components:{\"minecraft:custom_name\":\"COPY TO CLIPBOARD\",\"minecraft:custom_data\":{lunar:{unclickable:true,copyToClipboard:\"lunarclient.com\"}}}}}"); - player.performCommand("summon item ~ ~1 ~ {Item:{id:\"minecraft:torch\",Count:1b,components:{\"minecraft:custom_name\":\"OPEN URL\",\"minecraft:custom_data\":{lunar:{unclickable:true,openUrl:\"https://lunarclient.com\"}}}}}"); - player.performCommand("summon item ~ ~1 ~ {Item:{id:\"minecraft:book\",Count:1b,components:{\"minecraft:custom_name\":\"SUGGEST COMMAND\",\"minecraft:custom_data\":{lunar:{unclickable:true,suggestCommand:\"/apollo\"}}}}}"); - player.performCommand("summon item ~ ~1 ~ {Item:{id:\"minecraft:writable_book\",Count:1b,components:{\"minecraft:custom_name\":\"RUN COMMAND\",\"minecraft:custom_data\":{lunar:{unclickable:true,runCommand:\"/apollo\"}}}}}"); - player.performCommand("summon item ~ ~1 ~ {Item:{id:\"minecraft:sponge\",Count:1b,components:{\"minecraft:custom_name\":\"HIDE ITEM TOOLTIP\",\"minecraft:custom_data\":{lunar:{unclickable:true,hideItemTooltip:true}}}}}"); - player.performCommand("summon item ~ ~1 ~ {Item:{id:\"minecraft:dirt\",Count:1b,components:{\"minecraft:custom_name\":\"HIDE SLOT HIGHTLIGHT\",\"minecraft:custom_data\":{lunar:{unclickable:true,hideSlotHighlight:true}}}}}"); + player.performCommand("summon item ~ ~1 ~ {Item:{id:\"minecraft:paper\",Count:1b,components:{\"minecraft:custom_name\":\"COPY TO CLIPBOARD\",\"minecraft:custom_data\":{lunar:{unclickable:true,copy_to_clipboard:\"lunarclient.com\"}}}}}"); + player.performCommand("summon item ~ ~1 ~ {Item:{id:\"minecraft:torch\",Count:1b,components:{\"minecraft:custom_name\":\"OPEN URL\",\"minecraft:custom_data\":{lunar:{unclickable:true,open_url:\"https://lunarclient.com\"}}}}}"); + player.performCommand("summon item ~ ~1 ~ {Item:{id:\"minecraft:book\",Count:1b,components:{\"minecraft:custom_name\":\"SUGGEST COMMAND\",\"minecraft:custom_data\":{lunar:{unclickable:true,suggest_command:\"/apollo\"}}}}}"); + player.performCommand("summon item ~ ~1 ~ {Item:{id:\"minecraft:writable_book\",Count:1b,components:{\"minecraft:custom_name\":\"RUN COMMAND\",\"minecraft:custom_data\":{lunar:{unclickable:true,run_command:\"/apollo\"}}}}}"); + player.performCommand("summon item ~ ~1 ~ {Item:{id:\"minecraft:sponge\",Count:1b,components:{\"minecraft:custom_name\":\"HIDE ITEM TOOLTIP\",\"minecraft:custom_data\":{lunar:{unclickable:true,hide_item_tooltip:true}}}}}"); + player.performCommand("summon item ~ ~1 ~ {Item:{id:\"minecraft:dirt\",Count:1b,components:{\"minecraft:custom_name\":\"HIDE SLOT HIGHTLIGHT\",\"minecraft:custom_data\":{lunar:{unclickable:true,hide_slot_highlight:true}}}}}"); } public void inventoryModuleNMSExample(Player player) { @@ -70,7 +70,7 @@ public void inventoryModuleNMSExample(Player player) { ); copyToClipboardItem = ItemUtil.addTag(copyToClipboardItem, "unclickable", true); - inventory.setItem(12, ItemUtil.addTag(copyToClipboardItem, "copyToClipboard", "lunarclient.com")); + inventory.setItem(12, ItemUtil.addTag(copyToClipboardItem, "copy_to_clipboard", "lunarclient.com")); ItemStack openUrlItem = ItemUtil.itemWithName( Material.TORCH, @@ -78,7 +78,7 @@ public void inventoryModuleNMSExample(Player player) { ); openUrlItem = ItemUtil.addTag(openUrlItem, "unclickable", true); - inventory.setItem(14, ItemUtil.addTag(openUrlItem, "openUrl", "https://lunarclient.com")); + inventory.setItem(14, ItemUtil.addTag(openUrlItem, "open_url", "https://lunarclient.com")); ItemStack suggestCommandItem = ItemUtil.itemWithName( Material.BOOK, @@ -86,7 +86,7 @@ public void inventoryModuleNMSExample(Player player) { ); suggestCommandItem = ItemUtil.addTag(suggestCommandItem, "unclickable", true); - inventory.setItem(16, ItemUtil.addTag(suggestCommandItem, "suggestCommand", "/apollo")); + inventory.setItem(16, ItemUtil.addTag(suggestCommandItem, "suggest_command", "/apollo")); ItemStack runCommandItem = ItemUtil.itemWithName( Material.ENCHANTED_BOOK, @@ -94,7 +94,7 @@ public void inventoryModuleNMSExample(Player player) { ); runCommandItem = ItemUtil.addTag(runCommandItem, "unclickable", true); - inventory.setItem(29, ItemUtil.addTag(runCommandItem, "runCommand", "/apollo")); + inventory.setItem(29, ItemUtil.addTag(runCommandItem, "run_command", "/apollo")); ItemStack hideTooltipItem = ItemUtil.itemWithName( Material.SPONGE, @@ -102,7 +102,7 @@ public void inventoryModuleNMSExample(Player player) { ); hideTooltipItem = ItemUtil.addTag(hideTooltipItem, "unclickable", true); - inventory.setItem(31, ItemUtil.addTag(hideTooltipItem, "hideItemTooltip", true)); + inventory.setItem(31, ItemUtil.addTag(hideTooltipItem, "hide_item_tooltip", true)); ItemStack hideHighlightItem = ItemUtil.itemWithName( Material.DIRT, @@ -110,9 +110,23 @@ public void inventoryModuleNMSExample(Player player) { ); hideHighlightItem = ItemUtil.addTag(hideHighlightItem, "unclickable", true); - inventory.setItem(33, ItemUtil.addTag(hideHighlightItem, "hideSlotHighlight", true)); + inventory.setItem(33, ItemUtil.addTag(hideHighlightItem, "hide_slot_highlight", true)); player.openInventory(inventory); } + public abstract void displayMenuLayoutExample(Player viewer); + + public abstract void displayHubLayoutExample(Player viewer); + + public abstract void displayMinigameLayoutExample(Player viewer); + + public abstract void displayStaffLayoutExample(Player viewer); + + public abstract void removeInventoryButtonExample(Player viewer); + + public abstract void updateInventoryButtonExample(Player viewer); + + public abstract void resetInventoryButtonsExample(Player viewer); + } diff --git a/example/bukkit/common/src/main/java/com/lunarclient/apollo/example/util/ServerStatsUtil.java b/example/bukkit/common/src/main/java/com/lunarclient/apollo/example/util/ServerStatsUtil.java new file mode 100644 index 00000000..dbeb4d63 --- /dev/null +++ b/example/bukkit/common/src/main/java/com/lunarclient/apollo/example/util/ServerStatsUtil.java @@ -0,0 +1,77 @@ +/* + * This file is part of Apollo, licensed under the MIT License. + * + * Copyright (c) 2026 Moonsworth + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +package com.lunarclient.apollo.example.util; + +import java.lang.management.ManagementFactory; +import java.lang.management.OperatingSystemMXBean; +import java.lang.reflect.Method; +import org.bukkit.Bukkit; + +public final class ServerStatsUtil { + + private static final long MB_BYTES = 1024 * 1024; + private static final OperatingSystemMXBean MX_BEAN = ManagementFactory.getPlatformMXBean(OperatingSystemMXBean.class); + private static final Method GET_TPS_METHOD = findGetTpsMethod(); + + public static double[] getTps() { + if (GET_TPS_METHOD == null) { + return null; + } + + try { + return (double[]) GET_TPS_METHOD.invoke(Bukkit.getServer()); + } catch (Throwable throwable) { + return null; + } + } + + public static double getSystemLoadAverage() { + return MX_BEAN.getSystemLoadAverage(); + } + + public static int getAvailableProcessors() { + return MX_BEAN.getAvailableProcessors(); + } + + public static long getUsedRamMb() { + Runtime runtime = Runtime.getRuntime(); + return (runtime.totalMemory() - runtime.freeMemory()) / MB_BYTES; + } + + public static long getMaxRamMb() { + return Runtime.getRuntime().maxMemory() / MB_BYTES; + } + + private static Method findGetTpsMethod() { + try { + return Bukkit.getServer() != null ? Bukkit.getServer().getClass().getMethod("getTPS") : null; + } catch (Throwable throwable) { + return null; + } + } + + private ServerStatsUtil() { + } + +} diff --git a/example/bukkit/json/src/main/java/com/lunarclient/apollo/example/json/ApolloJsonExamplePlatform.java b/example/bukkit/json/src/main/java/com/lunarclient/apollo/example/json/ApolloJsonExamplePlatform.java index 391c46d7..22a99601 100644 --- a/example/bukkit/json/src/main/java/com/lunarclient/apollo/example/json/ApolloJsonExamplePlatform.java +++ b/example/bukkit/json/src/main/java/com/lunarclient/apollo/example/json/ApolloJsonExamplePlatform.java @@ -36,7 +36,9 @@ import com.lunarclient.apollo.example.json.module.CosmeticJsonExample; import com.lunarclient.apollo.example.json.module.EntityJsonExample; import com.lunarclient.apollo.example.json.module.GlowJsonExample; +import com.lunarclient.apollo.example.json.module.HeightLimitJsonExample; import com.lunarclient.apollo.example.json.module.HologramJsonExample; +import com.lunarclient.apollo.example.json.module.InventoryJsonExample; import com.lunarclient.apollo.example.json.module.LimbJsonExample; import com.lunarclient.apollo.example.json.module.MarkerJsonExample; import com.lunarclient.apollo.example.json.module.ModSettingsJsonExample; @@ -75,12 +77,14 @@ public void registerModuleExamples() { this.setBeamExample(new BeamJsonExample()); this.setBorderExample(new BorderJsonExample()); this.setChatExample(new ChatJsonExample()); + this.setInventoryExample(new InventoryJsonExample()); this.setCosmeticExample(new CosmeticJsonExample()); this.setColoredFireExample(new ColoredFireJsonExample()); this.setCombatExample(new CombatJsonExample()); this.setCooldownExample(new CooldownJsonExample()); this.setEntityExample(new EntityJsonExample()); this.setGlowExample(new GlowJsonExample()); + this.setHeightLimitExample(new HeightLimitJsonExample()); this.setHologramExample(new HologramJsonExample()); this.setLimbExample(new LimbJsonExample()); this.setMarkerExample(new MarkerJsonExample()); diff --git a/example/bukkit/json/src/main/java/com/lunarclient/apollo/example/json/listener/ApolloPacketReceiveJsonListener.java b/example/bukkit/json/src/main/java/com/lunarclient/apollo/example/json/listener/ApolloPacketReceiveJsonListener.java index 1d8e4656..50401b02 100644 --- a/example/bukkit/json/src/main/java/com/lunarclient/apollo/example/json/listener/ApolloPacketReceiveJsonListener.java +++ b/example/bukkit/json/src/main/java/com/lunarclient/apollo/example/json/listener/ApolloPacketReceiveJsonListener.java @@ -27,7 +27,9 @@ import com.google.gson.JsonObject; import com.google.gson.JsonParser; import com.lunarclient.apollo.example.ApolloExamplePlugin; +import com.lunarclient.apollo.example.json.module.InventoryJsonExample; import com.lunarclient.apollo.example.json.util.JsonUtil; +import com.lunarclient.apollo.example.module.impl.InventoryExample; import java.nio.charset.StandardCharsets; import java.util.UUID; import org.bukkit.Location; @@ -72,6 +74,10 @@ public void onPluginMessageReceived(@NonNull String channel, @NonNull Player pla this.onPlayerChatOpen(payload); } else if ("lunarclient.apollo.packetenrichment.v1.PlayerChatCloseMessage".equals(type)) { this.onPlayerChatClose(payload); + } else if ("lunarclient.apollo.packetenrichment.v1.PlayerInventoryOpenMessage".equals(type)) { + this.onPlayerInventoryOpen(player, payload); + } else if ("lunarclient.apollo.packetenrichment.v1.PlayerInventoryCloseMessage".equals(type)) { + this.onPlayerInventoryClose(player, payload); } else if ("lunarclient.apollo.packetenrichment.v1.PlayerUseItemMessage".equals(type)) { this.onPlayerUseItem(payload); } else if ("lunarclient.apollo.packetenrichment.v1.PlayerUseItemBucketMessage".equals(type)) { @@ -120,6 +126,26 @@ private void onPlayerChatClose(JsonObject message) { this.onPlayerInfo(message.getAsJsonObject("player_info")); } + private void onPlayerInventoryOpen(Player player, JsonObject message) { + long instantiationTimeMs = JsonUtil.toJavaTimestamp(message); + this.onPlayerInfo(message.getAsJsonObject("player_info")); + + InventoryExample example = ApolloExamplePlugin.getInstance().getInventoryExample(); + if (example instanceof InventoryJsonExample) { + ((InventoryJsonExample) example).handleInventoryOpen(player); + } + } + + private void onPlayerInventoryClose(Player player, JsonObject message) { + long instantiationTimeMs = JsonUtil.toJavaTimestamp(message); + this.onPlayerInfo(message.getAsJsonObject("player_info")); + + InventoryExample example = ApolloExamplePlugin.getInstance().getInventoryExample(); + if (example instanceof InventoryJsonExample) { + ((InventoryJsonExample) example).handleInventoryClose(player); + } + } + private void onPlayerUseItem(JsonObject message) { long instantiationTimeMs = JsonUtil.toJavaTimestamp(message); this.onPlayerInfo(message.getAsJsonObject("player_info")); diff --git a/example/bukkit/json/src/main/java/com/lunarclient/apollo/example/json/listener/ApolloPlayerJsonListener.java b/example/bukkit/json/src/main/java/com/lunarclient/apollo/example/json/listener/ApolloPlayerJsonListener.java index 6c0984d5..217aab0a 100644 --- a/example/bukkit/json/src/main/java/com/lunarclient/apollo/example/json/listener/ApolloPlayerJsonListener.java +++ b/example/bukkit/json/src/main/java/com/lunarclient/apollo/example/json/listener/ApolloPlayerJsonListener.java @@ -26,6 +26,9 @@ import com.google.gson.JsonObject; import com.lunarclient.apollo.example.ApolloExamplePlugin; import com.lunarclient.apollo.example.json.util.JsonPacketUtil; +import com.lunarclient.apollo.example.module.impl.CosmeticExample; +import com.lunarclient.apollo.example.nms.CommandCosmetic; +import com.lunarclient.apollo.example.nms.PlayerNpc; import java.util.HashSet; import java.util.Set; import java.util.UUID; @@ -81,6 +84,26 @@ private void onRegisterChannel(PlayerRegisterChannelEvent event) { PLAYERS_RUNNING_APOLLO.add(player.getUniqueId()); player.sendMessage("You are using LunarClient!"); + + this.applyNpcCosmetics(player); + } + + private void applyNpcCosmetics(Player player) { + CosmeticExample cosmeticExample = this.plugin.getCosmeticExample(); + if (cosmeticExample == null) { + return; + } + + for (PlayerNpc npc : this.plugin.getNpcManager().getNpcs()) { + for (CommandCosmetic spec : npc.getCosmetics()) { + cosmeticExample.equipNpcCosmeticToViewer(player, npc.getUuid(), spec); + } + + PlayerNpc.ActiveEmote emote = npc.getActiveEmote(); + if (emote != null && npc.getViewers().contains(player.getUniqueId())) { + cosmeticExample.startNpcEmoteToViewer(player, npc.getUuid(), emote.getEmoteId(), emote.getMetadata()); + } + } } @EventHandler diff --git a/example/bukkit/json/src/main/java/com/lunarclient/apollo/example/json/module/ChatJsonExample.java b/example/bukkit/json/src/main/java/com/lunarclient/apollo/example/json/module/ChatJsonExample.java index 9c7128f1..f34771c6 100644 --- a/example/bukkit/json/src/main/java/com/lunarclient/apollo/example/json/module/ChatJsonExample.java +++ b/example/bukkit/json/src/main/java/com/lunarclient/apollo/example/json/module/ChatJsonExample.java @@ -25,14 +25,19 @@ import com.google.gson.JsonObject; import com.lunarclient.apollo.example.ApolloExamplePlugin; +import com.lunarclient.apollo.example.json.module.chatbuttons.ChannelsLayout; +import com.lunarclient.apollo.example.json.module.chatbuttons.ChatButtonParts; +import com.lunarclient.apollo.example.json.module.chatbuttons.StaffChatLayout; import com.lunarclient.apollo.example.json.util.AdventureUtil; import com.lunarclient.apollo.example.json.util.JsonPacketUtil; +import com.lunarclient.apollo.example.json.util.JsonUtil; import com.lunarclient.apollo.example.module.impl.ChatExample; import com.lunarclient.apollo.example.util.ServerUtil; import java.util.concurrent.atomic.AtomicInteger; import net.kyori.adventure.text.Component; import net.kyori.adventure.text.format.NamedTextColor; import org.bukkit.Bukkit; +import org.bukkit.entity.Player; import org.bukkit.scheduler.BukkitRunnable; public class ChatJsonExample extends ChatExample { @@ -106,6 +111,48 @@ private void runFoliaChatMessageTask() { }, 1L, 20L); } + @Override + public void displayChannelsLayoutExample(Player viewer) { + ChannelsLayout.display(viewer); + } + + @Override + public void displayStaffChatLayoutExample(Player viewer) { + StaffChatLayout.display(viewer); + } + + @Override + public void resetChatButtonsExample(Player viewer) { + JsonObject message = new JsonObject(); + message.addProperty("@type", "type.googleapis.com/lunarclient.apollo.chat.v1.ResetChatButtonsMessage"); + + JsonPacketUtil.sendPacket(viewer, message); + } + + @Override + public void updateChatButtonExample(Player viewer) { + JsonObject update = new JsonObject(); + update.add("content", ChatButtonParts.createContentObject(1.0F, + ChatButtonParts.iconPart(JsonUtil.createItemStackIconObject("PAPER", 0)), + ChatButtonParts.textPart(Component.text("Public Chat", NamedTextColor.AQUA)))); + + JsonObject message = new JsonObject(); + message.addProperty("@type", "type.googleapis.com/lunarclient.apollo.chat.v1.UpdateChatButtonMessage"); + message.addProperty("id", "public-chat"); + message.add("update", update); + + JsonPacketUtil.sendPacket(viewer, message); + } + + @Override + public void removeChatButtonExample(Player viewer) { + JsonObject message = new JsonObject(); + message.addProperty("@type", "type.googleapis.com/lunarclient.apollo.chat.v1.RemoveChatButtonMessage"); + message.addProperty("id", "party-chat"); + + JsonPacketUtil.sendPacket(viewer, message); + } + @Override public void removeLiveChatMessageExample() { JsonObject message = new JsonObject(); diff --git a/example/bukkit/json/src/main/java/com/lunarclient/apollo/example/json/module/CosmeticJsonExample.java b/example/bukkit/json/src/main/java/com/lunarclient/apollo/example/json/module/CosmeticJsonExample.java index cff28169..b9a43ef9 100644 --- a/example/bukkit/json/src/main/java/com/lunarclient/apollo/example/json/module/CosmeticJsonExample.java +++ b/example/bukkit/json/src/main/java/com/lunarclient/apollo/example/json/module/CosmeticJsonExample.java @@ -29,6 +29,7 @@ import com.lunarclient.apollo.example.json.util.JsonPacketUtil; import com.lunarclient.apollo.example.json.util.JsonUtil; import com.lunarclient.apollo.example.module.impl.CosmeticExample; +import com.lunarclient.apollo.example.nms.CommandCosmetic; import java.time.Duration; import java.util.List; import java.util.UUID; @@ -103,6 +104,56 @@ public void equipNpcCosmeticsInternal(Player viewer, UUID npcUuid, List JsonPacketUtil.broadcastPacket(message); } + @Override + public void equipNpcCosmeticInternal(Player viewer, UUID npcUuid, CommandCosmetic cosmetic) { + JsonPacketUtil.broadcastPacket(this.createEquipMessage(npcUuid, cosmetic)); + } + + @Override + public void equipNpcCosmeticToViewer(Player viewer, UUID npcUuid, CommandCosmetic cosmetic) { + JsonPacketUtil.sendPacket(viewer, this.createEquipMessage(npcUuid, cosmetic)); + } + + private JsonObject createEquipMessage(UUID npcUuid, CommandCosmetic cosmetic) { + JsonObject cosmeticObject = new JsonObject(); + cosmeticObject.addProperty("id", cosmetic.getId()); + + CommandCosmetic.Options options = cosmetic.getOptions(); + if (options instanceof CommandCosmetic.Hat) { + CommandCosmetic.Hat hat = (CommandCosmetic.Hat) options; + JsonObject hatOptions = new JsonObject(); + hatOptions.addProperty("show_over_helmet", hat.isShowOverHelmet()); + hatOptions.addProperty("show_over_skin_layer", hat.isShowOverSkinLayer()); + hatOptions.addProperty("height_offset", hat.getHeightOffset()); + cosmeticObject.add("hat_options", hatOptions); + } else if (options instanceof CommandCosmetic.Cloak) { + JsonObject cloakOptions = new JsonObject(); + cloakOptions.addProperty("use_cloth_physics", ((CommandCosmetic.Cloak) options).isUseClothPhysics()); + cosmeticObject.add("cloak_options", cloakOptions); + } else if (options instanceof CommandCosmetic.Pet) { + JsonObject petOptions = new JsonObject(); + petOptions.addProperty("flip_shoulder", ((CommandCosmetic.Pet) options).isFlipShoulder()); + cosmeticObject.add("pet_options", petOptions); + } else if (options instanceof CommandCosmetic.Body) { + CommandCosmetic.Body body = (CommandCosmetic.Body) options; + JsonObject bodyOptions = new JsonObject(); + bodyOptions.addProperty("show_over_chestplate", body.isShowOverChestplate()); + bodyOptions.addProperty("show_over_leggings", body.isShowOverLeggings()); + bodyOptions.addProperty("show_over_boots", body.isShowOverBoots()); + cosmeticObject.add("body_options", bodyOptions); + } + + JsonArray cosmeticsArray = new JsonArray(); + cosmeticsArray.add(cosmeticObject); + + JsonObject message = new JsonObject(); + message.addProperty("@type", "type.googleapis.com/lunarclient.apollo.cosmetic.v1.EquipNpcCosmeticsMessage"); + message.add("npc_uuid", JsonUtil.createUuidObject(npcUuid)); + message.add("cosmetics", cosmeticsArray); + + return message; + } + @Override public void unequipNpcCosmeticsExample(Player viewer, UUID npcUuid) { List cosmeticIds = Lists.newArrayList(434, 3654, 5095, 3, 3977); @@ -154,7 +205,7 @@ public void startNpcEmoteExample(Player viewer, UUID npcUuid) { } @Override - public void startNpcEmoteInternal(Player viewer, UUID npcUuid, int emoteId, int metadata) { + public void startNpcEmoteToViewer(Player viewer, UUID npcUuid, int emoteId, int metadata) { JsonObject emote = new JsonObject(); emote.addProperty("id", emoteId); emote.addProperty("metadata", metadata); @@ -164,7 +215,7 @@ public void startNpcEmoteInternal(Player viewer, UUID npcUuid, int emoteId, int message.add("npc_uuid", JsonUtil.createUuidObject(npcUuid)); message.add("emote", emote); - JsonPacketUtil.broadcastPacket(message); + JsonPacketUtil.sendPacket(viewer, message); } @Override @@ -176,6 +227,15 @@ public void stopNpcEmoteExample(Player viewer, UUID npcUuid) { JsonPacketUtil.broadcastPacket(message); } + @Override + public void stopNpcEmoteToViewer(Player viewer, UUID npcUuid) { + JsonObject message = new JsonObject(); + message.addProperty("@type", "type.googleapis.com/lunarclient.apollo.cosmetic.v1.StopNpcEmoteMessage"); + message.add("npc_uuid", JsonUtil.createUuidObject(npcUuid)); + + JsonPacketUtil.sendPacket(viewer, message); + } + @Override public void resetNpcEmotesExample() { JsonObject message = new JsonObject(); diff --git a/example/bukkit/json/src/main/java/com/lunarclient/apollo/example/json/module/HeightLimitJsonExample.java b/example/bukkit/json/src/main/java/com/lunarclient/apollo/example/json/module/HeightLimitJsonExample.java new file mode 100644 index 00000000..37f8e89d --- /dev/null +++ b/example/bukkit/json/src/main/java/com/lunarclient/apollo/example/json/module/HeightLimitJsonExample.java @@ -0,0 +1,66 @@ +/* + * This file is part of Apollo, licensed under the MIT License. + * + * Copyright (c) 2026 Moonsworth + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +package com.lunarclient.apollo.example.json.module; + +import com.google.gson.JsonObject; +import com.lunarclient.apollo.example.json.util.AdventureUtil; +import com.lunarclient.apollo.example.json.util.JsonPacketUtil; +import com.lunarclient.apollo.example.module.impl.HeightLimitExample; +import net.kyori.adventure.text.Component; +import net.kyori.adventure.text.format.NamedTextColor; +import org.bukkit.entity.Player; + +public class HeightLimitJsonExample extends HeightLimitExample { + + @Override + public void overrideHeightLimitExample(Player viewer) { + JsonObject message = new JsonObject(); + message.addProperty("@type", "type.googleapis.com/lunarclient.apollo.heightlimit.v1.OverrideHeightLimitMessage"); + message.addProperty("world", "world_the_end"); + message.addProperty("limit", 150); + message.addProperty("display_name_adventure_json_lines", AdventureUtil.toJson( + Component.text("The End", NamedTextColor.DARK_PURPLE) + )); + + JsonPacketUtil.sendPacket(viewer, message); + } + + @Override + public void removeHeightLimitExample(Player viewer) { + JsonObject message = new JsonObject(); + message.addProperty("@type", "type.googleapis.com/lunarclient.apollo.heightlimit.v1.RemoveHeightLimitMessage"); + message.addProperty("world", "world_the_end"); + + JsonPacketUtil.sendPacket(viewer, message); + } + + @Override + public void resetHeightLimitsExample(Player viewer) { + JsonObject message = new JsonObject(); + message.addProperty("@type", "type.googleapis.com/lunarclient.apollo.heightlimit.v1.ResetHeightLimitsMessage"); + + JsonPacketUtil.sendPacket(viewer, message); + } + +} diff --git a/example/bukkit/json/src/main/java/com/lunarclient/apollo/example/json/module/InventoryJsonExample.java b/example/bukkit/json/src/main/java/com/lunarclient/apollo/example/json/module/InventoryJsonExample.java new file mode 100644 index 00000000..15bac468 --- /dev/null +++ b/example/bukkit/json/src/main/java/com/lunarclient/apollo/example/json/module/InventoryJsonExample.java @@ -0,0 +1,192 @@ +/* + * This file is part of Apollo, licensed under the MIT License. + * + * Copyright (c) 2026 Moonsworth + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +package com.lunarclient.apollo.example.json.module; + +import com.google.gson.JsonObject; +import com.lunarclient.apollo.example.ApolloExamplePlugin; +import com.lunarclient.apollo.example.json.module.inventorybuttons.HubLayout; +import com.lunarclient.apollo.example.json.module.inventorybuttons.InventoryButtonParts; +import com.lunarclient.apollo.example.json.module.inventorybuttons.MenuLayout; +import com.lunarclient.apollo.example.json.module.inventorybuttons.MinigameLayout; +import com.lunarclient.apollo.example.json.module.inventorybuttons.StaffLayout; +import com.lunarclient.apollo.example.json.util.JsonPacketUtil; +import com.lunarclient.apollo.example.module.impl.InventoryExample; +import com.lunarclient.apollo.example.util.ServerUtil; +import java.util.Set; +import java.util.UUID; +import java.util.concurrent.ConcurrentHashMap; +import java.util.concurrent.TimeUnit; +import net.kyori.adventure.text.Component; +import net.kyori.adventure.text.format.NamedTextColor; +import org.bukkit.Bukkit; +import org.bukkit.entity.Player; +import org.bukkit.event.EventHandler; +import org.bukkit.event.Listener; +import org.bukkit.event.player.PlayerQuitEvent; + +public class InventoryJsonExample extends InventoryExample implements Listener { + + private final Set staffViewers = ConcurrentHashMap.newKeySet(); + private final Set menuViewers = ConcurrentHashMap.newKeySet(); + private final Set minigameViewers = ConcurrentHashMap.newKeySet(); + + private final Set openInventories = ConcurrentHashMap.newKeySet(); + private volatile boolean inventoryTrackingSeen; + + public InventoryJsonExample() { + if (ServerUtil.isFolia()) { + this.runFoliaLiveButtonTask(); + } else { + this.runBukkitLiveButtonTask(); + } + + Bukkit.getPluginManager().registerEvents(this, ApolloExamplePlugin.getInstance()); + } + + @EventHandler + private void onPlayerQuit(PlayerQuitEvent event) { + UUID playerIdentifier = event.getPlayer().getUniqueId(); + + this.staffViewers.remove(playerIdentifier); + this.menuViewers.remove(playerIdentifier); + this.minigameViewers.remove(playerIdentifier); + this.openInventories.remove(playerIdentifier); + } + + @Override + public void displayMenuLayoutExample(Player viewer) { + MenuLayout.display(viewer); + this.menuViewers.add(viewer.getUniqueId()); + } + + @Override + public void displayHubLayoutExample(Player viewer) { + HubLayout.display(viewer); + } + + @Override + public void displayMinigameLayoutExample(Player viewer) { + MinigameLayout.display(viewer); + this.minigameViewers.add(viewer.getUniqueId()); + } + + @Override + public void displayStaffLayoutExample(Player viewer) { + StaffLayout.display(viewer); + this.staffViewers.add(viewer.getUniqueId()); + } + + @Override + public void removeInventoryButtonExample(Player viewer) { + JsonObject shopMessage = new JsonObject(); + shopMessage.addProperty("@type", "type.googleapis.com/lunarclient.apollo.inventory.v1.RemoveInventoryButtonMessage"); + shopMessage.addProperty("id", "shop"); + + JsonObject voteMessage = new JsonObject(); + voteMessage.addProperty("@type", "type.googleapis.com/lunarclient.apollo.inventory.v1.RemoveInventoryButtonMessage"); + voteMessage.addProperty("id", "vote"); + + JsonPacketUtil.sendPacket(viewer, shopMessage); + JsonPacketUtil.sendPacket(viewer, voteMessage); + } + + @Override + public void updateInventoryButtonExample(Player viewer) { + JsonObject update = new JsonObject(); + update.add("content", InventoryButtonParts.createContentObject(0.85F, + InventoryButtonParts.textPart(Component.text("Thanks for voting!", NamedTextColor.GREEN)))); + update.add("tooltip", InventoryButtonParts.createTooltipObject( + Component.text("Come back tomorrow!", NamedTextColor.GRAY))); + + JsonObject message = new JsonObject(); + message.addProperty("@type", "type.googleapis.com/lunarclient.apollo.inventory.v1.UpdateInventoryButtonMessage"); + message.addProperty("id", "vote"); + message.add("update", update); + + JsonPacketUtil.sendPacket(viewer, message); + } + + @Override + public void resetInventoryButtonsExample(Player viewer) { + JsonObject message = new JsonObject(); + message.addProperty("@type", "type.googleapis.com/lunarclient.apollo.inventory.v1.ResetInventoryButtonsMessage"); + + JsonPacketUtil.sendPacket(viewer, message); + + UUID playerIdentifier = viewer.getUniqueId(); + this.staffViewers.remove(playerIdentifier); + this.menuViewers.remove(playerIdentifier); + this.minigameViewers.remove(playerIdentifier); + } + + public void handleInventoryOpen(Player player) { + this.inventoryTrackingSeen = true; + this.openInventories.add(player.getUniqueId()); + this.sendLiveUpdates(player); + } + + public void handleInventoryClose(Player player) { + this.inventoryTrackingSeen = true; + this.openInventories.remove(player.getUniqueId()); + } + + private void runBukkitLiveButtonTask() { + Bukkit.getScheduler().runTaskTimerAsynchronously(ApolloExamplePlugin.getInstance(), + this::broadcastLiveButtonUpdates, 50L, 50L); + } + + private void runFoliaLiveButtonTask() { + Bukkit.getAsyncScheduler().runAtFixedRate(ApolloExamplePlugin.getInstance(), + task -> this.broadcastLiveButtonUpdates(), 2500L, 2500L, TimeUnit.MILLISECONDS); + } + + private void broadcastLiveButtonUpdates() { + for (Player player : Bukkit.getOnlinePlayers()) { + UUID playerIdentifier = player.getUniqueId(); + + if (this.inventoryTrackingSeen && !this.openInventories.contains(playerIdentifier)) { + continue; + } + + this.sendLiveUpdates(player); + } + } + + private void sendLiveUpdates(Player player) { + UUID playerIdentifier = player.getUniqueId(); + + if (this.staffViewers.contains(playerIdentifier)) { + StaffLayout.sendUpdates(player); + } + + if (this.menuViewers.contains(playerIdentifier)) { + MenuLayout.sendBalanceUpdate(player); + } + + if (this.minigameViewers.contains(playerIdentifier)) { + MinigameLayout.sendKillsUpdate(player); + } + } + +} diff --git a/example/bukkit/json/src/main/java/com/lunarclient/apollo/example/json/module/NametagJsonExample.java b/example/bukkit/json/src/main/java/com/lunarclient/apollo/example/json/module/NametagJsonExample.java index 0b2f1de7..460b4cd5 100644 --- a/example/bukkit/json/src/main/java/com/lunarclient/apollo/example/json/module/NametagJsonExample.java +++ b/example/bukkit/json/src/main/java/com/lunarclient/apollo/example/json/module/NametagJsonExample.java @@ -58,6 +58,7 @@ public void overrideNametagExample(Player target) { message.addProperty("@type", "type.googleapis.com/lunarclient.apollo.nametag.v1.OverrideNametagMessage"); message.add("player_uuid", JsonUtil.createUuidObject(target.getUniqueId())); message.add("adventure_json_lines", lines); + message.addProperty("visibility_override", "NAMETAG_VISIBILITY_OVERRIDE_NONE"); JsonPacketUtil.broadcastPacket(message); } diff --git a/example/bukkit/json/src/main/java/com/lunarclient/apollo/example/json/module/chatbuttons/ChannelsLayout.java b/example/bukkit/json/src/main/java/com/lunarclient/apollo/example/json/module/chatbuttons/ChannelsLayout.java new file mode 100644 index 00000000..bbe87a8e --- /dev/null +++ b/example/bukkit/json/src/main/java/com/lunarclient/apollo/example/json/module/chatbuttons/ChannelsLayout.java @@ -0,0 +1,72 @@ +/* + * This file is part of Apollo, licensed under the MIT License. + * + * Copyright (c) 2026 Moonsworth + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +package com.lunarclient.apollo.example.json.module.chatbuttons; + +import com.google.gson.JsonObject; +import com.lunarclient.apollo.example.json.util.JsonPacketUtil; +import com.lunarclient.apollo.example.json.util.JsonUtil; +import net.kyori.adventure.text.Component; +import net.kyori.adventure.text.format.NamedTextColor; +import org.bukkit.entity.Player; + +public final class ChannelsLayout { + + public static void display(Player viewer) { + JsonObject teamChat = ChatButtonParts.createButtonObject("team-chat", 0, 2, 70, 16, + "BUTTON_SHAPE_ROUNDED_SQUARE", ChatButtonParts.BACKGROUND, ChatButtonParts.BORDER); + JsonObject teamChatButton = ChatButtonParts.button(teamChat); + teamChatButton.add("content", ChatButtonParts.createContentObject(1.0F, + ChatButtonParts.iconPart(JsonUtil.createItemStackIconObject("SHIELD", 0)), + ChatButtonParts.textPart(Component.text("Team Chat", NamedTextColor.GREEN)))); + teamChatButton.add("tooltip", ChatButtonParts.createTooltipObject( + Component.text("Click to switch!", NamedTextColor.YELLOW))); + teamChatButton.addProperty("run_command", "/channel team"); + + JsonObject publicChat = ChatButtonParts.createButtonObject("public-chat", 76, 2, 78, 16, + "BUTTON_SHAPE_ROUNDED_SQUARE", ChatButtonParts.BACKGROUND, ChatButtonParts.BORDER); + JsonObject publicChatButton = ChatButtonParts.button(publicChat); + publicChatButton.add("content", ChatButtonParts.createContentObject(1.0F, + ChatButtonParts.iconPart(JsonUtil.createItemStackIconObject("OAK_SIGN", 0)), + ChatButtonParts.textPart(Component.text("Public Chat")))); + publicChatButton.add("tooltip", ChatButtonParts.createTooltipObject( + Component.text("Click to switch!", NamedTextColor.YELLOW))); + publicChatButton.addProperty("run_command", "/channel public"); + + JsonObject partyChat = ChatButtonParts.createButtonObject("party-chat", 160, 2, 76, 16, + "BUTTON_SHAPE_ROUNDED_SQUARE", ChatButtonParts.BACKGROUND, ChatButtonParts.BORDER); + JsonObject partyChatButton = ChatButtonParts.button(partyChat); + partyChatButton.add("content", ChatButtonParts.createContentObject(1.0F, + ChatButtonParts.iconPart(JsonUtil.createItemStackIconObject("FIREWORK_ROCKET", 0)), + ChatButtonParts.textPart(Component.text("Party Chat", NamedTextColor.LIGHT_PURPLE)))); + partyChatButton.add("tooltip", ChatButtonParts.createTooltipObject( + Component.text("Click to switch!", NamedTextColor.YELLOW))); + partyChatButton.addProperty("run_command", "/channel party"); + + JsonPacketUtil.sendPacket(viewer, ChatButtonParts.createDisplayMessage(teamChat, publicChat, partyChat)); + } + + private ChannelsLayout() { + } + +} diff --git a/example/bukkit/json/src/main/java/com/lunarclient/apollo/example/json/module/chatbuttons/ChatButtonParts.java b/example/bukkit/json/src/main/java/com/lunarclient/apollo/example/json/module/chatbuttons/ChatButtonParts.java new file mode 100644 index 00000000..0a9ea131 --- /dev/null +++ b/example/bukkit/json/src/main/java/com/lunarclient/apollo/example/json/module/chatbuttons/ChatButtonParts.java @@ -0,0 +1,121 @@ +/* + * This file is part of Apollo, licensed under the MIT License. + * + * Copyright (c) 2026 Moonsworth + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +package com.lunarclient.apollo.example.json.module.chatbuttons; + +import com.google.gson.JsonArray; +import com.google.gson.JsonObject; +import com.lunarclient.apollo.example.json.util.AdventureUtil; +import com.lunarclient.apollo.example.json.util.JsonUtil; +import java.awt.Color; +import net.kyori.adventure.text.Component; + +public final class ChatButtonParts { + + public static final Color BACKGROUND = new Color(0, 0, 0, 128); + public static final Color BORDER = new Color(0, 0, 0, 128); + + public static JsonObject createDisplayMessage(JsonObject... buttons) { + JsonArray buttonsArray = new JsonArray(); + for (JsonObject button : buttons) { + buttonsArray.add(button); + } + + JsonObject message = new JsonObject(); + message.addProperty("@type", "type.googleapis.com/lunarclient.apollo.chat.v1.DisplayChatButtonsMessage"); + message.add("chat_buttons", buttonsArray); + + return message; + } + + public static JsonObject createButtonObject(String id, float x, float y, float width, float height, + String shape, Color backgroundColor, Color borderColor) { + JsonObject position = new JsonObject(); + position.addProperty("x", x); + position.addProperty("y", y); + + JsonObject size = new JsonObject(); + size.addProperty("width", width); + size.addProperty("height", height); + + JsonObject button = new JsonObject(); + button.addProperty("id", id); + button.add("position", position); + button.add("size", size); + button.addProperty("shape", shape); + button.add("background_color", JsonUtil.createColorObject(backgroundColor)); + button.add("border_color", JsonUtil.createColorObject(borderColor)); + + JsonObject wrapper = new JsonObject(); + wrapper.add("button", button); + + return wrapper; + } + + public static JsonObject button(JsonObject wrapper) { + return wrapper.getAsJsonObject("button"); + } + + public static JsonObject createContentObject(float scale, JsonObject... parts) { + JsonArray partsArray = new JsonArray(); + for (JsonObject part : parts) { + partsArray.add(part); + } + + JsonObject content = new JsonObject(); + content.add("parts", partsArray); + content.addProperty("scale", scale); + + return content; + } + + public static JsonObject createTooltipObject(Component... lines) { + JsonArray linesArray = new JsonArray(); + for (Component line : lines) { + linesArray.add(AdventureUtil.toJson(line)); + } + + JsonObject tooltip = new JsonObject(); + tooltip.add("adventure_json_lines", linesArray); + + return tooltip; + } + + public static JsonObject textPart(Component component) { + JsonObject part = new JsonObject(); + part.addProperty("adventure_json_text", AdventureUtil.toJson(component)); + + return part; + } + + public static JsonObject iconPart(JsonObject icon) { + JsonObject part = new JsonObject(); + part.add("icon", icon); + + return part; + } + + private ChatButtonParts() { + } + +} diff --git a/example/bukkit/json/src/main/java/com/lunarclient/apollo/example/json/module/chatbuttons/StaffChatLayout.java b/example/bukkit/json/src/main/java/com/lunarclient/apollo/example/json/module/chatbuttons/StaffChatLayout.java new file mode 100644 index 00000000..47960192 --- /dev/null +++ b/example/bukkit/json/src/main/java/com/lunarclient/apollo/example/json/module/chatbuttons/StaffChatLayout.java @@ -0,0 +1,93 @@ +/* + * This file is part of Apollo, licensed under the MIT License. + * + * Copyright (c) 2026 Moonsworth + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +package com.lunarclient.apollo.example.json.module.chatbuttons; + +import com.google.gson.JsonObject; +import com.lunarclient.apollo.example.json.util.JsonPacketUtil; +import com.lunarclient.apollo.example.json.util.JsonUtil; +import net.kyori.adventure.text.Component; +import net.kyori.adventure.text.format.NamedTextColor; +import org.bukkit.entity.Player; + +public final class StaffChatLayout { + + public static void display(Player viewer) { + JsonObject staffChat = ChatButtonParts.createButtonObject("staff-chat", 0, 2, 70, 16, + "BUTTON_SHAPE_ROUNDED_SQUARE", ChatButtonParts.BACKGROUND, ChatButtonParts.BORDER); + JsonObject staffChatButton = ChatButtonParts.button(staffChat); + staffChatButton.add("content", ChatButtonParts.createContentObject(1.0F, + ChatButtonParts.iconPart(JsonUtil.createItemStackIconObject("COMMAND_BLOCK", 0)), + ChatButtonParts.textPart(Component.text("Staff Chat", NamedTextColor.AQUA)))); + staffChatButton.add("tooltip", ChatButtonParts.createTooltipObject( + Component.text("Click to switch!", NamedTextColor.YELLOW))); + staffChatButton.addProperty("run_command", "/channel staff"); + + JsonObject publicChat = ChatButtonParts.createButtonObject("public-chat", 76, 2, 78, 16, + "BUTTON_SHAPE_ROUNDED_SQUARE", ChatButtonParts.BACKGROUND, ChatButtonParts.BORDER); + JsonObject publicChatButton = ChatButtonParts.button(publicChat); + publicChatButton.add("content", ChatButtonParts.createContentObject(1.0F, + ChatButtonParts.iconPart(JsonUtil.createItemStackIconObject("OAK_SIGN", 0)), + ChatButtonParts.textPart(Component.text("Public Chat")))); + publicChatButton.add("tooltip", ChatButtonParts.createTooltipObject( + Component.text("Click to switch!", NamedTextColor.YELLOW))); + publicChatButton.addProperty("run_command", "/channel public"); + + JsonObject clearChat = ChatButtonParts.createButtonObject("clear-chat", 160, 2, 44, 16, + "BUTTON_SHAPE_ROUNDED_SQUARE", ChatButtonParts.BACKGROUND, ChatButtonParts.BORDER); + JsonObject clearChatButton = ChatButtonParts.button(clearChat); + clearChatButton.add("content", ChatButtonParts.createContentObject(1.0F, + ChatButtonParts.iconPart(JsonUtil.createItemStackIconObject("SPONGE", 0)), + ChatButtonParts.textPart(Component.text("Clear", NamedTextColor.YELLOW)))); + clearChatButton.add("tooltip", ChatButtonParts.createTooltipObject( + Component.text("Clears the public chat", NamedTextColor.GRAY))); + clearChatButton.addProperty("run_command", "/clearchat"); + + JsonObject muteChat = ChatButtonParts.createButtonObject("mute-chat", 210, 2, 44, 16, + "BUTTON_SHAPE_ROUNDED_SQUARE", ChatButtonParts.BACKGROUND, ChatButtonParts.BORDER); + JsonObject muteChatButton = ChatButtonParts.button(muteChat); + muteChatButton.add("content", ChatButtonParts.createContentObject(1.0F, + ChatButtonParts.iconPart(JsonUtil.createItemStackIconObject("BARRIER", 0)), + ChatButtonParts.textPart(Component.text("Mute", NamedTextColor.RED)))); + muteChatButton.add("tooltip", ChatButtonParts.createTooltipObject( + Component.text("Mutes the public chat", NamedTextColor.GRAY))); + muteChatButton.addProperty("run_command", "/mutechat"); + + JsonObject unmuteChat = ChatButtonParts.createButtonObject("unmute-chat", 260, 2, 56, 16, + "BUTTON_SHAPE_ROUNDED_SQUARE", ChatButtonParts.BACKGROUND, ChatButtonParts.BORDER); + JsonObject unmuteChatButton = ChatButtonParts.button(unmuteChat); + unmuteChatButton.add("content", ChatButtonParts.createContentObject(1.0F, + ChatButtonParts.iconPart(JsonUtil.createItemStackIconObject("BELL", 0)), + ChatButtonParts.textPart(Component.text("Unmute", NamedTextColor.GREEN)))); + unmuteChatButton.add("tooltip", ChatButtonParts.createTooltipObject( + Component.text("Unmutes the public chat", NamedTextColor.GRAY))); + unmuteChatButton.addProperty("run_command", "/unmutechat"); + + JsonPacketUtil.sendPacket(viewer, ChatButtonParts.createDisplayMessage( + staffChat, publicChat, clearChat, muteChat, unmuteChat)); + } + + private StaffChatLayout() { + } + +} diff --git a/example/bukkit/json/src/main/java/com/lunarclient/apollo/example/json/module/inventorybuttons/HubLayout.java b/example/bukkit/json/src/main/java/com/lunarclient/apollo/example/json/module/inventorybuttons/HubLayout.java new file mode 100644 index 00000000..4fbe9f0b --- /dev/null +++ b/example/bukkit/json/src/main/java/com/lunarclient/apollo/example/json/module/inventorybuttons/HubLayout.java @@ -0,0 +1,142 @@ +/* + * This file is part of Apollo, licensed under the MIT License. + * + * Copyright (c) 2026 Moonsworth + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +package com.lunarclient.apollo.example.json.module.inventorybuttons; + +import com.google.gson.JsonObject; +import com.lunarclient.apollo.example.json.util.JsonPacketUtil; +import com.lunarclient.apollo.example.json.util.JsonUtil; +import java.awt.Color; +import java.util.UUID; +import net.kyori.adventure.text.Component; +import net.kyori.adventure.text.format.NamedTextColor; +import org.bukkit.entity.Player; + +public final class HubLayout { + + public static void display(Player viewer) { + JsonObject practice = InventoryButtonParts.createButtonObject("practice", + "INVENTORY_BUTTON_BOX_LEFT", 6, 8, 80, 26, + "BUTTON_SHAPE_ROUNDED_SQUARE", InventoryButtonParts.BACKGROUND, InventoryButtonParts.BORDER); + JsonObject practiceButton = InventoryButtonParts.button(practice); + JsonObject practiceIcon = JsonUtil.createItemStackIconObject("SPLASH_POTION", 0); + practiceIcon.getAsJsonObject("item_stack").addProperty("potion", "healing"); + practiceButton.add("content", InventoryButtonParts.createContentObject(1.0F, + InventoryButtonParts.iconPart(practiceIcon), + InventoryButtonParts.textPart(Component.text("Practice", NamedTextColor.LIGHT_PURPLE)))); + practiceButton.add("tooltip", InventoryButtonParts.createTooltipObject( + Component.text("Click to join!", NamedTextColor.YELLOW))); + practiceButton.addProperty("run_command", "/server practice"); + + JsonObject factions = InventoryButtonParts.createButtonObject("factions", + "INVENTORY_BUTTON_BOX_LEFT", 6, 40, 80, 26, + "BUTTON_SHAPE_ROUNDED_SQUARE", InventoryButtonParts.BACKGROUND, InventoryButtonParts.BORDER); + JsonObject factionsButton = InventoryButtonParts.button(factions); + factionsButton.add("content", InventoryButtonParts.createContentObject(1.0F, + InventoryButtonParts.iconPart(JsonUtil.createItemStackIconObject("TNT", 0)), + InventoryButtonParts.textPart(Component.text("Factions", NamedTextColor.RED)))); + factionsButton.add("tooltip", InventoryButtonParts.createTooltipObject( + Component.text("Click to join!", NamedTextColor.YELLOW))); + factionsButton.addProperty("run_command", "/server factions"); + + JsonObject bedWars = InventoryButtonParts.createButtonObject("bedwars", + "INVENTORY_BUTTON_BOX_LEFT", 6, 72, 80, 26, + "BUTTON_SHAPE_ROUNDED_SQUARE", InventoryButtonParts.BACKGROUND, InventoryButtonParts.BORDER); + JsonObject bedWarsButton = InventoryButtonParts.button(bedWars); + bedWarsButton.add("content", InventoryButtonParts.createContentObject(1.0F, + InventoryButtonParts.iconPart(JsonUtil.createItemStackIconObject("RED_BED", 0)), + InventoryButtonParts.textPart(Component.text("BedWars", NamedTextColor.AQUA)))); + bedWarsButton.add("tooltip", InventoryButtonParts.createTooltipObject( + Component.text("Click to join!", NamedTextColor.YELLOW))); + bedWarsButton.addProperty("run_command", "/server bedwars"); + + JsonObject soupPvP = InventoryButtonParts.createButtonObject("souppvp", + "INVENTORY_BUTTON_BOX_LEFT", 6, 104, 80, 26, + "BUTTON_SHAPE_ROUNDED_SQUARE", InventoryButtonParts.BACKGROUND, InventoryButtonParts.BORDER); + JsonObject soupPvPButton = InventoryButtonParts.button(soupPvP); + soupPvPButton.add("content", InventoryButtonParts.createContentObject(1.0F, + InventoryButtonParts.iconPart(JsonUtil.createItemStackIconObject("MUSHROOM_STEW", 0)), + InventoryButtonParts.textPart(Component.text("SoupPvP", NamedTextColor.GOLD)))); + soupPvPButton.add("tooltip", InventoryButtonParts.createTooltipObject( + Component.text("Click to join!", NamedTextColor.YELLOW))); + soupPvPButton.addProperty("run_command", "/server souppvp"); + + JsonObject profile = InventoryButtonParts.createButtonObject("profile", + "INVENTORY_BUTTON_BOX_RIGHT", 4, 4, 40, 40, + "BUTTON_SHAPE_CIRCLE", InventoryButtonParts.BACKGROUND, InventoryButtonParts.BORDER); + JsonObject profileButton = InventoryButtonParts.button(profile); + profileButton.add("content", InventoryButtonParts.createContentObject(1.0F, + InventoryButtonParts.iconPart(JsonUtil.createItemStackIconObject( + "PLAYER_HEAD", 0, null, // use "skull" for legacy with customModelData set to 3 + JsonUtil.createProfileObject( + UUID.fromString("f17627d8-1a97-487b-92ea-c04f413394bd"), + "e3RleHR1cmVzOntTS0lOOnt1cmw6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvOWQ4MjUwNWJjZjNiYTU5YzJiZTdlMmQzNmY0ZTJiZGE4MzZmMmZkMTk0YjYyMTJhMmExYzRiNGEyYTQ3MWUifX19", + "" + ) + )))); + profileButton.add("tooltip", InventoryButtonParts.createTooltipObject( + Component.text(viewer.getName(), NamedTextColor.GOLD), + Component.text("View your stats", NamedTextColor.GRAY))); + profileButton.addProperty("run_command", "/profile"); + + JsonObject settings = InventoryButtonParts.createButtonObject("settings", + "INVENTORY_BUTTON_BOX_RIGHT", 48, 4, 40, 40, + "BUTTON_SHAPE_CIRCLE", new Color(222, 160, 60, 85), new Color(255, 218, 150, 140)); + JsonObject settingsButton = InventoryButtonParts.button(settings); + settingsButton.add("content", InventoryButtonParts.createContentObject(1.0F, + InventoryButtonParts.iconPart(JsonUtil.createItemStackIconObject("COMPARATOR", 0)))); + settingsButton.add("tooltip", InventoryButtonParts.createTooltipObject( + Component.text("Settings", NamedTextColor.WHITE), + Component.text("Server preferences", NamedTextColor.GRAY))); + settingsButton.addProperty("run_command", "/settings"); + + JsonObject changelog = InventoryButtonParts.createButtonObject("changelog", + "INVENTORY_BUTTON_BOX_RIGHT", 6, 52, 80, 26, + "BUTTON_SHAPE_ROUNDED_SQUARE", InventoryButtonParts.BACKGROUND, InventoryButtonParts.BORDER); + JsonObject changelogButton = InventoryButtonParts.button(changelog); + changelogButton.add("content", InventoryButtonParts.createContentObject(1.0F, + InventoryButtonParts.iconPart(JsonUtil.createItemStackIconObject("WRITABLE_BOOK", 0)), + InventoryButtonParts.textPart(Component.text("Changelog")))); + changelogButton.add("tooltip", InventoryButtonParts.createTooltipObject( + Component.text("🌙 Apollo - v1.2.8", NamedTextColor.GOLD), + Component.empty(), + Component.text("• Released Markers Module", NamedTextColor.GRAY), + Component.text("• Added ALLOW_DIG_AND_USE & DISABLE_BLOCK_MISS_PENALTY", NamedTextColor.GRAY), + Component.text(" options to Combat Module", NamedTextColor.GRAY), + Component.text("• Added configurable Server Link Button placement", NamedTextColor.GRAY), + Component.text("• Added API option to auto-enable Staff Mods", NamedTextColor.GRAY), + Component.text(" when unlocked via the Staff Mod Module", NamedTextColor.GRAY), + Component.text("• Improved performance with various optimizations", NamedTextColor.GRAY), + Component.empty(), + Component.text("Read the full changelog at", NamedTextColor.YELLOW), + Component.text("https://github.com/LunarClient/Apollo/releases/tag/v1.2.8", NamedTextColor.YELLOW))); + changelogButton.addProperty("open_url", "https://github.com/LunarClient/Apollo/releases/tag/v1.2.8"); + + JsonPacketUtil.sendPacket(viewer, InventoryButtonParts.createDisplayMessage(practice, factions, + bedWars, soupPvP, profile, settings, changelog)); + } + + private HubLayout() { + } + +} diff --git a/example/bukkit/json/src/main/java/com/lunarclient/apollo/example/json/module/inventorybuttons/InventoryButtonParts.java b/example/bukkit/json/src/main/java/com/lunarclient/apollo/example/json/module/inventorybuttons/InventoryButtonParts.java new file mode 100644 index 00000000..8c7aca8c --- /dev/null +++ b/example/bukkit/json/src/main/java/com/lunarclient/apollo/example/json/module/inventorybuttons/InventoryButtonParts.java @@ -0,0 +1,137 @@ +/* + * This file is part of Apollo, licensed under the MIT License. + * + * Copyright (c) 2026 Moonsworth + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +package com.lunarclient.apollo.example.json.module.inventorybuttons; + +import com.google.gson.JsonArray; +import com.google.gson.JsonObject; +import com.lunarclient.apollo.example.json.util.AdventureUtil; +import com.lunarclient.apollo.example.json.util.JsonUtil; +import java.awt.Color; +import net.kyori.adventure.text.Component; + +public final class InventoryButtonParts { + + public static final Color BACKGROUND = new Color(255, 255, 255, 40); + public static final Color BORDER = new Color(37, 37, 37, 128); + + public static JsonObject createDisplayMessage(JsonObject... buttons) { + JsonArray buttonsArray = new JsonArray(); + for (JsonObject button : buttons) { + buttonsArray.add(button); + } + + JsonObject message = new JsonObject(); + message.addProperty("@type", "type.googleapis.com/lunarclient.apollo.inventory.v1.DisplayInventoryButtonsMessage"); + message.add("inventory_buttons", buttonsArray); + + return message; + } + + public static JsonObject createUpdateMessage(String id, JsonObject content, JsonObject tooltip) { + JsonObject update = new JsonObject(); + update.add("content", content); + if (tooltip != null) { + update.add("tooltip", tooltip); + } + + JsonObject message = new JsonObject(); + message.addProperty("@type", "type.googleapis.com/lunarclient.apollo.inventory.v1.UpdateInventoryButtonMessage"); + message.addProperty("id", id); + message.add("update", update); + + return message; + } + + public static JsonObject createButtonObject(String id, String box, float x, float y, float width, float height, + String shape, Color backgroundColor, Color borderColor) { + JsonObject position = new JsonObject(); + position.addProperty("x", x); + position.addProperty("y", y); + + JsonObject size = new JsonObject(); + size.addProperty("width", width); + size.addProperty("height", height); + + JsonObject button = new JsonObject(); + button.addProperty("id", id); + button.add("position", position); + button.add("size", size); + button.addProperty("shape", shape); + button.add("background_color", JsonUtil.createColorObject(backgroundColor)); + button.add("border_color", JsonUtil.createColorObject(borderColor)); + + JsonObject wrapper = new JsonObject(); + wrapper.add("button", button); + wrapper.addProperty("box", box); + + return wrapper; + } + + public static JsonObject button(JsonObject wrapper) { + return wrapper.getAsJsonObject("button"); + } + + public static JsonObject createContentObject(float scale, JsonObject... parts) { + JsonArray partsArray = new JsonArray(); + for (JsonObject part : parts) { + partsArray.add(part); + } + + JsonObject content = new JsonObject(); + content.add("parts", partsArray); + content.addProperty("scale", scale); + + return content; + } + + public static JsonObject createTooltipObject(Component... lines) { + JsonArray linesArray = new JsonArray(); + for (Component line : lines) { + linesArray.add(AdventureUtil.toJson(line)); + } + + JsonObject tooltip = new JsonObject(); + tooltip.add("adventure_json_lines", linesArray); + + return tooltip; + } + + public static JsonObject textPart(Component component) { + JsonObject part = new JsonObject(); + part.addProperty("adventure_json_text", AdventureUtil.toJson(component)); + + return part; + } + + public static JsonObject iconPart(JsonObject icon) { + JsonObject part = new JsonObject(); + part.add("icon", icon); + + return part; + } + + private InventoryButtonParts() { + } + +} diff --git a/example/bukkit/json/src/main/java/com/lunarclient/apollo/example/json/module/inventorybuttons/MenuLayout.java b/example/bukkit/json/src/main/java/com/lunarclient/apollo/example/json/module/inventorybuttons/MenuLayout.java new file mode 100644 index 00000000..03c6b061 --- /dev/null +++ b/example/bukkit/json/src/main/java/com/lunarclient/apollo/example/json/module/inventorybuttons/MenuLayout.java @@ -0,0 +1,187 @@ +/* + * This file is part of Apollo, licensed under the MIT License. + * + * Copyright (c) 2026 Moonsworth + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +package com.lunarclient.apollo.example.json.module.inventorybuttons; + +import com.google.gson.JsonObject; +import com.lunarclient.apollo.example.json.util.JsonPacketUtil; +import com.lunarclient.apollo.example.json.util.JsonUtil; +import java.awt.Color; +import java.util.UUID; +import net.kyori.adventure.text.Component; +import net.kyori.adventure.text.format.NamedTextColor; +import org.bukkit.entity.Player; + +public final class MenuLayout { + + public static void display(Player viewer) { + JsonObject shop = InventoryButtonParts.createButtonObject("shop", + "INVENTORY_BUTTON_BOX_LEFT", 4, 4, 40, 40, + "BUTTON_SHAPE_ROUNDED_SQUARE", InventoryButtonParts.BACKGROUND, InventoryButtonParts.BORDER); + shop.addProperty("inventory_type", "INVENTORY_TYPE_PLAYER"); + JsonObject shopButton = InventoryButtonParts.button(shop); + shopButton.add("content", InventoryButtonParts.createContentObject(1.0F, + InventoryButtonParts.iconPart(JsonUtil.createItemStackIconObject("EMERALD", 0)))); + shopButton.add("tooltip", InventoryButtonParts.createTooltipObject( + Component.text("Shop", NamedTextColor.GREEN), + Component.text("Browse categories and buy items", NamedTextColor.GRAY), + Component.text("Click to open", NamedTextColor.YELLOW))); + shopButton.addProperty("run_command", "/shop"); + + JsonObject spawn = InventoryButtonParts.createButtonObject("spawn", + "INVENTORY_BUTTON_BOX_LEFT", 48, 4, 40, 40, + "BUTTON_SHAPE_ROUNDED_SQUARE", InventoryButtonParts.BACKGROUND, InventoryButtonParts.BORDER); + JsonObject spawnButton = InventoryButtonParts.button(spawn); + spawnButton.add("content", InventoryButtonParts.createContentObject(1.0F, + InventoryButtonParts.iconPart(JsonUtil.createItemStackIconObject("RED_BED", 0)))); + spawnButton.add("tooltip", InventoryButtonParts.createTooltipObject( + Component.text("Spawn", NamedTextColor.AQUA), + Component.text("Teleport back to spawn", NamedTextColor.GRAY), + Component.text("Click to teleport", NamedTextColor.YELLOW))); + spawnButton.addProperty("run_command", "/spawn"); + + JsonObject warps = InventoryButtonParts.createButtonObject("warps", + "INVENTORY_BUTTON_BOX_LEFT", 4, 48, 40, 40, + "BUTTON_SHAPE_ROUNDED_SQUARE", InventoryButtonParts.BACKGROUND, InventoryButtonParts.BORDER); + JsonObject warpsButton = InventoryButtonParts.button(warps); + warpsButton.add("content", InventoryButtonParts.createContentObject(1.0F, + InventoryButtonParts.iconPart(JsonUtil.createItemStackIconObject("COMPASS", 0)))); + warpsButton.add("tooltip", InventoryButtonParts.createTooltipObject( + Component.text("Warps", NamedTextColor.AQUA), + Component.text("Browse public warps", NamedTextColor.GRAY), + Component.text("Click to teleport", NamedTextColor.YELLOW))); + warpsButton.addProperty("run_command", "/warps"); + + JsonObject enderChest = InventoryButtonParts.createButtonObject("enderchest", + "INVENTORY_BUTTON_BOX_LEFT", 48, 48, 40, 40, + "BUTTON_SHAPE_ROUNDED_SQUARE", InventoryButtonParts.BACKGROUND, InventoryButtonParts.BORDER); + JsonObject enderChestButton = InventoryButtonParts.button(enderChest); + enderChestButton.add("content", InventoryButtonParts.createContentObject(1.0F, + InventoryButtonParts.iconPart(JsonUtil.createItemStackIconObject("ENDER_CHEST", 0)))); + enderChestButton.add("tooltip", InventoryButtonParts.createTooltipObject( + Component.text("Ender Chest", NamedTextColor.LIGHT_PURPLE), + Component.text("Open your personal storage", NamedTextColor.GRAY), + Component.text("Click to open", NamedTextColor.YELLOW))); + enderChestButton.addProperty("run_command", "/enderchest"); + + JsonObject balance = InventoryButtonParts.createButtonObject("balance", + "INVENTORY_BUTTON_BOX_LEFT", 6, 92, 80, 26, + "BUTTON_SHAPE_ROUNDED_SQUARE", InventoryButtonParts.BACKGROUND, InventoryButtonParts.BORDER); + JsonObject balanceButton = InventoryButtonParts.button(balance); + balanceButton.add("content", InventoryButtonParts.createContentObject(1.0F, + InventoryButtonParts.iconPart(JsonUtil.createItemStackIconObject("GOLD_INGOT", 0)), + InventoryButtonParts.textPart(balanceContent(viewer)))); + balanceButton.add("tooltip", InventoryButtonParts.createTooltipObject( + Component.text("Your balance", NamedTextColor.GOLD))); + + JsonObject profile = InventoryButtonParts.createButtonObject("profile", + "INVENTORY_BUTTON_BOX_RIGHT", 4, 4, 40, 40, + "BUTTON_SHAPE_CIRCLE", InventoryButtonParts.BACKGROUND, InventoryButtonParts.BORDER); + JsonObject profileButton = InventoryButtonParts.button(profile); + profileButton.add("content", InventoryButtonParts.createContentObject(1.0F, + InventoryButtonParts.iconPart(JsonUtil.createItemStackIconObject( + "PLAYER_HEAD", 0, null, // use "skull" for legacy with customModelData set to 3 + JsonUtil.createProfileObject( + UUID.fromString("f17627d8-1a97-487b-92ea-c04f413394bd"), + "e3RleHR1cmVzOntTS0lOOnt1cmw6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvOWQ4MjUwNWJjZjNiYTU5YzJiZTdlMmQzNmY0ZTJiZGE4MzZmMmZkMTk0YjYyMTJhMmExYzRiNGEyYTQ3MWUifX19", + "" + ) + )))); + profileButton.add("tooltip", InventoryButtonParts.createTooltipObject( + Component.text(viewer.getName(), NamedTextColor.GOLD), + Component.text("View your stats", NamedTextColor.GRAY))); + profileButton.addProperty("run_command", "/profile"); + + JsonObject settings = InventoryButtonParts.createButtonObject("settings", + "INVENTORY_BUTTON_BOX_RIGHT", 48, 4, 40, 40, + "BUTTON_SHAPE_CIRCLE", new Color(222, 160, 60, 85), new Color(255, 218, 150, 140)); + JsonObject settingsButton = InventoryButtonParts.button(settings); + settingsButton.add("content", InventoryButtonParts.createContentObject(1.0F, + InventoryButtonParts.iconPart(JsonUtil.createItemStackIconObject("COMPARATOR", 0)))); + settingsButton.add("tooltip", InventoryButtonParts.createTooltipObject( + Component.text("Settings", NamedTextColor.WHITE), + Component.text("Server preferences", NamedTextColor.GRAY))); + settingsButton.addProperty("run_command", "/settings"); + + JsonObject vote = InventoryButtonParts.createButtonObject("vote", + "INVENTORY_BUTTON_BOX_RIGHT", 6, 52, 80, 26, + "BUTTON_SHAPE_ROUNDED_SQUARE", new Color(34, 204, 68, 64), new Color(190, 255, 205, 110)); + JsonObject voteButton = InventoryButtonParts.button(vote); + voteButton.add("hovered_background_color", JsonUtil.createColorObject(new Color(34, 204, 68, 130))); + voteButton.add("hovered_border_color", JsonUtil.createColorObject(new Color(190, 255, 205, 210))); + voteButton.add("content", InventoryButtonParts.createContentObject(1.0F, + InventoryButtonParts.textPart(Component.text("Vote")))); + voteButton.add("tooltip", InventoryButtonParts.createTooltipObject( + Component.text("Vote", NamedTextColor.GREEN), + Component.text("Vote daily for rewards", NamedTextColor.GRAY))); + voteButton.addProperty("open_url", "https://example.com/vote"); + + JsonObject discord = InventoryButtonParts.createButtonObject("discord", + "INVENTORY_BUTTON_BOX_RIGHT", 6, 84, 80, 26, + "BUTTON_SHAPE_ROUNDED_SQUARE", new Color(88, 101, 242, 90), new Color(150, 160, 250, 140)); + JsonObject discordButton = InventoryButtonParts.button(discord); + discordButton.add("content", InventoryButtonParts.createContentObject(1.0F, + InventoryButtonParts.textPart(Component.text("Discord")))); + discordButton.add("tooltip", InventoryButtonParts.createTooltipObject( + Component.text("Discord", NamedTextColor.BLUE), + Component.text("Join our community", NamedTextColor.GRAY))); + discordButton.addProperty("open_url", "https://lunarclient.dev/discord"); + + JsonObject lobby = InventoryButtonParts.createButtonObject("lobby", + "INVENTORY_BUTTON_BOX_RIGHT", 6, 136, 80, 26, + "BUTTON_SHAPE_ROUNDED_SQUARE", new Color(224, 64, 64, 128), new Color(255, 200, 200, 140)); + JsonObject lobbyButton = InventoryButtonParts.button(lobby); + lobbyButton.add("content", InventoryButtonParts.createContentObject(1.0F, + InventoryButtonParts.textPart(Component.text("Back to Lobby")))); + lobbyButton.add("tooltip", InventoryButtonParts.createTooltipObject( + Component.text("Back to Lobby", NamedTextColor.RED), + Component.text("Return to the main lobby", NamedTextColor.GRAY))); + lobbyButton.addProperty("run_command", "/lobby"); + + JsonPacketUtil.sendPacket(viewer, InventoryButtonParts.createDisplayMessage( + shop, spawn, warps, enderChest, balance, profile, settings, vote, discord, lobby)); + } + + public static void sendBalanceUpdate(Player viewer) { + JsonPacketUtil.sendPacket(viewer, InventoryButtonParts.createUpdateMessage("balance", + InventoryButtonParts.createContentObject(1.0F, + InventoryButtonParts.iconPart(JsonUtil.createItemStackIconObject("GOLD_INGOT", 0)), + InventoryButtonParts.textPart(balanceContent(viewer))), + InventoryButtonParts.createTooltipObject( + Component.text("Your balance", NamedTextColor.GOLD)))); + } + + private static Component balanceContent(Player viewer) { + return Component.text("$" + String.format("%,d", getBalance(viewer.getUniqueId())), NamedTextColor.GOLD); + } + + // Demo economy: replace with your economy plugin lookup (e.g. Vault) + private static long getBalance(UUID playerIdentifier) { + long drift = (System.currentTimeMillis() / 10_000L) % 250L; + return 1_000L + Math.abs(playerIdentifier.hashCode() % 4_000) + drift; + } + + private MenuLayout() { + } + +} diff --git a/example/bukkit/json/src/main/java/com/lunarclient/apollo/example/json/module/inventorybuttons/MinigameLayout.java b/example/bukkit/json/src/main/java/com/lunarclient/apollo/example/json/module/inventorybuttons/MinigameLayout.java new file mode 100644 index 00000000..caa17ff0 --- /dev/null +++ b/example/bukkit/json/src/main/java/com/lunarclient/apollo/example/json/module/inventorybuttons/MinigameLayout.java @@ -0,0 +1,142 @@ +/* + * This file is part of Apollo, licensed under the MIT License. + * + * Copyright (c) 2026 Moonsworth + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +package com.lunarclient.apollo.example.json.module.inventorybuttons; + +import com.google.gson.JsonObject; +import com.lunarclient.apollo.example.json.util.JsonPacketUtil; +import com.lunarclient.apollo.example.json.util.JsonUtil; +import java.awt.Color; +import java.util.UUID; +import net.kyori.adventure.text.Component; +import net.kyori.adventure.text.format.NamedTextColor; +import org.bukkit.Statistic; +import org.bukkit.entity.Player; + +public final class MinigameLayout { + + public static void display(Player viewer) { + JsonObject mapInfo = InventoryButtonParts.createButtonObject("map-info", + "INVENTORY_BUTTON_BOX_LEFT", 6, 8, 80, 26, + "BUTTON_SHAPE_ROUNDED_SQUARE", InventoryButtonParts.BACKGROUND, InventoryButtonParts.BORDER); + JsonObject mapInfoButton = InventoryButtonParts.button(mapInfo); + mapInfoButton.add("content", InventoryButtonParts.createContentObject(1.0F, + InventoryButtonParts.textPart(Component.text("Map: Apollo", NamedTextColor.AQUA)))); + mapInfoButton.add("tooltip", InventoryButtonParts.createTooltipObject( + Component.text("Built by the Lunar Client Team"), + Component.text("Released in 2024", NamedTextColor.GRAY))); + + JsonObject kills = InventoryButtonParts.createButtonObject("kills", + "INVENTORY_BUTTON_BOX_LEFT", 6, 40, 80, 26, + "BUTTON_SHAPE_ROUNDED_SQUARE", InventoryButtonParts.BACKGROUND, InventoryButtonParts.BORDER); + JsonObject killsButton = InventoryButtonParts.button(kills); + killsButton.add("content", InventoryButtonParts.createContentObject(1.0F, + InventoryButtonParts.iconPart(JsonUtil.createItemStackIconObject("IRON_SWORD", 0)), + InventoryButtonParts.textPart(killsContent(viewer)))); + + JsonObject lobby = InventoryButtonParts.createButtonObject("lobby", + "INVENTORY_BUTTON_BOX_RIGHT", 6, 136, 80, 26, + "BUTTON_SHAPE_ROUNDED_SQUARE", + new Color(224, 64, 64, 128), new Color(255, 200, 200, 140)); + JsonObject lobbyButton = InventoryButtonParts.button(lobby); + lobbyButton.add("content", InventoryButtonParts.createContentObject(1.0F, + InventoryButtonParts.textPart(Component.text("Back to Lobby")))); + lobbyButton.add("tooltip", InventoryButtonParts.createTooltipObject( + Component.text("Back to Lobby", NamedTextColor.RED), + Component.text("Return to the main lobby", NamedTextColor.GRAY))); + lobbyButton.addProperty("run_command", "/lobby"); + + JsonObject profile = InventoryButtonParts.createButtonObject("profile", + "INVENTORY_BUTTON_BOX_RIGHT", 4, 4, 40, 40, + "BUTTON_SHAPE_CIRCLE", InventoryButtonParts.BACKGROUND, InventoryButtonParts.BORDER); + JsonObject profileButton = InventoryButtonParts.button(profile); + profileButton.add("content", InventoryButtonParts.createContentObject(1.0F, + InventoryButtonParts.iconPart(JsonUtil.createItemStackIconObject( + "PLAYER_HEAD", 0, null, // use "skull" for legacy with customModelData set to 3 + JsonUtil.createProfileObject( + UUID.fromString("f17627d8-1a97-487b-92ea-c04f413394bd"), + "e3RleHR1cmVzOntTS0lOOnt1cmw6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvOWQ4MjUwNWJjZjNiYTU5YzJiZTdlMmQzNmY0ZTJiZGE4MzZmMmZkMTk0YjYyMTJhMmExYzRiNGEyYTQ3MWUifX19", + "" + ) + )))); + profileButton.add("tooltip", InventoryButtonParts.createTooltipObject( + Component.text(viewer.getName(), NamedTextColor.GOLD), + Component.text("View your stats", NamedTextColor.GRAY))); + profileButton.addProperty("run_command", "/profile"); + + JsonObject settings = InventoryButtonParts.createButtonObject("settings", + "INVENTORY_BUTTON_BOX_RIGHT", 48, 4, 40, 40, + "BUTTON_SHAPE_CIRCLE", new Color(222, 160, 60, 85), new Color(255, 218, 150, 140)); + JsonObject settingsButton = InventoryButtonParts.button(settings); + settingsButton.add("content", InventoryButtonParts.createContentObject(1.0F, + InventoryButtonParts.iconPart(JsonUtil.createItemStackIconObject("COMPARATOR", 0)))); + settingsButton.add("tooltip", InventoryButtonParts.createTooltipObject( + Component.text("Settings", NamedTextColor.WHITE), + Component.text("Server preferences", NamedTextColor.GRAY))); + settingsButton.addProperty("run_command", "/settings"); + + JsonObject showMap = InventoryButtonParts.createButtonObject("show-map", + "INVENTORY_BUTTON_BOX_RIGHT", 6, 52, 80, 26, + "BUTTON_SHAPE_ROUNDED_SQUARE", InventoryButtonParts.BACKGROUND, InventoryButtonParts.BORDER); + JsonObject showMapButton = InventoryButtonParts.button(showMap); + showMapButton.add("content", InventoryButtonParts.createContentObject(1.0F, + InventoryButtonParts.iconPart(JsonUtil.createItemStackIconObject("FILLED_MAP", 0)), + InventoryButtonParts.textPart(Component.text("Show Map")))); + showMapButton.add("tooltip", InventoryButtonParts.createTooltipObject( + Component.text("Show Map", NamedTextColor.AQUA), + Component.text("Open the fullscreen minimap view", NamedTextColor.GRAY))); + showMapButton.addProperty("client_action", "BUTTON_CLIENT_ACTION_OPEN_MINIMAP_VIEW"); + + JsonObject waypoints = InventoryButtonParts.createButtonObject("waypoints", + "INVENTORY_BUTTON_BOX_RIGHT", 6, 84, 80, 26, + "BUTTON_SHAPE_ROUNDED_SQUARE", InventoryButtonParts.BACKGROUND, InventoryButtonParts.BORDER); + JsonObject waypointsButton = InventoryButtonParts.button(waypoints); + waypointsButton.add("content", InventoryButtonParts.createContentObject(1.0F, + InventoryButtonParts.iconPart(JsonUtil.createItemStackIconObject("LODESTONE", 0)), + InventoryButtonParts.textPart(Component.text("Waypoints")))); + waypointsButton.add("tooltip", InventoryButtonParts.createTooltipObject( + Component.text("Waypoints", NamedTextColor.GOLD), + Component.text("Manage your waypoints", NamedTextColor.GRAY))); + waypointsButton.addProperty("client_action", "BUTTON_CLIENT_ACTION_OPEN_WAYPOINTS_MENU"); + + JsonPacketUtil.sendPacket(viewer, InventoryButtonParts.createDisplayMessage(mapInfo, kills, + lobby, profile, settings, showMap, waypoints)); + } + + public static void sendKillsUpdate(Player viewer) { + JsonPacketUtil.sendPacket(viewer, InventoryButtonParts.createUpdateMessage("kills", + InventoryButtonParts.createContentObject(1.0F, + InventoryButtonParts.iconPart(JsonUtil.createItemStackIconObject("IRON_SWORD", 0)), + InventoryButtonParts.textPart(killsContent(viewer))), + null)); + } + + private static Component killsContent(Player viewer) { + return Component.text("Kills: ", NamedTextColor.GRAY) + .append(Component.text(viewer.getStatistic(Statistic.PLAYER_KILLS), NamedTextColor.RED)); + } + + private MinigameLayout() { + } + +} diff --git a/example/bukkit/json/src/main/java/com/lunarclient/apollo/example/json/module/inventorybuttons/StaffLayout.java b/example/bukkit/json/src/main/java/com/lunarclient/apollo/example/json/module/inventorybuttons/StaffLayout.java new file mode 100644 index 00000000..106be888 --- /dev/null +++ b/example/bukkit/json/src/main/java/com/lunarclient/apollo/example/json/module/inventorybuttons/StaffLayout.java @@ -0,0 +1,255 @@ +/* + * This file is part of Apollo, licensed under the MIT License. + * + * Copyright (c) 2026 Moonsworth + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +package com.lunarclient.apollo.example.json.module.inventorybuttons; + +import com.google.gson.JsonObject; +import com.lunarclient.apollo.example.json.util.JsonPacketUtil; +import com.lunarclient.apollo.example.json.util.JsonUtil; +import com.lunarclient.apollo.example.util.ServerStatsUtil; +import java.time.LocalTime; +import java.time.format.DateTimeFormatter; +import net.kyori.adventure.text.Component; +import net.kyori.adventure.text.format.NamedTextColor; +import net.kyori.adventure.text.format.TextDecoration; +import org.bukkit.Bukkit; +import org.bukkit.entity.Player; + +public final class StaffLayout { + + private static final DateTimeFormatter TIME_FORMAT = DateTimeFormatter.ofPattern("HH:mm:ss"); + + public static void display(Player viewer) { + JsonObject players = InventoryButtonParts.createButtonObject("players", + "INVENTORY_BUTTON_BOX_LEFT", 6, 8, 80, 26, + "BUTTON_SHAPE_ROUNDED_SQUARE", InventoryButtonParts.BACKGROUND, InventoryButtonParts.BORDER); + JsonObject playersButton = InventoryButtonParts.button(players); + playersButton.add("content", InventoryButtonParts.createContentObject(1.0F, + InventoryButtonParts.textPart(playersContent()))); + playersButton.add("tooltip", playersTooltipObject()); + + JsonObject tps = InventoryButtonParts.createButtonObject("tps", + "INVENTORY_BUTTON_BOX_LEFT", 6, 40, 80, 26, + "BUTTON_SHAPE_ROUNDED_SQUARE", InventoryButtonParts.BACKGROUND, InventoryButtonParts.BORDER); + JsonObject tpsButton = InventoryButtonParts.button(tps); + tpsButton.add("content", InventoryButtonParts.createContentObject(1.0F, + InventoryButtonParts.textPart(tpsContent()))); + tpsButton.add("tooltip", tpsTooltipObject()); + + JsonObject cpu = InventoryButtonParts.createButtonObject("cpu", + "INVENTORY_BUTTON_BOX_LEFT", 6, 72, 80, 26, + "BUTTON_SHAPE_ROUNDED_SQUARE", InventoryButtonParts.BACKGROUND, InventoryButtonParts.BORDER); + JsonObject cpuButton = InventoryButtonParts.button(cpu); + cpuButton.add("content", InventoryButtonParts.createContentObject(1.0F, + InventoryButtonParts.textPart(cpuContent()))); + cpuButton.add("tooltip", cpuTooltipObject()); + + JsonObject ram = InventoryButtonParts.createButtonObject("ram", + "INVENTORY_BUTTON_BOX_LEFT", 6, 104, 80, 26, + "BUTTON_SHAPE_ROUNDED_SQUARE", InventoryButtonParts.BACKGROUND, InventoryButtonParts.BORDER); + JsonObject ramButton = InventoryButtonParts.button(ram); + ramButton.add("content", InventoryButtonParts.createContentObject(1.0F, + InventoryButtonParts.textPart(ramContent()))); + ramButton.add("tooltip", ramTooltipObject()); + + JsonObject survival = InventoryButtonParts.createButtonObject("survival", + "INVENTORY_BUTTON_BOX_RIGHT", 6, 8, 80, 26, + "BUTTON_SHAPE_ROUNDED_SQUARE", InventoryButtonParts.BACKGROUND, InventoryButtonParts.BORDER); + JsonObject survivalButton = InventoryButtonParts.button(survival); + survivalButton.add("content", InventoryButtonParts.createContentObject(1.0F, + InventoryButtonParts.iconPart(JsonUtil.createItemStackIconObject("IRON_SWORD", 0)), + InventoryButtonParts.textPart(Component.text("Survival")))); + survivalButton.add("tooltip", InventoryButtonParts.createTooltipObject( + Component.text("Click to switch!", NamedTextColor.YELLOW))); + survivalButton.addProperty("run_command", "/gamemode survival"); + + JsonObject creative = InventoryButtonParts.createButtonObject("creative", + "INVENTORY_BUTTON_BOX_RIGHT", 6, 40, 80, 26, + "BUTTON_SHAPE_ROUNDED_SQUARE", InventoryButtonParts.BACKGROUND, InventoryButtonParts.BORDER); + JsonObject creativeButton = InventoryButtonParts.button(creative); + creativeButton.add("content", InventoryButtonParts.createContentObject(1.0F, + InventoryButtonParts.iconPart(JsonUtil.createItemStackIconObject("GRASS_BLOCK", 0)), + InventoryButtonParts.textPart(Component.text("Creative")))); + creativeButton.add("tooltip", InventoryButtonParts.createTooltipObject( + Component.text("Click to switch!", NamedTextColor.YELLOW))); + creativeButton.addProperty("run_command", "/gamemode creative"); + + JsonObject adventure = InventoryButtonParts.createButtonObject("adventure", + "INVENTORY_BUTTON_BOX_RIGHT", 6, 72, 80, 26, + "BUTTON_SHAPE_ROUNDED_SQUARE", InventoryButtonParts.BACKGROUND, InventoryButtonParts.BORDER); + JsonObject adventureButton = InventoryButtonParts.button(adventure); + adventureButton.add("content", InventoryButtonParts.createContentObject(1.0F, + InventoryButtonParts.iconPart(JsonUtil.createItemStackIconObject("FILLED_MAP", 0)), + InventoryButtonParts.textPart(Component.text("Adventure")))); + adventureButton.add("tooltip", InventoryButtonParts.createTooltipObject( + Component.text("Click to switch!", NamedTextColor.YELLOW))); + adventureButton.addProperty("run_command", "/gamemode adventure"); + + JsonObject spectator = InventoryButtonParts.createButtonObject("spectator", + "INVENTORY_BUTTON_BOX_RIGHT", 6, 104, 80, 26, + "BUTTON_SHAPE_ROUNDED_SQUARE", InventoryButtonParts.BACKGROUND, InventoryButtonParts.BORDER); + JsonObject spectatorButton = InventoryButtonParts.button(spectator); + spectatorButton.add("content", InventoryButtonParts.createContentObject(1.0F, + InventoryButtonParts.iconPart(JsonUtil.createItemStackIconObject("ENDER_EYE", 0)), + InventoryButtonParts.textPart(Component.text("Spectator")))); + spectatorButton.add("tooltip", InventoryButtonParts.createTooltipObject( + Component.text("Click to switch!", NamedTextColor.YELLOW))); + spectatorButton.addProperty("run_command", "/gamemode spectator"); + + JsonPacketUtil.sendPacket(viewer, InventoryButtonParts.createDisplayMessage( + players, tps, cpu, ram, survival, creative, adventure, spectator)); + } + + public static void sendUpdates(Player viewer) { + JsonPacketUtil.sendPacket(viewer, InventoryButtonParts.createUpdateMessage("players", + InventoryButtonParts.createContentObject(1.0F, InventoryButtonParts.textPart(playersContent())), + playersTooltipObject())); + + JsonPacketUtil.sendPacket(viewer, InventoryButtonParts.createUpdateMessage("tps", + InventoryButtonParts.createContentObject(1.0F, InventoryButtonParts.textPart(tpsContent())), + tpsTooltipObject())); + + JsonPacketUtil.sendPacket(viewer, InventoryButtonParts.createUpdateMessage("cpu", + InventoryButtonParts.createContentObject(1.0F, InventoryButtonParts.textPart(cpuContent())), + cpuTooltipObject())); + + JsonPacketUtil.sendPacket(viewer, InventoryButtonParts.createUpdateMessage("ram", + InventoryButtonParts.createContentObject(1.0F, InventoryButtonParts.textPart(ramContent())), + ramTooltipObject())); + } + + private static Component playersContent() { + return Component.text("Players: ", NamedTextColor.GRAY) + .append(Component.text(Bukkit.getOnlinePlayers().size(), NamedTextColor.GREEN)); + } + + private static JsonObject playersTooltipObject() { + return InventoryButtonParts.createTooltipObject( + Component.text("Players currently online", NamedTextColor.GRAY), + Component.empty(), + refreshedLine()); + } + + private static JsonObject ramTooltipObject() { + return InventoryButtonParts.createTooltipObject( + Component.text("Used: ", NamedTextColor.GRAY) + .append(Component.text(ServerStatsUtil.getUsedRamMb() + " MB", NamedTextColor.WHITE)), + Component.text("Max: ", NamedTextColor.GRAY) + .append(Component.text(ServerStatsUtil.getMaxRamMb() + " MB", NamedTextColor.WHITE)), + Component.empty(), + refreshedLine()); + } + + private static Component tpsContent() { + double[] tps = ServerStatsUtil.getTps(); + if (tps == null || tps.length == 0) { + return Component.text("TPS: N/A", NamedTextColor.GRAY); + } + + double recent = Math.min(20.0D, tps[0]); + NamedTextColor color = recent >= 18.0D ? NamedTextColor.GREEN + : recent >= 15.0D ? NamedTextColor.YELLOW : NamedTextColor.RED; + return Component.text("TPS: ", NamedTextColor.GRAY) + .append(Component.text(String.format("%.1f", recent), color)); + } + + private static Component cpuContent() { + double load = ServerStatsUtil.getSystemLoadAverage(); + if (load < 0.0D) { + return Component.text("CPU: N/A", NamedTextColor.GRAY); + } + + double perCore = load / ServerStatsUtil.getAvailableProcessors(); + NamedTextColor color = perCore < 0.5D ? NamedTextColor.GREEN + : perCore < 1.0D ? NamedTextColor.YELLOW : NamedTextColor.RED; + return Component.text("CPU: ", NamedTextColor.GRAY) + .append(Component.text(String.format("%.2f", load), color)); + } + + private static Component ramContent() { + long used = ServerStatsUtil.getUsedRamMb(); + long max = ServerStatsUtil.getMaxRamMb(); + long percent = max <= 0 ? 0 : used * 100 / max; + + NamedTextColor color = percent < 60 ? NamedTextColor.GREEN + : percent < 85 ? NamedTextColor.YELLOW : NamedTextColor.RED; + return Component.text("RAM: ", NamedTextColor.GRAY) + .append(Component.text(percent + "%", color)); + } + + private static JsonObject tpsTooltipObject() { + double[] tps = ServerStatsUtil.getTps(); + if (tps == null || tps.length < 3) { + return InventoryButtonParts.createTooltipObject( + Component.text("TPS averages require a Paper based server", NamedTextColor.GRAY), + Component.empty(), + refreshedLine()); + } + + return InventoryButtonParts.createTooltipObject( + tpsAverageLine("1m", tps[0]), + tpsAverageLine("5m", tps[1]), + tpsAverageLine("15m", tps[2]), + Component.empty(), + refreshedLine()); + } + + private static Component tpsAverageLine(String window, double average) { + double tps = Math.min(20.0D, average); + NamedTextColor color = tps >= 18.0D ? NamedTextColor.GREEN + : tps >= 15.0D ? NamedTextColor.YELLOW : NamedTextColor.RED; + return Component.text(window + ": ", NamedTextColor.GRAY) + .append(Component.text(String.format("%.2f", tps), color)); + } + + private static JsonObject cpuTooltipObject() { + double load = ServerStatsUtil.getSystemLoadAverage(); + if (load < 0.0D) { + return InventoryButtonParts.createTooltipObject( + Component.text("The system load average is unavailable", NamedTextColor.GRAY), + Component.empty(), + refreshedLine()); + } + + int cores = ServerStatsUtil.getAvailableProcessors(); + double perCore = load * 100.0D / cores; + NamedTextColor color = load / cores < 0.5D ? NamedTextColor.GREEN + : load / cores < 1.0D ? NamedTextColor.YELLOW : NamedTextColor.RED; + return InventoryButtonParts.createTooltipObject( + Component.text("System load average (last minute)", NamedTextColor.GRAY), + Component.text("Cores: ", NamedTextColor.GRAY) + .append(Component.text(cores, NamedTextColor.WHITE)), + Component.text("Per core: ", NamedTextColor.GRAY) + .append(Component.text(String.format("%.0f%%", perCore), color)), + Component.empty(), + refreshedLine()); + } + + private static Component refreshedLine() { + return Component.text("Updated at " + LocalTime.now().format(TIME_FORMAT), NamedTextColor.YELLOW, TextDecoration.ITALIC); + } + + private StaffLayout() { + } + +} diff --git a/example/bukkit/json/src/main/java/com/lunarclient/apollo/example/json/util/JsonPacketUtil.java b/example/bukkit/json/src/main/java/com/lunarclient/apollo/example/json/util/JsonPacketUtil.java index 31617883..59733a24 100644 --- a/example/bukkit/json/src/main/java/com/lunarclient/apollo/example/json/util/JsonPacketUtil.java +++ b/example/bukkit/json/src/main/java/com/lunarclient/apollo/example/json/util/JsonPacketUtil.java @@ -58,6 +58,8 @@ public final class JsonPacketUtil { CONFIG_MODULE_PROPERTIES.put("packet_enrichment", "player-attack.send-packet", false); CONFIG_MODULE_PROPERTIES.put("packet_enrichment", "player-chat-open.send-packet", false); CONFIG_MODULE_PROPERTIES.put("packet_enrichment", "player-chat-close.send-packet", false); + CONFIG_MODULE_PROPERTIES.put("packet_enrichment", "player-inventory-open.send-packet", false); + CONFIG_MODULE_PROPERTIES.put("packet_enrichment", "player-inventory-close.send-packet", false); CONFIG_MODULE_PROPERTIES.put("packet_enrichment", "player-use-item.send-packet", false); CONFIG_MODULE_PROPERTIES.put("packet_enrichment", "player-use-item-bucket.send-packet", false); CONFIG_MODULE_PROPERTIES.put("server_link", "legacy-button-placement", "NEW_ROW"); diff --git a/example/bukkit/json/src/main/resources/plugin.yml b/example/bukkit/json/src/main/resources/plugin.yml index 334fe2a4..64cd0c62 100644 --- a/example/bukkit/json/src/main/resources/plugin.yml +++ b/example/bukkit/json/src/main/resources/plugin.yml @@ -1,6 +1,6 @@ name: Apollo-Json-Example main: com.lunarclient.apollo.example.json.ApolloJsonExamplePlatform -version: 1.2.8 +version: 1.2.9 author: Moonsworth softdepend: [ Apollo-Bukkit ] api-version: 1.13 @@ -32,6 +32,8 @@ commands: description: "Glint!" glow: description: "Glow!" + heightlimit: + description: "Height Limit!" hologram: description: "Holograms!" inventory: @@ -52,6 +54,8 @@ commands: description: "Pay Now!" richpresence: description: "Rich Presence!" + serverlink: + description: "Server Links!" saturation: description: "Saturation!" serverrule: diff --git a/example/bukkit/nms/src/main/java/com/lunarclient/apollo/example/nms/NpcManager.java b/example/bukkit/nms/src/main/java/com/lunarclient/apollo/example/nms/NpcManager.java index be00b996..37f2e2e5 100644 --- a/example/bukkit/nms/src/main/java/com/lunarclient/apollo/example/nms/NpcManager.java +++ b/example/bukkit/nms/src/main/java/com/lunarclient/apollo/example/nms/NpcManager.java @@ -26,6 +26,7 @@ import com.mojang.authlib.GameProfile; import java.util.ArrayList; import java.util.Collection; +import java.util.Collections; import java.util.EnumSet; import java.util.HashMap; import java.util.List; @@ -51,10 +52,12 @@ import org.bukkit.World; import org.bukkit.craftbukkit.CraftWorld; import org.bukkit.craftbukkit.entity.CraftPlayer; +import org.bukkit.entity.Player; import org.bukkit.event.EventHandler; import org.bukkit.event.Listener; -import org.bukkit.event.player.PlayerJoinEvent; +import org.bukkit.event.player.PlayerChangedWorldEvent; import org.bukkit.event.player.PlayerQuitEvent; +import org.bukkit.event.player.PlayerRespawnEvent; import org.bukkit.plugin.java.JavaPlugin; import org.jetbrains.annotations.Nullable; @@ -65,7 +68,11 @@ public final class NpcManager implements Listener { HumanoidArm.RIGHT, false, false, ParticleStatus.ALL ); + private static final double TRACKING_RANGE = 48.0; + private static final double TRACKING_RANGE_SQUARED = TRACKING_RANGE * TRACKING_RANGE; + private final Map npcs = new HashMap<>(); + private final List viewerListeners = new ArrayList<>(); private final JavaPlugin plugin; private final NpcStore store; @@ -75,6 +82,11 @@ public NpcManager(JavaPlugin plugin) { Bukkit.getPluginManager().registerEvents(this, plugin); Bukkit.getScheduler().runTask(plugin, this::loadOrSpawnDefaults); + Bukkit.getScheduler().runTaskTimer(plugin, this::updateVisibility, 1L, 10L); + } + + public void addViewerListener(NpcViewerListener listener) { + this.viewerListeners.add(listener); } public void removeNpc(UUID uuid) { @@ -114,21 +126,73 @@ public Collection getNpcs() { } @EventHandler - public void onPlayerJoin(PlayerJoinEvent event) { - ServerPlayer viewer = ((CraftPlayer) event.getPlayer()).getHandle(); - for (PlayerNpc npc : this.npcs.values()) { - this.showNpc(viewer, npc); - } + public void onPlayerQuit(PlayerQuitEvent event) { + this.forgetViewer(event.getPlayer()); } @EventHandler - public void onPlayerQuit(PlayerQuitEvent event) { - ServerPlayer viewer = ((CraftPlayer) event.getPlayer()).getHandle(); + public void onPlayerChangedWorld(PlayerChangedWorldEvent event) { + this.forgetViewer(event.getPlayer()); + } + + @EventHandler + public void onPlayerRespawn(PlayerRespawnEvent event) { + this.forgetViewer(event.getPlayer()); + } + + private void forgetViewer(Player player) { for (PlayerNpc npc : this.npcs.values()) { - this.hideNpc(viewer, npc); + npc.getViewers().remove(player.getUniqueId()); + } + } + + private void updateVisibility() { + for (Player player : Bukkit.getOnlinePlayers()) { + for (PlayerNpc npc : this.npcs.values()) { + boolean inRange = this.isWithinTrackingRange(player, npc); + boolean viewing = npc.getViewers().contains(player.getUniqueId()); + + if (inRange && !viewing) { + npc.getViewers().add(player.getUniqueId()); + this.showNpc(((CraftPlayer) player).getHandle(), npc); + + for (NpcViewerListener listener : this.viewerListeners) { + listener.onNpcShown(player, npc); + } + } else if (!inRange && viewing) { + npc.getViewers().remove(player.getUniqueId()); + this.hideNpc(((CraftPlayer) player).getHandle(), npc); + } + } } } + private boolean isWithinTrackingRange(Player player, PlayerNpc npc) { + Location location = npc.getLocation(); + World world = location.getWorld(); + + return world != null + && world.equals(player.getWorld()) + && player.getLocation().distanceSquared(location) <= NpcManager.TRACKING_RANGE_SQUARED; + } + + public List getViewers(UUID npcUuid) { + PlayerNpc npc = this.npcs.get(npcUuid); + if (npc == null) { + return Collections.emptyList(); + } + + List viewers = new ArrayList<>(); + for (UUID viewerUuid : npc.getViewers()) { + Player player = Bukkit.getPlayer(viewerUuid); + if (player != null) { + viewers.add(player); + } + } + + return viewers; + } + private void loadOrSpawnDefaults() { if (!this.store.exists()) { this.spawnDefaultNpcs(); @@ -184,9 +248,7 @@ private void spawnDefaultNpcs() { PlayerNpc playerNpc = new PlayerNpc(npc.getUUID(), name, location.clone(), npc); this.npcs.put(playerNpc.getUuid(), playerNpc); - for (ServerPlayer viewer : server.getPlayerList().getPlayers()) { - this.showNpc(viewer, playerNpc); - } + this.updateVisibility(); return playerNpc; } @@ -220,9 +282,14 @@ private void hideNpc(ServerPlayer viewer, PlayerNpc npc) { } private void despawnNpcs(PlayerNpc npc) { - for (ServerPlayer player : MinecraftServer.getServer().getPlayerList().getPlayers()) { - this.hideNpc(player, npc); + for (UUID viewerUuid : npc.getViewers()) { + Player player = Bukkit.getPlayer(viewerUuid); + if (player != null) { + this.hideNpc(((CraftPlayer) player).getHandle(), npc); + } } + + npc.getViewers().clear(); } } diff --git a/example/bukkit/nms/src/main/java/com/lunarclient/apollo/example/nms/NpcViewerListener.java b/example/bukkit/nms/src/main/java/com/lunarclient/apollo/example/nms/NpcViewerListener.java new file mode 100644 index 00000000..479e3eeb --- /dev/null +++ b/example/bukkit/nms/src/main/java/com/lunarclient/apollo/example/nms/NpcViewerListener.java @@ -0,0 +1,33 @@ +/* + * This file is part of Apollo, licensed under the MIT License. + * + * Copyright (c) 2026 Moonsworth + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +package com.lunarclient.apollo.example.nms; + +import org.bukkit.entity.Player; + +@FunctionalInterface +public interface NpcViewerListener { + + void onNpcShown(Player viewer, PlayerNpc npc); + +} diff --git a/example/bukkit/nms/src/main/java/com/lunarclient/apollo/example/nms/PlayerNpc.java b/example/bukkit/nms/src/main/java/com/lunarclient/apollo/example/nms/PlayerNpc.java index 9bdde6f9..fa464bc3 100644 --- a/example/bukkit/nms/src/main/java/com/lunarclient/apollo/example/nms/PlayerNpc.java +++ b/example/bukkit/nms/src/main/java/com/lunarclient/apollo/example/nms/PlayerNpc.java @@ -24,13 +24,16 @@ package com.lunarclient.apollo.example.nms; import java.util.ArrayList; +import java.util.HashSet; import java.util.List; +import java.util.Set; import java.util.UUID; import lombok.Getter; import lombok.RequiredArgsConstructor; import lombok.Setter; import net.minecraft.server.level.ServerPlayer; import org.bukkit.Location; +import org.jetbrains.annotations.Nullable; @Getter @RequiredArgsConstructor @@ -40,12 +43,26 @@ public final class PlayerNpc { private final String name; private final Location location; private final ServerPlayer handle; + private final Set viewers = new HashSet<>(); @Setter private List cosmetics = new ArrayList<>(); + @Setter + @Nullable + private ActiveEmote activeEmote; + public int getEntityId() { return this.handle.getId(); } + @Getter + @RequiredArgsConstructor + public static final class ActiveEmote { + + private final int emoteId; + private final int metadata; + + } + } diff --git a/example/bukkit/proto/src/main/java/com/lunarclient/apollo/example/proto/ApolloProtoExamplePlatform.java b/example/bukkit/proto/src/main/java/com/lunarclient/apollo/example/proto/ApolloProtoExamplePlatform.java index 94578ad4..680a71e2 100644 --- a/example/bukkit/proto/src/main/java/com/lunarclient/apollo/example/proto/ApolloProtoExamplePlatform.java +++ b/example/bukkit/proto/src/main/java/com/lunarclient/apollo/example/proto/ApolloProtoExamplePlatform.java @@ -36,7 +36,9 @@ import com.lunarclient.apollo.example.proto.module.CosmeticProtoExample; import com.lunarclient.apollo.example.proto.module.EntityProtoExample; import com.lunarclient.apollo.example.proto.module.GlowProtoExample; +import com.lunarclient.apollo.example.proto.module.HeightLimitProtoExample; import com.lunarclient.apollo.example.proto.module.HologramProtoExample; +import com.lunarclient.apollo.example.proto.module.InventoryProtoExample; import com.lunarclient.apollo.example.proto.module.LimbProtoExample; import com.lunarclient.apollo.example.proto.module.MarkerProtoExample; import com.lunarclient.apollo.example.proto.module.ModSettingsProtoExample; @@ -75,12 +77,14 @@ public void registerModuleExamples() { this.setBeamExample(new BeamProtoExample()); this.setBorderExample(new BorderProtoExample()); this.setChatExample(new ChatProtoExample()); + this.setInventoryExample(new InventoryProtoExample()); this.setCosmeticExample(new CosmeticProtoExample()); this.setColoredFireExample(new ColoredFireProtoExample()); this.setCombatExample(new CombatProtoExample()); this.setCooldownExample(new CooldownProtoExample()); this.setEntityExample(new EntityProtoExample()); this.setGlowExample(new GlowProtoExample()); + this.setHeightLimitExample(new HeightLimitProtoExample()); this.setHologramExample(new HologramProtoExample()); this.setLimbExample(new LimbProtoExample()); this.setMarkerExample(new MarkerProtoExample()); diff --git a/example/bukkit/proto/src/main/java/com/lunarclient/apollo/example/proto/listener/ApolloPacketReceiveProtoListener.java b/example/bukkit/proto/src/main/java/com/lunarclient/apollo/example/proto/listener/ApolloPacketReceiveProtoListener.java index 63933bd7..2c691b6b 100644 --- a/example/bukkit/proto/src/main/java/com/lunarclient/apollo/example/proto/listener/ApolloPacketReceiveProtoListener.java +++ b/example/bukkit/proto/src/main/java/com/lunarclient/apollo/example/proto/listener/ApolloPacketReceiveProtoListener.java @@ -31,6 +31,8 @@ import com.lunarclient.apollo.common.v1.LunarClientVersion; import com.lunarclient.apollo.common.v1.MinecraftVersion; import com.lunarclient.apollo.example.ApolloExamplePlugin; +import com.lunarclient.apollo.example.module.impl.InventoryExample; +import com.lunarclient.apollo.example.proto.module.InventoryProtoExample; import com.lunarclient.apollo.example.proto.util.ProtobufUtil; import com.lunarclient.apollo.packetenrichment.v1.BlockHit; import com.lunarclient.apollo.packetenrichment.v1.Direction; @@ -39,6 +41,8 @@ import com.lunarclient.apollo.packetenrichment.v1.PlayerChatCloseMessage; import com.lunarclient.apollo.packetenrichment.v1.PlayerChatOpenMessage; import com.lunarclient.apollo.packetenrichment.v1.PlayerInfo; +import com.lunarclient.apollo.packetenrichment.v1.PlayerInventoryCloseMessage; +import com.lunarclient.apollo.packetenrichment.v1.PlayerInventoryOpenMessage; import com.lunarclient.apollo.packetenrichment.v1.PlayerUseItemBucketMessage; import com.lunarclient.apollo.packetenrichment.v1.PlayerUseItemMessage; import com.lunarclient.apollo.packetenrichment.v1.RayTraceResult; @@ -73,6 +77,10 @@ public void onPluginMessageReceived(@NonNull String channel, @NonNull Player pla this.onPlayerChatOpen(any.unpack(PlayerChatOpenMessage.class)); } else if (any.is(PlayerChatCloseMessage.class)) { this.onPlayerChatClose(any.unpack(PlayerChatCloseMessage.class)); + } else if (any.is(PlayerInventoryOpenMessage.class)) { + this.onPlayerInventoryOpen(player, any.unpack(PlayerInventoryOpenMessage.class)); + } else if (any.is(PlayerInventoryCloseMessage.class)) { + this.onPlayerInventoryClose(player, any.unpack(PlayerInventoryCloseMessage.class)); } else if (any.is(PlayerUseItemMessage.class)) { this.onPlayerUseItem(any.unpack(PlayerUseItemMessage.class)); } else if (any.is(PlayerUseItemBucketMessage.class)) { @@ -125,6 +133,30 @@ private void onPlayerChatClose(PlayerChatCloseMessage message) { this.onPlayerInfo(playerInfo); } + private void onPlayerInventoryOpen(Player player, PlayerInventoryOpenMessage message) { + long instantiationTimeMs = ProtobufUtil.toJavaTimestamp(message.getPacketInfo().getInstantiationTime()); + + PlayerInfo playerInfo = message.getPlayerInfo(); + this.onPlayerInfo(playerInfo); + + InventoryExample example = ApolloExamplePlugin.getInstance().getInventoryExample(); + if (example instanceof InventoryProtoExample) { + ((InventoryProtoExample) example).handleInventoryOpen(player); + } + } + + private void onPlayerInventoryClose(Player player, PlayerInventoryCloseMessage message) { + long instantiationTimeMs = ProtobufUtil.toJavaTimestamp(message.getPacketInfo().getInstantiationTime()); + + PlayerInfo playerInfo = message.getPlayerInfo(); + this.onPlayerInfo(playerInfo); + + InventoryExample example = ApolloExamplePlugin.getInstance().getInventoryExample(); + if (example instanceof InventoryProtoExample) { + ((InventoryProtoExample) example).handleInventoryClose(player); + } + } + private void onPlayerUseItem(PlayerUseItemMessage message) { long instantiationTimeMs = ProtobufUtil.toJavaTimestamp(message.getPacketInfo().getInstantiationTime()); diff --git a/example/bukkit/proto/src/main/java/com/lunarclient/apollo/example/proto/listener/ApolloPlayerProtoListener.java b/example/bukkit/proto/src/main/java/com/lunarclient/apollo/example/proto/listener/ApolloPlayerProtoListener.java index a9aee632..6e55ce2a 100644 --- a/example/bukkit/proto/src/main/java/com/lunarclient/apollo/example/proto/listener/ApolloPlayerProtoListener.java +++ b/example/bukkit/proto/src/main/java/com/lunarclient/apollo/example/proto/listener/ApolloPlayerProtoListener.java @@ -24,6 +24,9 @@ package com.lunarclient.apollo.example.proto.listener; import com.lunarclient.apollo.example.ApolloExamplePlugin; +import com.lunarclient.apollo.example.module.impl.CosmeticExample; +import com.lunarclient.apollo.example.nms.CommandCosmetic; +import com.lunarclient.apollo.example.nms.PlayerNpc; import com.lunarclient.apollo.example.proto.util.ProtobufPacketUtil; import com.lunarclient.apollo.player.v1.UpdatePlayerWorldMessage; import java.util.HashSet; @@ -79,6 +82,26 @@ private void onRegisterChannel(PlayerRegisterChannelEvent event) { PLAYERS_RUNNING_APOLLO.add(player.getUniqueId()); player.sendMessage("You are using LunarClient!"); + + this.applyNpcCosmetics(player); + } + + private void applyNpcCosmetics(Player player) { + CosmeticExample cosmeticExample = this.plugin.getCosmeticExample(); + if (cosmeticExample == null) { + return; + } + + for (PlayerNpc npc : this.plugin.getNpcManager().getNpcs()) { + for (CommandCosmetic spec : npc.getCosmetics()) { + cosmeticExample.equipNpcCosmeticToViewer(player, npc.getUuid(), spec); + } + + PlayerNpc.ActiveEmote emote = npc.getActiveEmote(); + if (emote != null && npc.getViewers().contains(player.getUniqueId())) { + cosmeticExample.startNpcEmoteToViewer(player, npc.getUuid(), emote.getEmoteId(), emote.getMetadata()); + } + } } @EventHandler diff --git a/example/bukkit/proto/src/main/java/com/lunarclient/apollo/example/proto/module/ChatProtoExample.java b/example/bukkit/proto/src/main/java/com/lunarclient/apollo/example/proto/module/ChatProtoExample.java index 48ca3438..02eafe9a 100644 --- a/example/bukkit/proto/src/main/java/com/lunarclient/apollo/example/proto/module/ChatProtoExample.java +++ b/example/bukkit/proto/src/main/java/com/lunarclient/apollo/example/proto/module/ChatProtoExample.java @@ -23,17 +23,28 @@ */ package com.lunarclient.apollo.example.proto.module; +import com.lunarclient.apollo.button.v1.ButtonContent; +import com.lunarclient.apollo.button.v1.ButtonUpdate; import com.lunarclient.apollo.chat.v1.DisplayLiveChatMessageMessage; +import com.lunarclient.apollo.chat.v1.RemoveChatButtonMessage; import com.lunarclient.apollo.chat.v1.RemoveLiveChatMessageMessage; +import com.lunarclient.apollo.chat.v1.ResetChatButtonsMessage; +import com.lunarclient.apollo.chat.v1.UpdateChatButtonMessage; +import com.lunarclient.apollo.common.v1.Icon; import com.lunarclient.apollo.example.ApolloExamplePlugin; import com.lunarclient.apollo.example.module.impl.ChatExample; +import com.lunarclient.apollo.example.proto.module.chatbuttons.ChannelsLayout; +import com.lunarclient.apollo.example.proto.module.chatbuttons.ChatButtonParts; +import com.lunarclient.apollo.example.proto.module.chatbuttons.StaffChatLayout; import com.lunarclient.apollo.example.proto.util.AdventureUtil; import com.lunarclient.apollo.example.proto.util.ProtobufPacketUtil; +import com.lunarclient.apollo.example.proto.util.ProtobufUtil; import com.lunarclient.apollo.example.util.ServerUtil; import java.util.concurrent.atomic.AtomicInteger; import net.kyori.adventure.text.Component; import net.kyori.adventure.text.format.NamedTextColor; import org.bukkit.Bukkit; +import org.bukkit.entity.Player; import org.bukkit.scheduler.BukkitRunnable; public class ChatProtoExample extends ChatExample { @@ -105,6 +116,51 @@ private void runFoliaChatMessageTask() { }, 1L, 20L); } + @Override + public void displayChannelsLayoutExample(Player viewer) { + ChannelsLayout.display(viewer); + } + + @Override + public void displayStaffChatLayoutExample(Player viewer) { + StaffChatLayout.display(viewer); + } + + @Override + public void resetChatButtonsExample(Player viewer) { + ResetChatButtonsMessage message = ResetChatButtonsMessage.getDefaultInstance(); + ProtobufPacketUtil.sendPacket(viewer, message); + } + + @Override + public void updateChatButtonExample(Player viewer) { + ButtonUpdate update = ButtonUpdate.newBuilder() + .setContent(ButtonContent.newBuilder() + .addParts(ChatButtonParts.iconPart(Icon.newBuilder() + .setItemStack(ProtobufUtil.createItemStackIconProto("PAPER", 0)) + .build())) + .addParts(ChatButtonParts.textPart(Component.text("Public Chat", NamedTextColor.AQUA))) + .setScale(1.0F) + .build()) + .build(); + + UpdateChatButtonMessage message = UpdateChatButtonMessage.newBuilder() + .setId("public-chat") + .setUpdate(update) + .build(); + + ProtobufPacketUtil.sendPacket(viewer, message); + } + + @Override + public void removeChatButtonExample(Player viewer) { + RemoveChatButtonMessage message = RemoveChatButtonMessage.newBuilder() + .setId("party-chat") + .build(); + + ProtobufPacketUtil.sendPacket(viewer, message); + } + @Override public void removeLiveChatMessageExample() { RemoveLiveChatMessageMessage message = RemoveLiveChatMessageMessage.newBuilder() diff --git a/example/bukkit/proto/src/main/java/com/lunarclient/apollo/example/proto/module/CosmeticProtoExample.java b/example/bukkit/proto/src/main/java/com/lunarclient/apollo/example/proto/module/CosmeticProtoExample.java index e83851d7..f66f03aa 100644 --- a/example/bukkit/proto/src/main/java/com/lunarclient/apollo/example/proto/module/CosmeticProtoExample.java +++ b/example/bukkit/proto/src/main/java/com/lunarclient/apollo/example/proto/module/CosmeticProtoExample.java @@ -24,11 +24,13 @@ package com.lunarclient.apollo.example.proto.module; import com.google.common.collect.Lists; +import com.lunarclient.apollo.cosmetic.v1.BodyOptions; import com.lunarclient.apollo.cosmetic.v1.CloakOptions; import com.lunarclient.apollo.cosmetic.v1.Cosmetic; import com.lunarclient.apollo.cosmetic.v1.DisplaySprayMessage; import com.lunarclient.apollo.cosmetic.v1.Emote; import com.lunarclient.apollo.cosmetic.v1.EquipNpcCosmeticsMessage; +import com.lunarclient.apollo.cosmetic.v1.HatOptions; import com.lunarclient.apollo.cosmetic.v1.PetOptions; import com.lunarclient.apollo.cosmetic.v1.RemoveSprayMessage; import com.lunarclient.apollo.cosmetic.v1.ResetNpcCosmeticsMessage; @@ -38,6 +40,7 @@ import com.lunarclient.apollo.cosmetic.v1.StopNpcEmoteMessage; import com.lunarclient.apollo.cosmetic.v1.UnequipNpcCosmeticsMessage; import com.lunarclient.apollo.example.module.impl.CosmeticExample; +import com.lunarclient.apollo.example.nms.CommandCosmetic; import com.lunarclient.apollo.example.proto.util.ProtobufPacketUtil; import com.lunarclient.apollo.example.proto.util.ProtobufUtil; import com.lunarclient.apollo.packetenrichment.v1.Direction; @@ -109,6 +112,51 @@ public void equipNpcCosmeticsInternal(Player viewer, UUID npcUuid, List ProtobufPacketUtil.broadcastPacket(message); } + @Override + public void equipNpcCosmeticInternal(Player viewer, UUID npcUuid, CommandCosmetic cosmetic) { + ProtobufPacketUtil.broadcastPacket(this.createEquipMessage(npcUuid, cosmetic)); + } + + @Override + public void equipNpcCosmeticToViewer(Player viewer, UUID npcUuid, CommandCosmetic cosmetic) { + ProtobufPacketUtil.sendPacket(viewer, this.createEquipMessage(npcUuid, cosmetic)); + } + + private EquipNpcCosmeticsMessage createEquipMessage(UUID npcUuid, CommandCosmetic cosmetic) { + Cosmetic.Builder cosmeticBuilder = Cosmetic.newBuilder() + .setId(cosmetic.getId()); + + CommandCosmetic.Options options = cosmetic.getOptions(); + if (options instanceof CommandCosmetic.Hat) { + CommandCosmetic.Hat hat = (CommandCosmetic.Hat) options; + cosmeticBuilder.setHatOptions(HatOptions.newBuilder() + .setShowOverHelmet(hat.isShowOverHelmet()) + .setShowOverSkinLayer(hat.isShowOverSkinLayer()) + .setHeightOffset(hat.getHeightOffset()) + .build()); + } else if (options instanceof CommandCosmetic.Cloak) { + cosmeticBuilder.setCloakOptions(CloakOptions.newBuilder() + .setUseClothPhysics(((CommandCosmetic.Cloak) options).isUseClothPhysics()) + .build()); + } else if (options instanceof CommandCosmetic.Pet) { + cosmeticBuilder.setPetOptions(PetOptions.newBuilder() + .setFlipShoulder(((CommandCosmetic.Pet) options).isFlipShoulder()) + .build()); + } else if (options instanceof CommandCosmetic.Body) { + CommandCosmetic.Body body = (CommandCosmetic.Body) options; + cosmeticBuilder.setBodyOptions(BodyOptions.newBuilder() + .setShowOverChestplate(body.isShowOverChestplate()) + .setShowOverLeggings(body.isShowOverLeggings()) + .setShowOverBoots(body.isShowOverBoots()) + .build()); + } + + return EquipNpcCosmeticsMessage.newBuilder() + .setNpcUuid(ProtobufUtil.createUuidProto(npcUuid)) + .addCosmetics(cosmeticBuilder.build()) + .build(); + } + @Override public void unequipNpcCosmeticsExample(Player viewer, UUID npcUuid) { List cosmeticIds = Lists.newArrayList(434, 3654, 5095, 3, 3977); @@ -153,7 +201,7 @@ public void startNpcEmoteExample(Player viewer, UUID npcUuid) { } @Override - public void startNpcEmoteInternal(Player viewer, UUID npcUuid, int emoteId, int metadata) { + public void startNpcEmoteToViewer(Player viewer, UUID npcUuid, int emoteId, int metadata) { StartNpcEmoteMessage message = StartNpcEmoteMessage.newBuilder() .setNpcUuid(ProtobufUtil.createUuidProto(npcUuid)) .setEmote(Emote.newBuilder() @@ -162,7 +210,7 @@ public void startNpcEmoteInternal(Player viewer, UUID npcUuid, int emoteId, int .build()) .build(); - ProtobufPacketUtil.broadcastPacket(message); + ProtobufPacketUtil.sendPacket(viewer, message); } @Override @@ -174,6 +222,15 @@ public void stopNpcEmoteExample(Player viewer, UUID npcUuid) { ProtobufPacketUtil.broadcastPacket(message); } + @Override + public void stopNpcEmoteToViewer(Player viewer, UUID npcUuid) { + StopNpcEmoteMessage message = StopNpcEmoteMessage.newBuilder() + .setNpcUuid(ProtobufUtil.createUuidProto(npcUuid)) + .build(); + + ProtobufPacketUtil.sendPacket(viewer, message); + } + @Override public void resetNpcEmotesExample() { ResetNpcEmotesMessage message = ResetNpcEmotesMessage.getDefaultInstance(); diff --git a/example/bukkit/proto/src/main/java/com/lunarclient/apollo/example/proto/module/HeightLimitProtoExample.java b/example/bukkit/proto/src/main/java/com/lunarclient/apollo/example/proto/module/HeightLimitProtoExample.java new file mode 100644 index 00000000..babbce5b --- /dev/null +++ b/example/bukkit/proto/src/main/java/com/lunarclient/apollo/example/proto/module/HeightLimitProtoExample.java @@ -0,0 +1,66 @@ +/* + * This file is part of Apollo, licensed under the MIT License. + * + * Copyright (c) 2026 Moonsworth + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +package com.lunarclient.apollo.example.proto.module; + +import com.lunarclient.apollo.example.module.impl.HeightLimitExample; +import com.lunarclient.apollo.example.proto.util.AdventureUtil; +import com.lunarclient.apollo.example.proto.util.ProtobufPacketUtil; +import com.lunarclient.apollo.heightlimit.v1.OverrideHeightLimitMessage; +import com.lunarclient.apollo.heightlimit.v1.RemoveHeightLimitMessage; +import com.lunarclient.apollo.heightlimit.v1.ResetHeightLimitsMessage; +import net.kyori.adventure.text.Component; +import net.kyori.adventure.text.format.NamedTextColor; +import org.bukkit.entity.Player; + +public class HeightLimitProtoExample extends HeightLimitExample { + + @Override + public void overrideHeightLimitExample(Player viewer) { + OverrideHeightLimitMessage message = OverrideHeightLimitMessage.newBuilder() + .setWorld("world_the_end") + .setLimit(150) + .setDisplayNameAdventureJsonLines(AdventureUtil.toJson( + Component.text("The End", NamedTextColor.DARK_PURPLE) + )) + .build(); + + ProtobufPacketUtil.sendPacket(viewer, message); + } + + @Override + public void removeHeightLimitExample(Player viewer) { + RemoveHeightLimitMessage message = RemoveHeightLimitMessage.newBuilder() + .setWorld("world_the_end") + .build(); + + ProtobufPacketUtil.sendPacket(viewer, message); + } + + @Override + public void resetHeightLimitsExample(Player viewer) { + ResetHeightLimitsMessage message = ResetHeightLimitsMessage.getDefaultInstance(); + ProtobufPacketUtil.sendPacket(viewer, message); + } + +} diff --git a/example/bukkit/proto/src/main/java/com/lunarclient/apollo/example/proto/module/InventoryProtoExample.java b/example/bukkit/proto/src/main/java/com/lunarclient/apollo/example/proto/module/InventoryProtoExample.java new file mode 100644 index 00000000..b4b1746a --- /dev/null +++ b/example/bukkit/proto/src/main/java/com/lunarclient/apollo/example/proto/module/InventoryProtoExample.java @@ -0,0 +1,200 @@ +/* + * This file is part of Apollo, licensed under the MIT License. + * + * Copyright (c) 2026 Moonsworth + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +package com.lunarclient.apollo.example.proto.module; + +import com.lunarclient.apollo.button.v1.ButtonContent; +import com.lunarclient.apollo.button.v1.ButtonTooltip; +import com.lunarclient.apollo.button.v1.ButtonUpdate; +import com.lunarclient.apollo.example.ApolloExamplePlugin; +import com.lunarclient.apollo.example.module.impl.InventoryExample; +import com.lunarclient.apollo.example.proto.module.inventorybuttons.HubLayout; +import com.lunarclient.apollo.example.proto.module.inventorybuttons.InventoryButtonParts; +import com.lunarclient.apollo.example.proto.module.inventorybuttons.MenuLayout; +import com.lunarclient.apollo.example.proto.module.inventorybuttons.MinigameLayout; +import com.lunarclient.apollo.example.proto.module.inventorybuttons.StaffLayout; +import com.lunarclient.apollo.example.proto.util.AdventureUtil; +import com.lunarclient.apollo.example.proto.util.ProtobufPacketUtil; +import com.lunarclient.apollo.example.util.ServerUtil; +import com.lunarclient.apollo.inventory.v1.RemoveInventoryButtonMessage; +import com.lunarclient.apollo.inventory.v1.ResetInventoryButtonsMessage; +import com.lunarclient.apollo.inventory.v1.UpdateInventoryButtonMessage; +import java.util.Set; +import java.util.UUID; +import java.util.concurrent.ConcurrentHashMap; +import java.util.concurrent.TimeUnit; +import net.kyori.adventure.text.Component; +import net.kyori.adventure.text.format.NamedTextColor; +import org.bukkit.Bukkit; +import org.bukkit.entity.Player; +import org.bukkit.event.EventHandler; +import org.bukkit.event.Listener; +import org.bukkit.event.player.PlayerQuitEvent; + +public class InventoryProtoExample extends InventoryExample implements Listener { + + private final Set staffViewers = ConcurrentHashMap.newKeySet(); + private final Set menuViewers = ConcurrentHashMap.newKeySet(); + private final Set minigameViewers = ConcurrentHashMap.newKeySet(); + + private final Set openInventories = ConcurrentHashMap.newKeySet(); + private volatile boolean inventoryTrackingSeen; + + public InventoryProtoExample() { + if (ServerUtil.isFolia()) { + this.runFoliaLiveButtonTask(); + } else { + this.runBukkitLiveButtonTask(); + } + + Bukkit.getPluginManager().registerEvents(this, ApolloExamplePlugin.getInstance()); + } + + @EventHandler + private void onPlayerQuit(PlayerQuitEvent event) { + UUID playerIdentifier = event.getPlayer().getUniqueId(); + + this.staffViewers.remove(playerIdentifier); + this.menuViewers.remove(playerIdentifier); + this.minigameViewers.remove(playerIdentifier); + this.openInventories.remove(playerIdentifier); + } + + @Override + public void displayMenuLayoutExample(Player viewer) { + MenuLayout.display(viewer); + this.menuViewers.add(viewer.getUniqueId()); + } + + @Override + public void displayHubLayoutExample(Player viewer) { + HubLayout.display(viewer); + } + + @Override + public void displayMinigameLayoutExample(Player viewer) { + MinigameLayout.display(viewer); + this.minigameViewers.add(viewer.getUniqueId()); + } + + @Override + public void displayStaffLayoutExample(Player viewer) { + StaffLayout.display(viewer); + this.staffViewers.add(viewer.getUniqueId()); + } + + @Override + public void removeInventoryButtonExample(Player viewer) { + RemoveInventoryButtonMessage shopMessage = RemoveInventoryButtonMessage.newBuilder() + .setId("shop") + .build(); + + RemoveInventoryButtonMessage voteMessage = RemoveInventoryButtonMessage.newBuilder() + .setId("vote") + .build(); + + ProtobufPacketUtil.sendPacket(viewer, shopMessage); + ProtobufPacketUtil.sendPacket(viewer, voteMessage); + } + + @Override + public void updateInventoryButtonExample(Player viewer) { + ButtonUpdate update = ButtonUpdate.newBuilder() + .setContent(ButtonContent.newBuilder() + .addParts(InventoryButtonParts.textPart(Component.text("Thanks for voting!", NamedTextColor.GREEN))) + .setScale(0.85F) + .build()) + .setTooltip(ButtonTooltip.newBuilder() + .addAdventureJsonLines(AdventureUtil.toJson(Component.text("Come back tomorrow!", NamedTextColor.GRAY))) + .build()) + .build(); + + UpdateInventoryButtonMessage message = UpdateInventoryButtonMessage.newBuilder() + .setId("vote") + .setUpdate(update) + .build(); + + ProtobufPacketUtil.sendPacket(viewer, message); + } + + @Override + public void resetInventoryButtonsExample(Player viewer) { + ResetInventoryButtonsMessage message = ResetInventoryButtonsMessage.getDefaultInstance(); + ProtobufPacketUtil.sendPacket(viewer, message); + + UUID playerIdentifier = viewer.getUniqueId(); + this.staffViewers.remove(playerIdentifier); + this.menuViewers.remove(playerIdentifier); + this.minigameViewers.remove(playerIdentifier); + } + + public void handleInventoryOpen(Player player) { + this.inventoryTrackingSeen = true; + this.openInventories.add(player.getUniqueId()); + this.sendLiveUpdates(player); + } + + public void handleInventoryClose(Player player) { + this.inventoryTrackingSeen = true; + this.openInventories.remove(player.getUniqueId()); + } + + private void runBukkitLiveButtonTask() { + Bukkit.getScheduler().runTaskTimerAsynchronously(ApolloExamplePlugin.getInstance(), + this::broadcastLiveButtonUpdates, 50L, 50L); + } + + private void runFoliaLiveButtonTask() { + Bukkit.getAsyncScheduler().runAtFixedRate(ApolloExamplePlugin.getInstance(), + task -> this.broadcastLiveButtonUpdates(), 2500L, 2500L, TimeUnit.MILLISECONDS); + } + + private void broadcastLiveButtonUpdates() { + for (Player player : Bukkit.getOnlinePlayers()) { + UUID playerIdentifier = player.getUniqueId(); + + if (this.inventoryTrackingSeen && !this.openInventories.contains(playerIdentifier)) { + continue; + } + + this.sendLiveUpdates(player); + } + } + + private void sendLiveUpdates(Player player) { + UUID playerIdentifier = player.getUniqueId(); + + if (this.staffViewers.contains(playerIdentifier)) { + StaffLayout.sendUpdates(player); + } + + if (this.menuViewers.contains(playerIdentifier)) { + MenuLayout.sendBalanceUpdate(player); + } + + if (this.minigameViewers.contains(playerIdentifier)) { + MinigameLayout.sendKillsUpdate(player); + } + } + +} diff --git a/example/bukkit/proto/src/main/java/com/lunarclient/apollo/example/proto/module/NametagProtoExample.java b/example/bukkit/proto/src/main/java/com/lunarclient/apollo/example/proto/module/NametagProtoExample.java index 07e5dbeb..8c59b086 100644 --- a/example/bukkit/proto/src/main/java/com/lunarclient/apollo/example/proto/module/NametagProtoExample.java +++ b/example/bukkit/proto/src/main/java/com/lunarclient/apollo/example/proto/module/NametagProtoExample.java @@ -28,6 +28,7 @@ import com.lunarclient.apollo.example.proto.util.AdventureUtil; import com.lunarclient.apollo.example.proto.util.ProtobufPacketUtil; import com.lunarclient.apollo.example.proto.util.ProtobufUtil; +import com.lunarclient.apollo.nametag.v1.NametagVisibilityOverride; import com.lunarclient.apollo.nametag.v1.OverrideNametagMessage; import com.lunarclient.apollo.nametag.v1.ResetNametagMessage; import com.lunarclient.apollo.nametag.v1.ResetNametagsMessage; @@ -59,6 +60,7 @@ public void overrideNametagExample(Player target) { OverrideNametagMessage message = OverrideNametagMessage.newBuilder() .setPlayerUuid(ProtobufUtil.createUuidProto(target.getUniqueId())) .addAllAdventureJsonLines(lines) + .setVisibilityOverride(NametagVisibilityOverride.NAMETAG_VISIBILITY_OVERRIDE_NONE) .build(); ProtobufPacketUtil.broadcastPacket(message); diff --git a/example/bukkit/proto/src/main/java/com/lunarclient/apollo/example/proto/module/chatbuttons/ChannelsLayout.java b/example/bukkit/proto/src/main/java/com/lunarclient/apollo/example/proto/module/chatbuttons/ChannelsLayout.java new file mode 100644 index 00000000..d2a7e114 --- /dev/null +++ b/example/bukkit/proto/src/main/java/com/lunarclient/apollo/example/proto/module/chatbuttons/ChannelsLayout.java @@ -0,0 +1,126 @@ +/* + * This file is part of Apollo, licensed under the MIT License. + * + * Copyright (c) 2026 Moonsworth + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +package com.lunarclient.apollo.example.proto.module.chatbuttons; + +import com.lunarclient.apollo.button.v1.Button; +import com.lunarclient.apollo.button.v1.ButtonContent; +import com.lunarclient.apollo.button.v1.ButtonShape; +import com.lunarclient.apollo.button.v1.ButtonSize; +import com.lunarclient.apollo.button.v1.ButtonTooltip; +import com.lunarclient.apollo.chat.v1.ChatButton; +import com.lunarclient.apollo.chat.v1.DisplayChatButtonsMessage; +import com.lunarclient.apollo.common.v1.Icon; +import com.lunarclient.apollo.example.proto.util.AdventureUtil; +import com.lunarclient.apollo.example.proto.util.ProtobufPacketUtil; +import com.lunarclient.apollo.example.proto.util.ProtobufUtil; +import com.lunarclient.apollo.hud.v1.HudPosition; +import net.kyori.adventure.text.Component; +import net.kyori.adventure.text.format.NamedTextColor; +import org.bukkit.entity.Player; + +public final class ChannelsLayout { + + public static void display(Player viewer) { + ChatButton teamChat = ChatButton.newBuilder() + .setButton(Button.newBuilder() + .setId("team-chat") + .setPosition(HudPosition.newBuilder().setX(0).setY(2).build()) + .setSize(ButtonSize.newBuilder().setWidth(70).setHeight(16).build()) + .setShape(ButtonShape.BUTTON_SHAPE_ROUNDED_SQUARE) + .setBackgroundColor(ProtobufUtil.createColorProto(ChatButtonParts.BACKGROUND)) + .setBorderColor(ProtobufUtil.createColorProto(ChatButtonParts.BORDER)) + .setContent(ButtonContent.newBuilder() + .addParts(ChatButtonParts.iconPart(Icon.newBuilder() + .setItemStack(ProtobufUtil.createItemStackIconProto("SHIELD", 0)) + .build())) + .addParts(ChatButtonParts.textPart(Component.text("Team Chat", NamedTextColor.GREEN))) + .setScale(1.0F) + .build()) + .setTooltip(ButtonTooltip.newBuilder() + .addAdventureJsonLines(AdventureUtil.toJson( + Component.text("Click to switch!", NamedTextColor.YELLOW))) + .build()) + .setRunCommand("/channel team") + .build()) + .build(); + + ChatButton publicChat = ChatButton.newBuilder() + .setButton(Button.newBuilder() + .setId("public-chat") + .setPosition(HudPosition.newBuilder().setX(76).setY(2).build()) + .setSize(ButtonSize.newBuilder().setWidth(78).setHeight(16).build()) + .setShape(ButtonShape.BUTTON_SHAPE_ROUNDED_SQUARE) + .setBackgroundColor(ProtobufUtil.createColorProto(ChatButtonParts.BACKGROUND)) + .setBorderColor(ProtobufUtil.createColorProto(ChatButtonParts.BORDER)) + .setContent(ButtonContent.newBuilder() + .addParts(ChatButtonParts.iconPart(Icon.newBuilder() + .setItemStack(ProtobufUtil.createItemStackIconProto("OAK_SIGN", 0)) + .build())) + .addParts(ChatButtonParts.textPart(Component.text("Public Chat"))) + .setScale(1.0F) + .build()) + .setTooltip(ButtonTooltip.newBuilder() + .addAdventureJsonLines(AdventureUtil.toJson( + Component.text("Click to switch!", NamedTextColor.YELLOW))) + .build()) + .setRunCommand("/channel public") + .build()) + .build(); + + ChatButton partyChat = ChatButton.newBuilder() + .setButton(Button.newBuilder() + .setId("party-chat") + .setPosition(HudPosition.newBuilder().setX(160).setY(2).build()) + .setSize(ButtonSize.newBuilder().setWidth(76).setHeight(16).build()) + .setShape(ButtonShape.BUTTON_SHAPE_ROUNDED_SQUARE) + .setBackgroundColor(ProtobufUtil.createColorProto(ChatButtonParts.BACKGROUND)) + .setBorderColor(ProtobufUtil.createColorProto(ChatButtonParts.BORDER)) + .setContent(ButtonContent.newBuilder() + .addParts(ChatButtonParts.iconPart(Icon.newBuilder() + .setItemStack(ProtobufUtil.createItemStackIconProto("FIREWORK_ROCKET", 0)) + .build())) + .addParts(ChatButtonParts.textPart(Component.text("Party Chat", NamedTextColor.LIGHT_PURPLE))) + .setScale(1.0F) + .build()) + .setTooltip(ButtonTooltip.newBuilder() + .addAdventureJsonLines(AdventureUtil.toJson( + Component.text("Click to switch!", NamedTextColor.YELLOW))) + .build()) + .setRunCommand("/channel party") + .build()) + .build(); + + DisplayChatButtonsMessage message = DisplayChatButtonsMessage.newBuilder() + .addChatButtons(teamChat) + .addChatButtons(publicChat) + .addChatButtons(partyChat) + .build(); + + ProtobufPacketUtil.sendPacket(viewer, message); + } + + private ChannelsLayout() { + } + +} diff --git a/example/bukkit/proto/src/main/java/com/lunarclient/apollo/example/proto/module/chatbuttons/ChatButtonParts.java b/example/bukkit/proto/src/main/java/com/lunarclient/apollo/example/proto/module/chatbuttons/ChatButtonParts.java new file mode 100644 index 00000000..8b268687 --- /dev/null +++ b/example/bukkit/proto/src/main/java/com/lunarclient/apollo/example/proto/module/chatbuttons/ChatButtonParts.java @@ -0,0 +1,52 @@ +/* + * This file is part of Apollo, licensed under the MIT License. + * + * Copyright (c) 2026 Moonsworth + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +package com.lunarclient.apollo.example.proto.module.chatbuttons; + +import com.lunarclient.apollo.button.v1.ButtonContentPart; +import com.lunarclient.apollo.common.v1.Icon; +import com.lunarclient.apollo.example.proto.util.AdventureUtil; +import java.awt.Color; +import net.kyori.adventure.text.Component; + +public final class ChatButtonParts { + + public static final Color BACKGROUND = new Color(0, 0, 0, 128); + public static final Color BORDER = new Color(0, 0, 0, 128); + + public static ButtonContentPart textPart(Component component) { + return ButtonContentPart.newBuilder() + .setAdventureJsonText(AdventureUtil.toJson(component)) + .build(); + } + + public static ButtonContentPart iconPart(Icon icon) { + return ButtonContentPart.newBuilder() + .setIcon(icon) + .build(); + } + + private ChatButtonParts() { + } + +} diff --git a/example/bukkit/proto/src/main/java/com/lunarclient/apollo/example/proto/module/chatbuttons/StaffChatLayout.java b/example/bukkit/proto/src/main/java/com/lunarclient/apollo/example/proto/module/chatbuttons/StaffChatLayout.java new file mode 100644 index 00000000..66b7fb12 --- /dev/null +++ b/example/bukkit/proto/src/main/java/com/lunarclient/apollo/example/proto/module/chatbuttons/StaffChatLayout.java @@ -0,0 +1,174 @@ +/* + * This file is part of Apollo, licensed under the MIT License. + * + * Copyright (c) 2026 Moonsworth + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +package com.lunarclient.apollo.example.proto.module.chatbuttons; + +import com.lunarclient.apollo.button.v1.Button; +import com.lunarclient.apollo.button.v1.ButtonContent; +import com.lunarclient.apollo.button.v1.ButtonShape; +import com.lunarclient.apollo.button.v1.ButtonSize; +import com.lunarclient.apollo.button.v1.ButtonTooltip; +import com.lunarclient.apollo.chat.v1.ChatButton; +import com.lunarclient.apollo.chat.v1.DisplayChatButtonsMessage; +import com.lunarclient.apollo.common.v1.Icon; +import com.lunarclient.apollo.example.proto.util.AdventureUtil; +import com.lunarclient.apollo.example.proto.util.ProtobufPacketUtil; +import com.lunarclient.apollo.example.proto.util.ProtobufUtil; +import com.lunarclient.apollo.hud.v1.HudPosition; +import net.kyori.adventure.text.Component; +import net.kyori.adventure.text.format.NamedTextColor; +import org.bukkit.entity.Player; + +public final class StaffChatLayout { + + public static void display(Player viewer) { + ChatButton staffChat = ChatButton.newBuilder() + .setButton(Button.newBuilder() + .setId("staff-chat") + .setPosition(HudPosition.newBuilder().setX(0).setY(2).build()) + .setSize(ButtonSize.newBuilder().setWidth(70).setHeight(16).build()) + .setShape(ButtonShape.BUTTON_SHAPE_ROUNDED_SQUARE) + .setBackgroundColor(ProtobufUtil.createColorProto(ChatButtonParts.BACKGROUND)) + .setBorderColor(ProtobufUtil.createColorProto(ChatButtonParts.BORDER)) + .setContent(ButtonContent.newBuilder() + .addParts(ChatButtonParts.iconPart(Icon.newBuilder() + .setItemStack(ProtobufUtil.createItemStackIconProto("COMMAND_BLOCK", 0)) + .build())) + .addParts(ChatButtonParts.textPart(Component.text("Staff Chat", NamedTextColor.AQUA))) + .setScale(1.0F) + .build()) + .setTooltip(ButtonTooltip.newBuilder() + .addAdventureJsonLines(AdventureUtil.toJson( + Component.text("Click to switch!", NamedTextColor.YELLOW))) + .build()) + .setRunCommand("/channel staff") + .build()) + .build(); + + ChatButton publicChat = ChatButton.newBuilder() + .setButton(Button.newBuilder() + .setId("public-chat") + .setPosition(HudPosition.newBuilder().setX(76).setY(2).build()) + .setSize(ButtonSize.newBuilder().setWidth(78).setHeight(16).build()) + .setShape(ButtonShape.BUTTON_SHAPE_ROUNDED_SQUARE) + .setBackgroundColor(ProtobufUtil.createColorProto(ChatButtonParts.BACKGROUND)) + .setBorderColor(ProtobufUtil.createColorProto(ChatButtonParts.BORDER)) + .setContent(ButtonContent.newBuilder() + .addParts(ChatButtonParts.iconPart(Icon.newBuilder() + .setItemStack(ProtobufUtil.createItemStackIconProto("OAK_SIGN", 0)) + .build())) + .addParts(ChatButtonParts.textPart(Component.text("Public Chat"))) + .setScale(1.0F) + .build()) + .setTooltip(ButtonTooltip.newBuilder() + .addAdventureJsonLines(AdventureUtil.toJson( + Component.text("Click to switch!", NamedTextColor.YELLOW))) + .build()) + .setRunCommand("/channel public") + .build()) + .build(); + + ChatButton clearChat = ChatButton.newBuilder() + .setButton(Button.newBuilder() + .setId("clear-chat") + .setPosition(HudPosition.newBuilder().setX(160).setY(2).build()) + .setSize(ButtonSize.newBuilder().setWidth(44).setHeight(16).build()) + .setShape(ButtonShape.BUTTON_SHAPE_ROUNDED_SQUARE) + .setBackgroundColor(ProtobufUtil.createColorProto(ChatButtonParts.BACKGROUND)) + .setBorderColor(ProtobufUtil.createColorProto(ChatButtonParts.BORDER)) + .setContent(ButtonContent.newBuilder() + .addParts(ChatButtonParts.iconPart(Icon.newBuilder() + .setItemStack(ProtobufUtil.createItemStackIconProto("SPONGE", 0)) + .build())) + .addParts(ChatButtonParts.textPart(Component.text("Clear", NamedTextColor.YELLOW))) + .setScale(1.0F) + .build()) + .setTooltip(ButtonTooltip.newBuilder() + .addAdventureJsonLines(AdventureUtil.toJson( + Component.text("Clears the public chat", NamedTextColor.GRAY))) + .build()) + .setRunCommand("/clearchat") + .build()) + .build(); + + ChatButton muteChat = ChatButton.newBuilder() + .setButton(Button.newBuilder() + .setId("mute-chat") + .setPosition(HudPosition.newBuilder().setX(210).setY(2).build()) + .setSize(ButtonSize.newBuilder().setWidth(44).setHeight(16).build()) + .setShape(ButtonShape.BUTTON_SHAPE_ROUNDED_SQUARE) + .setBackgroundColor(ProtobufUtil.createColorProto(ChatButtonParts.BACKGROUND)) + .setBorderColor(ProtobufUtil.createColorProto(ChatButtonParts.BORDER)) + .setContent(ButtonContent.newBuilder() + .addParts(ChatButtonParts.iconPart(Icon.newBuilder() + .setItemStack(ProtobufUtil.createItemStackIconProto("BARRIER", 0)) + .build())) + .addParts(ChatButtonParts.textPart(Component.text("Mute", NamedTextColor.RED))) + .setScale(1.0F) + .build()) + .setTooltip(ButtonTooltip.newBuilder() + .addAdventureJsonLines(AdventureUtil.toJson( + Component.text("Mutes the public chat", NamedTextColor.GRAY))) + .build()) + .setRunCommand("/mutechat") + .build()) + .build(); + + ChatButton unmuteChat = ChatButton.newBuilder() + .setButton(Button.newBuilder() + .setId("unmute-chat") + .setPosition(HudPosition.newBuilder().setX(260).setY(2).build()) + .setSize(ButtonSize.newBuilder().setWidth(56).setHeight(16).build()) + .setShape(ButtonShape.BUTTON_SHAPE_ROUNDED_SQUARE) + .setBackgroundColor(ProtobufUtil.createColorProto(ChatButtonParts.BACKGROUND)) + .setBorderColor(ProtobufUtil.createColorProto(ChatButtonParts.BORDER)) + .setContent(ButtonContent.newBuilder() + .addParts(ChatButtonParts.iconPart(Icon.newBuilder() + .setItemStack(ProtobufUtil.createItemStackIconProto("BELL", 0)) + .build())) + .addParts(ChatButtonParts.textPart(Component.text("Unmute", NamedTextColor.GREEN))) + .setScale(1.0F) + .build()) + .setTooltip(ButtonTooltip.newBuilder() + .addAdventureJsonLines(AdventureUtil.toJson( + Component.text("Unmutes the public chat", NamedTextColor.GRAY))) + .build()) + .setRunCommand("/unmutechat") + .build()) + .build(); + + DisplayChatButtonsMessage message = DisplayChatButtonsMessage.newBuilder() + .addChatButtons(staffChat) + .addChatButtons(publicChat) + .addChatButtons(clearChat) + .addChatButtons(muteChat) + .addChatButtons(unmuteChat) + .build(); + + ProtobufPacketUtil.sendPacket(viewer, message); + } + + private StaffChatLayout() { + } + +} diff --git a/example/bukkit/proto/src/main/java/com/lunarclient/apollo/example/proto/module/inventorybuttons/HubLayout.java b/example/bukkit/proto/src/main/java/com/lunarclient/apollo/example/proto/module/inventorybuttons/HubLayout.java new file mode 100644 index 00000000..8004ab4c --- /dev/null +++ b/example/bukkit/proto/src/main/java/com/lunarclient/apollo/example/proto/module/inventorybuttons/HubLayout.java @@ -0,0 +1,247 @@ +/* + * This file is part of Apollo, licensed under the MIT License. + * + * Copyright (c) 2026 Moonsworth + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +package com.lunarclient.apollo.example.proto.module.inventorybuttons; + +import com.lunarclient.apollo.button.v1.Button; +import com.lunarclient.apollo.button.v1.ButtonContent; +import com.lunarclient.apollo.button.v1.ButtonShape; +import com.lunarclient.apollo.button.v1.ButtonSize; +import com.lunarclient.apollo.button.v1.ButtonTooltip; +import com.lunarclient.apollo.common.v1.Icon; +import com.lunarclient.apollo.common.v1.ItemStackIcon; +import com.lunarclient.apollo.example.proto.util.AdventureUtil; +import com.lunarclient.apollo.example.proto.util.ProtobufPacketUtil; +import com.lunarclient.apollo.example.proto.util.ProtobufUtil; +import com.lunarclient.apollo.hud.v1.HudPosition; +import com.lunarclient.apollo.inventory.v1.DisplayInventoryButtonsMessage; +import com.lunarclient.apollo.inventory.v1.InventoryButton; +import com.lunarclient.apollo.inventory.v1.InventoryButtonBox; +import java.awt.Color; +import java.util.UUID; +import net.kyori.adventure.text.Component; +import net.kyori.adventure.text.format.NamedTextColor; +import org.bukkit.entity.Player; + +public final class HubLayout { + + public static void display(Player viewer) { + InventoryButton practice = InventoryButton.newBuilder() + .setButton(Button.newBuilder() + .setId("practice") + .setPosition(HudPosition.newBuilder().setX(6).setY(8).build()) + .setSize(ButtonSize.newBuilder().setWidth(80).setHeight(26).build()) + .setShape(ButtonShape.BUTTON_SHAPE_ROUNDED_SQUARE) + .setBackgroundColor(ProtobufUtil.createColorProto(InventoryButtonParts.BACKGROUND)) + .setBorderColor(ProtobufUtil.createColorProto(InventoryButtonParts.BORDER)) + .setContent(ButtonContent.newBuilder() + .addParts(InventoryButtonParts.iconPart(Icon.newBuilder() + .setItemStack(ItemStackIcon.newBuilder() + .setItemName("SPLASH_POTION") + .setPotion("healing") + .build()) + .build())) + .addParts(InventoryButtonParts.textPart(Component.text("Practice", NamedTextColor.LIGHT_PURPLE))) + .setScale(1.0F) + .build()) + .setTooltip(ButtonTooltip.newBuilder() + .addAdventureJsonLines(AdventureUtil.toJson(Component.text("Click to join!", NamedTextColor.YELLOW))) + .build()) + .setRunCommand("/server practice") + .build()) + .setBox(InventoryButtonBox.INVENTORY_BUTTON_BOX_LEFT) + .build(); + + InventoryButton factions = InventoryButton.newBuilder() + .setButton(Button.newBuilder() + .setId("factions") + .setPosition(HudPosition.newBuilder().setX(6).setY(40).build()) + .setSize(ButtonSize.newBuilder().setWidth(80).setHeight(26).build()) + .setShape(ButtonShape.BUTTON_SHAPE_ROUNDED_SQUARE) + .setBackgroundColor(ProtobufUtil.createColorProto(InventoryButtonParts.BACKGROUND)) + .setBorderColor(ProtobufUtil.createColorProto(InventoryButtonParts.BORDER)) + .setContent(ButtonContent.newBuilder() + .addParts(InventoryButtonParts.iconPart(Icon.newBuilder() + .setItemStack(ProtobufUtil.createItemStackIconProto("TNT", 0)) + .build())) + .addParts(InventoryButtonParts.textPart(Component.text("Factions", NamedTextColor.RED))) + .setScale(1.0F) + .build()) + .setTooltip(ButtonTooltip.newBuilder() + .addAdventureJsonLines(AdventureUtil.toJson(Component.text("Click to join!", NamedTextColor.YELLOW))) + .build()) + .setRunCommand("/server factions") + .build()) + .setBox(InventoryButtonBox.INVENTORY_BUTTON_BOX_LEFT) + .build(); + + InventoryButton bedWars = InventoryButton.newBuilder() + .setButton(Button.newBuilder() + .setId("bedwars") + .setPosition(HudPosition.newBuilder().setX(6).setY(72).build()) + .setSize(ButtonSize.newBuilder().setWidth(80).setHeight(26).build()) + .setShape(ButtonShape.BUTTON_SHAPE_ROUNDED_SQUARE) + .setBackgroundColor(ProtobufUtil.createColorProto(InventoryButtonParts.BACKGROUND)) + .setBorderColor(ProtobufUtil.createColorProto(InventoryButtonParts.BORDER)) + .setContent(ButtonContent.newBuilder() + .addParts(InventoryButtonParts.iconPart(Icon.newBuilder() + .setItemStack(ProtobufUtil.createItemStackIconProto("RED_BED", 0)) + .build())) + .addParts(InventoryButtonParts.textPart(Component.text("BedWars", NamedTextColor.AQUA))) + .setScale(1.0F) + .build()) + .setTooltip(ButtonTooltip.newBuilder() + .addAdventureJsonLines(AdventureUtil.toJson(Component.text("Click to join!", NamedTextColor.YELLOW))) + .build()) + .setRunCommand("/server bedwars") + .build()) + .setBox(InventoryButtonBox.INVENTORY_BUTTON_BOX_LEFT) + .build(); + + InventoryButton soupPvP = InventoryButton.newBuilder() + .setButton(Button.newBuilder() + .setId("souppvp") + .setPosition(HudPosition.newBuilder().setX(6).setY(104).build()) + .setSize(ButtonSize.newBuilder().setWidth(80).setHeight(26).build()) + .setShape(ButtonShape.BUTTON_SHAPE_ROUNDED_SQUARE) + .setBackgroundColor(ProtobufUtil.createColorProto(InventoryButtonParts.BACKGROUND)) + .setBorderColor(ProtobufUtil.createColorProto(InventoryButtonParts.BORDER)) + .setContent(ButtonContent.newBuilder() + .addParts(InventoryButtonParts.iconPart(Icon.newBuilder() + .setItemStack(ProtobufUtil.createItemStackIconProto("MUSHROOM_STEW", 0)) + .build())) + .addParts(InventoryButtonParts.textPart(Component.text("SoupPvP", NamedTextColor.GOLD))) + .setScale(1.0F) + .build()) + .setTooltip(ButtonTooltip.newBuilder() + .addAdventureJsonLines(AdventureUtil.toJson(Component.text("Click to join!", NamedTextColor.YELLOW))) + .build()) + .setRunCommand("/server souppvp") + .build()) + .setBox(InventoryButtonBox.INVENTORY_BUTTON_BOX_LEFT) + .build(); + + InventoryButton profile = InventoryButton.newBuilder() + .setButton(Button.newBuilder() + .setId("profile") + .setPosition(HudPosition.newBuilder().setX(4).setY(4).build()) + .setSize(ButtonSize.newBuilder().setWidth(40).setHeight(40).build()) + .setShape(ButtonShape.BUTTON_SHAPE_CIRCLE) + .setBackgroundColor(ProtobufUtil.createColorProto(InventoryButtonParts.BACKGROUND)) + .setBorderColor(ProtobufUtil.createColorProto(InventoryButtonParts.BORDER)) + .setContent(ButtonContent.newBuilder() + .addParts(InventoryButtonParts.iconPart(Icon.newBuilder() + .setItemStack(ProtobufUtil.createItemStackIconProto( + "PLAYER_HEAD", 0, null, // use "skull" for legacy with customModelData set to 3 + ProtobufUtil.createProfileProto( + UUID.fromString("f17627d8-1a97-487b-92ea-c04f413394bd"), + "e3RleHR1cmVzOntTS0lOOnt1cmw6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvOWQ4MjUwNWJjZjNiYTU5YzJiZTdlMmQzNmY0ZTJiZGE4MzZmMmZkMTk0YjYyMTJhMmExYzRiNGEyYTQ3MWUifX19", + "" + ) + )) + .build())) + .setScale(1.0F) + .build()) + .setTooltip(ButtonTooltip.newBuilder() + .addAdventureJsonLines(AdventureUtil.toJson(Component.text(viewer.getName(), NamedTextColor.GOLD))) + .addAdventureJsonLines(AdventureUtil.toJson(Component.text("View your stats", NamedTextColor.GRAY))) + .build()) + .setRunCommand("/profile") + .build()) + .setBox(InventoryButtonBox.INVENTORY_BUTTON_BOX_RIGHT) + .build(); + + InventoryButton settings = InventoryButton.newBuilder() + .setButton(Button.newBuilder() + .setId("settings") + .setPosition(HudPosition.newBuilder().setX(48).setY(4).build()) + .setSize(ButtonSize.newBuilder().setWidth(40).setHeight(40).build()) + .setShape(ButtonShape.BUTTON_SHAPE_CIRCLE) + .setBackgroundColor(ProtobufUtil.createColorProto(new Color(222, 160, 60, 85))) + .setBorderColor(ProtobufUtil.createColorProto(new Color(255, 218, 150, 140))) + .setContent(ButtonContent.newBuilder() + .addParts(InventoryButtonParts.iconPart(Icon.newBuilder() + .setItemStack(ProtobufUtil.createItemStackIconProto("COMPARATOR", 0)) + .build())) + .setScale(1.0F) + .build()) + .setTooltip(ButtonTooltip.newBuilder() + .addAdventureJsonLines(AdventureUtil.toJson(Component.text("Settings", NamedTextColor.WHITE))) + .addAdventureJsonLines(AdventureUtil.toJson(Component.text("Server preferences", NamedTextColor.GRAY))) + .build()) + .setRunCommand("/settings") + .build()) + .setBox(InventoryButtonBox.INVENTORY_BUTTON_BOX_RIGHT) + .build(); + + InventoryButton changelog = InventoryButton.newBuilder() + .setButton(Button.newBuilder() + .setId("changelog") + .setPosition(HudPosition.newBuilder().setX(6).setY(52).build()) + .setSize(ButtonSize.newBuilder().setWidth(80).setHeight(26).build()) + .setShape(ButtonShape.BUTTON_SHAPE_ROUNDED_SQUARE) + .setBackgroundColor(ProtobufUtil.createColorProto(InventoryButtonParts.BACKGROUND)) + .setBorderColor(ProtobufUtil.createColorProto(InventoryButtonParts.BORDER)) + .setContent(ButtonContent.newBuilder() + .addParts(InventoryButtonParts.iconPart(Icon.newBuilder() + .setItemStack(ProtobufUtil.createItemStackIconProto("WRITABLE_BOOK", 0)) + .build())) + .addParts(InventoryButtonParts.textPart(Component.text("Changelog"))) + .setScale(1.0F) + .build()) + .setTooltip(ButtonTooltip.newBuilder() + .addAdventureJsonLines(AdventureUtil.toJson(Component.text("🌙 Apollo - v1.2.8", NamedTextColor.GOLD))) + .addAdventureJsonLines(AdventureUtil.toJson(Component.empty())) + .addAdventureJsonLines(AdventureUtil.toJson(Component.text("• Released Markers Module", NamedTextColor.GRAY))) + .addAdventureJsonLines(AdventureUtil.toJson(Component.text("• Added ALLOW_DIG_AND_USE & DISABLE_BLOCK_MISS_PENALTY", NamedTextColor.GRAY))) + .addAdventureJsonLines(AdventureUtil.toJson(Component.text(" options to Combat Module", NamedTextColor.GRAY))) + .addAdventureJsonLines(AdventureUtil.toJson(Component.text("• Added configurable Server Link Button placement", NamedTextColor.GRAY))) + .addAdventureJsonLines(AdventureUtil.toJson(Component.text("• Added API option to auto-enable Staff Mods", NamedTextColor.GRAY))) + .addAdventureJsonLines(AdventureUtil.toJson(Component.text(" when unlocked via the Staff Mod Module", NamedTextColor.GRAY))) + .addAdventureJsonLines(AdventureUtil.toJson(Component.text("• Improved performance with various optimizations", NamedTextColor.GRAY))) + .addAdventureJsonLines(AdventureUtil.toJson(Component.empty())) + .addAdventureJsonLines(AdventureUtil.toJson(Component.text("Read the full changelog at", NamedTextColor.YELLOW))) + .addAdventureJsonLines(AdventureUtil.toJson(Component.text("https://github.com/LunarClient/Apollo/releases/tag/v1.2.8", NamedTextColor.YELLOW))) + .build()) + .setOpenUrl("https://github.com/LunarClient/Apollo/releases/tag/v1.2.8") + .build()) + .setBox(InventoryButtonBox.INVENTORY_BUTTON_BOX_RIGHT) + .build(); + + DisplayInventoryButtonsMessage message = DisplayInventoryButtonsMessage.newBuilder() + .addInventoryButtons(practice) + .addInventoryButtons(factions) + .addInventoryButtons(bedWars) + .addInventoryButtons(soupPvP) + .addInventoryButtons(profile) + .addInventoryButtons(settings) + .addInventoryButtons(changelog) + .build(); + + ProtobufPacketUtil.sendPacket(viewer, message); + } + + private HubLayout() { + } + +} diff --git a/example/bukkit/proto/src/main/java/com/lunarclient/apollo/example/proto/module/inventorybuttons/InventoryButtonParts.java b/example/bukkit/proto/src/main/java/com/lunarclient/apollo/example/proto/module/inventorybuttons/InventoryButtonParts.java new file mode 100644 index 00000000..8160a437 --- /dev/null +++ b/example/bukkit/proto/src/main/java/com/lunarclient/apollo/example/proto/module/inventorybuttons/InventoryButtonParts.java @@ -0,0 +1,70 @@ +/* + * This file is part of Apollo, licensed under the MIT License. + * + * Copyright (c) 2026 Moonsworth + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +package com.lunarclient.apollo.example.proto.module.inventorybuttons; + +import com.lunarclient.apollo.button.v1.ButtonContentPart; +import com.lunarclient.apollo.button.v1.ButtonTooltip; +import com.lunarclient.apollo.common.v1.Icon; +import com.lunarclient.apollo.example.proto.util.AdventureUtil; +import java.awt.Color; +import java.util.ArrayList; +import java.util.List; +import net.kyori.adventure.text.Component; + +public final class InventoryButtonParts { + + public static final Color BACKGROUND = new Color(255, 255, 255, 40); + public static final Color BORDER = new Color(37, 37, 37, 128); + + public static ButtonContentPart textPart(Component component) { + return ButtonContentPart.newBuilder() + .setAdventureJsonText(AdventureUtil.toJson(component)) + .build(); + } + + public static ButtonContentPart iconPart(Icon icon) { + return ButtonContentPart.newBuilder() + .setIcon(icon) + .build(); + } + + public static List tooltipJson(Component... lines) { + List json = new ArrayList<>(lines.length); + for (Component line : lines) { + json.add(AdventureUtil.toJson(line)); + } + + return json; + } + + public static ButtonTooltip tooltipMessage(List adventureJsonLines) { + return ButtonTooltip.newBuilder() + .addAllAdventureJsonLines(adventureJsonLines) + .build(); + } + + private InventoryButtonParts() { + } + +} diff --git a/example/bukkit/proto/src/main/java/com/lunarclient/apollo/example/proto/module/inventorybuttons/MenuLayout.java b/example/bukkit/proto/src/main/java/com/lunarclient/apollo/example/proto/module/inventorybuttons/MenuLayout.java new file mode 100644 index 00000000..9be7efc4 --- /dev/null +++ b/example/bukkit/proto/src/main/java/com/lunarclient/apollo/example/proto/module/inventorybuttons/MenuLayout.java @@ -0,0 +1,338 @@ +/* + * This file is part of Apollo, licensed under the MIT License. + * + * Copyright (c) 2026 Moonsworth + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +package com.lunarclient.apollo.example.proto.module.inventorybuttons; + +import com.lunarclient.apollo.button.v1.Button; +import com.lunarclient.apollo.button.v1.ButtonContent; +import com.lunarclient.apollo.button.v1.ButtonShape; +import com.lunarclient.apollo.button.v1.ButtonSize; +import com.lunarclient.apollo.button.v1.ButtonTooltip; +import com.lunarclient.apollo.button.v1.ButtonUpdate; +import com.lunarclient.apollo.common.v1.Icon; +import com.lunarclient.apollo.example.proto.util.AdventureUtil; +import com.lunarclient.apollo.example.proto.util.ProtobufPacketUtil; +import com.lunarclient.apollo.example.proto.util.ProtobufUtil; +import com.lunarclient.apollo.hud.v1.HudPosition; +import com.lunarclient.apollo.inventory.v1.DisplayInventoryButtonsMessage; +import com.lunarclient.apollo.inventory.v1.InventoryButton; +import com.lunarclient.apollo.inventory.v1.InventoryButtonBox; +import com.lunarclient.apollo.inventory.v1.InventoryType; +import com.lunarclient.apollo.inventory.v1.UpdateInventoryButtonMessage; +import java.awt.Color; +import java.util.List; +import java.util.UUID; +import net.kyori.adventure.text.Component; +import net.kyori.adventure.text.format.NamedTextColor; +import org.bukkit.entity.Player; + +public final class MenuLayout { + + public static void display(Player viewer) { + InventoryButton shop = InventoryButton.newBuilder() + .setInventoryType(InventoryType.INVENTORY_TYPE_PLAYER) + .setButton(Button.newBuilder() + .setId("shop") + .setPosition(HudPosition.newBuilder().setX(4).setY(4).build()) + .setSize(ButtonSize.newBuilder().setWidth(40).setHeight(40).build()) + .setShape(ButtonShape.BUTTON_SHAPE_ROUNDED_SQUARE) + .setBackgroundColor(ProtobufUtil.createColorProto(InventoryButtonParts.BACKGROUND)) + .setBorderColor(ProtobufUtil.createColorProto(InventoryButtonParts.BORDER)) + .setContent(ButtonContent.newBuilder() + .addParts(InventoryButtonParts.iconPart(Icon.newBuilder() + .setItemStack(ProtobufUtil.createItemStackIconProto("EMERALD", 0)) + .build())) + .setScale(1.0F) + .build()) + .setTooltip(ButtonTooltip.newBuilder() + .addAdventureJsonLines(AdventureUtil.toJson(Component.text("Shop", NamedTextColor.GREEN))) + .addAdventureJsonLines(AdventureUtil.toJson(Component.text("Browse categories and buy items", NamedTextColor.GRAY))) + .addAdventureJsonLines(AdventureUtil.toJson(Component.text("Click to open", NamedTextColor.YELLOW))) + .build()) + .setRunCommand("/shop") + .build()) + .setBox(InventoryButtonBox.INVENTORY_BUTTON_BOX_LEFT) + .build(); + + InventoryButton spawn = InventoryButton.newBuilder() + .setButton(Button.newBuilder() + .setId("spawn") + .setPosition(HudPosition.newBuilder().setX(48).setY(4).build()) + .setSize(ButtonSize.newBuilder().setWidth(40).setHeight(40).build()) + .setShape(ButtonShape.BUTTON_SHAPE_ROUNDED_SQUARE) + .setBackgroundColor(ProtobufUtil.createColorProto(InventoryButtonParts.BACKGROUND)) + .setBorderColor(ProtobufUtil.createColorProto(InventoryButtonParts.BORDER)) + .setContent(ButtonContent.newBuilder() + .addParts(InventoryButtonParts.iconPart(Icon.newBuilder() + .setItemStack(ProtobufUtil.createItemStackIconProto("RED_BED", 0)) + .build())) + .setScale(1.0F) + .build()) + .setTooltip(ButtonTooltip.newBuilder() + .addAdventureJsonLines(AdventureUtil.toJson(Component.text("Spawn", NamedTextColor.AQUA))) + .addAdventureJsonLines(AdventureUtil.toJson(Component.text("Teleport back to spawn", NamedTextColor.GRAY))) + .addAdventureJsonLines(AdventureUtil.toJson(Component.text("Click to teleport", NamedTextColor.YELLOW))) + .build()) + .setRunCommand("/spawn") + .build()) + .setBox(InventoryButtonBox.INVENTORY_BUTTON_BOX_LEFT) + .build(); + + InventoryButton warps = InventoryButton.newBuilder() + .setButton(Button.newBuilder() + .setId("warps") + .setPosition(HudPosition.newBuilder().setX(4).setY(48).build()) + .setSize(ButtonSize.newBuilder().setWidth(40).setHeight(40).build()) + .setShape(ButtonShape.BUTTON_SHAPE_ROUNDED_SQUARE) + .setBackgroundColor(ProtobufUtil.createColorProto(InventoryButtonParts.BACKGROUND)) + .setBorderColor(ProtobufUtil.createColorProto(InventoryButtonParts.BORDER)) + .setContent(ButtonContent.newBuilder() + .addParts(InventoryButtonParts.iconPart(Icon.newBuilder() + .setItemStack(ProtobufUtil.createItemStackIconProto("COMPASS", 0)) + .build())) + .setScale(1.0F) + .build()) + .setTooltip(ButtonTooltip.newBuilder() + .addAdventureJsonLines(AdventureUtil.toJson(Component.text("Warps", NamedTextColor.AQUA))) + .addAdventureJsonLines(AdventureUtil.toJson(Component.text("Browse public warps", NamedTextColor.GRAY))) + .addAdventureJsonLines(AdventureUtil.toJson(Component.text("Click to teleport", NamedTextColor.YELLOW))) + .build()) + .setRunCommand("/warps") + .build()) + .setBox(InventoryButtonBox.INVENTORY_BUTTON_BOX_LEFT) + .build(); + + InventoryButton enderChest = InventoryButton.newBuilder() + .setButton(Button.newBuilder() + .setId("enderchest") + .setPosition(HudPosition.newBuilder().setX(48).setY(48).build()) + .setSize(ButtonSize.newBuilder().setWidth(40).setHeight(40).build()) + .setShape(ButtonShape.BUTTON_SHAPE_ROUNDED_SQUARE) + .setBackgroundColor(ProtobufUtil.createColorProto(InventoryButtonParts.BACKGROUND)) + .setBorderColor(ProtobufUtil.createColorProto(InventoryButtonParts.BORDER)) + .setContent(ButtonContent.newBuilder() + .addParts(InventoryButtonParts.iconPart(Icon.newBuilder() + .setItemStack(ProtobufUtil.createItemStackIconProto("ENDER_CHEST", 0)) + .build())) + .setScale(1.0F) + .build()) + .setTooltip(ButtonTooltip.newBuilder() + .addAdventureJsonLines(AdventureUtil.toJson(Component.text("Ender Chest", NamedTextColor.LIGHT_PURPLE))) + .addAdventureJsonLines(AdventureUtil.toJson(Component.text("Open your personal storage", NamedTextColor.GRAY))) + .addAdventureJsonLines(AdventureUtil.toJson(Component.text("Click to open", NamedTextColor.YELLOW))) + .build()) + .setRunCommand("/enderchest") + .build()) + .setBox(InventoryButtonBox.INVENTORY_BUTTON_BOX_LEFT) + .build(); + + InventoryButton balance = InventoryButton.newBuilder() + .setButton(Button.newBuilder() + .setId("balance") + .setPosition(HudPosition.newBuilder().setX(6).setY(92).build()) + .setSize(ButtonSize.newBuilder().setWidth(80).setHeight(26).build()) + .setShape(ButtonShape.BUTTON_SHAPE_ROUNDED_SQUARE) + .setBackgroundColor(ProtobufUtil.createColorProto(InventoryButtonParts.BACKGROUND)) + .setBorderColor(ProtobufUtil.createColorProto(InventoryButtonParts.BORDER)) + .setContent(ButtonContent.newBuilder() + .addParts(InventoryButtonParts.iconPart(Icon.newBuilder() + .setItemStack(ProtobufUtil.createItemStackIconProto("GOLD_INGOT", 0)) + .build())) + .addParts(InventoryButtonParts.textPart(balanceContent(viewer))) + .setScale(1.0F) + .build()) + .setTooltip(InventoryButtonParts.tooltipMessage(balanceTooltip())) + .build()) + .setBox(InventoryButtonBox.INVENTORY_BUTTON_BOX_LEFT) + .build(); + + InventoryButton profile = InventoryButton.newBuilder() + .setButton(Button.newBuilder() + .setId("profile") + .setPosition(HudPosition.newBuilder().setX(4).setY(4).build()) + .setSize(ButtonSize.newBuilder().setWidth(40).setHeight(40).build()) + .setShape(ButtonShape.BUTTON_SHAPE_CIRCLE) + .setBackgroundColor(ProtobufUtil.createColorProto(InventoryButtonParts.BACKGROUND)) + .setBorderColor(ProtobufUtil.createColorProto(InventoryButtonParts.BORDER)) + .setContent(ButtonContent.newBuilder() + .addParts(InventoryButtonParts.iconPart(Icon.newBuilder() + .setItemStack(ProtobufUtil.createItemStackIconProto( + "PLAYER_HEAD", 0, null, // use "skull" for legacy with customModelData set to 3 + ProtobufUtil.createProfileProto( + UUID.fromString("f17627d8-1a97-487b-92ea-c04f413394bd"), + "e3RleHR1cmVzOntTS0lOOnt1cmw6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvOWQ4MjUwNWJjZjNiYTU5YzJiZTdlMmQzNmY0ZTJiZGE4MzZmMmZkMTk0YjYyMTJhMmExYzRiNGEyYTQ3MWUifX19", + "" + ) + )) + .build())) + .setScale(1.0F) + .build()) + .setTooltip(ButtonTooltip.newBuilder() + .addAdventureJsonLines(AdventureUtil.toJson(Component.text(viewer.getName(), NamedTextColor.GOLD))) + .addAdventureJsonLines(AdventureUtil.toJson(Component.text("View your stats", NamedTextColor.GRAY))) + .build()) + .setRunCommand("/profile") + .build()) + .setBox(InventoryButtonBox.INVENTORY_BUTTON_BOX_RIGHT) + .build(); + + InventoryButton settings = InventoryButton.newBuilder() + .setButton(Button.newBuilder() + .setId("settings") + .setPosition(HudPosition.newBuilder().setX(48).setY(4).build()) + .setSize(ButtonSize.newBuilder().setWidth(40).setHeight(40).build()) + .setShape(ButtonShape.BUTTON_SHAPE_CIRCLE) + .setBackgroundColor(ProtobufUtil.createColorProto(new Color(222, 160, 60, 85))) + .setBorderColor(ProtobufUtil.createColorProto(new Color(255, 218, 150, 140))) + .setContent(ButtonContent.newBuilder() + .addParts(InventoryButtonParts.iconPart(Icon.newBuilder() + .setItemStack(ProtobufUtil.createItemStackIconProto("COMPARATOR", 0)) + .build())) + .setScale(1.0F) + .build()) + .setTooltip(ButtonTooltip.newBuilder() + .addAdventureJsonLines(AdventureUtil.toJson(Component.text("Settings", NamedTextColor.WHITE))) + .addAdventureJsonLines(AdventureUtil.toJson(Component.text("Server preferences", NamedTextColor.GRAY))) + .build()) + .setRunCommand("/settings") + .build()) + .setBox(InventoryButtonBox.INVENTORY_BUTTON_BOX_RIGHT) + .build(); + + InventoryButton vote = InventoryButton.newBuilder() + .setButton(Button.newBuilder() + .setId("vote") + .setPosition(HudPosition.newBuilder().setX(6).setY(52).build()) + .setSize(ButtonSize.newBuilder().setWidth(80).setHeight(26).build()) + .setShape(ButtonShape.BUTTON_SHAPE_ROUNDED_SQUARE) + .setBackgroundColor(ProtobufUtil.createColorProto(new Color(34, 204, 68, 64))) + .setBorderColor(ProtobufUtil.createColorProto(new Color(190, 255, 205, 110))) + .setHoveredBackgroundColor(ProtobufUtil.createColorProto(new Color(34, 204, 68, 130))) + .setHoveredBorderColor(ProtobufUtil.createColorProto(new Color(190, 255, 205, 210))) + .setContent(ButtonContent.newBuilder() + .addParts(InventoryButtonParts.textPart(Component.text("Vote"))) + .setScale(1.0F) + .build()) + .setTooltip(ButtonTooltip.newBuilder() + .addAdventureJsonLines(AdventureUtil.toJson(Component.text("Vote", NamedTextColor.GREEN))) + .addAdventureJsonLines(AdventureUtil.toJson(Component.text("Vote daily for rewards", NamedTextColor.GRAY))) + .build()) + .setOpenUrl("https://example.com/vote") + .build()) + .setBox(InventoryButtonBox.INVENTORY_BUTTON_BOX_RIGHT) + .build(); + + InventoryButton discord = InventoryButton.newBuilder() + .setButton(Button.newBuilder() + .setId("discord") + .setPosition(HudPosition.newBuilder().setX(6).setY(84).build()) + .setSize(ButtonSize.newBuilder().setWidth(80).setHeight(26).build()) + .setShape(ButtonShape.BUTTON_SHAPE_ROUNDED_SQUARE) + .setBackgroundColor(ProtobufUtil.createColorProto(new Color(88, 101, 242, 90))) + .setBorderColor(ProtobufUtil.createColorProto(new Color(150, 160, 250, 140))) + .setContent(ButtonContent.newBuilder() + .addParts(InventoryButtonParts.textPart(Component.text("Discord"))) + .setScale(1.0F) + .build()) + .setTooltip(ButtonTooltip.newBuilder() + .addAdventureJsonLines(AdventureUtil.toJson(Component.text("Discord", NamedTextColor.BLUE))) + .addAdventureJsonLines(AdventureUtil.toJson(Component.text("Join our community", NamedTextColor.GRAY))) + .build()) + .setOpenUrl("https://lunarclient.dev/discord") + .build()) + .setBox(InventoryButtonBox.INVENTORY_BUTTON_BOX_RIGHT) + .build(); + + InventoryButton lobby = InventoryButton.newBuilder() + .setButton(Button.newBuilder() + .setId("lobby") + .setPosition(HudPosition.newBuilder().setX(6).setY(136).build()) + .setSize(ButtonSize.newBuilder().setWidth(80).setHeight(26).build()) + .setShape(ButtonShape.BUTTON_SHAPE_ROUNDED_SQUARE) + .setBackgroundColor(ProtobufUtil.createColorProto(new Color(224, 64, 64, 128))) + .setBorderColor(ProtobufUtil.createColorProto(new Color(255, 200, 200, 140))) + .setContent(ButtonContent.newBuilder() + .addParts(InventoryButtonParts.textPart(Component.text("Back to Lobby"))) + .setScale(1.0F) + .build()) + .setTooltip(ButtonTooltip.newBuilder() + .addAdventureJsonLines(AdventureUtil.toJson(Component.text("Back to Lobby", NamedTextColor.RED))) + .addAdventureJsonLines(AdventureUtil.toJson(Component.text("Return to the main lobby", NamedTextColor.GRAY))) + .build()) + .setRunCommand("/lobby") + .build()) + .setBox(InventoryButtonBox.INVENTORY_BUTTON_BOX_RIGHT) + .build(); + + DisplayInventoryButtonsMessage message = DisplayInventoryButtonsMessage.newBuilder() + .addInventoryButtons(shop) + .addInventoryButtons(spawn) + .addInventoryButtons(warps) + .addInventoryButtons(enderChest) + .addInventoryButtons(balance) + .addInventoryButtons(profile) + .addInventoryButtons(settings) + .addInventoryButtons(vote) + .addInventoryButtons(discord) + .addInventoryButtons(lobby) + .build(); + + ProtobufPacketUtil.sendPacket(viewer, message); + } + + public static void sendBalanceUpdate(Player viewer) { + UpdateInventoryButtonMessage message = UpdateInventoryButtonMessage.newBuilder() + .setId("balance") + .setUpdate(ButtonUpdate.newBuilder() + .setContent(ButtonContent.newBuilder() + .addParts(InventoryButtonParts.iconPart(Icon.newBuilder() + .setItemStack(ProtobufUtil.createItemStackIconProto("GOLD_INGOT", 0)) + .build())) + .addParts(InventoryButtonParts.textPart(balanceContent(viewer))) + .setScale(1.0F) + .build()) + .setTooltip(InventoryButtonParts.tooltipMessage(balanceTooltip())) + .build()) + .build(); + + ProtobufPacketUtil.sendPacket(viewer, message); + } + + private static Component balanceContent(Player viewer) { + return Component.text("$" + String.format("%,d", getBalance(viewer.getUniqueId())), NamedTextColor.GOLD); + } + + private static List balanceTooltip() { + return InventoryButtonParts.tooltipJson(Component.text("Your balance", NamedTextColor.GOLD)); + } + + // Demo economy: replace with your economy plugin lookup (e.g. Vault) + private static long getBalance(UUID playerIdentifier) { + long drift = (System.currentTimeMillis() / 10_000L) % 250L; + return 1_000L + Math.abs(playerIdentifier.hashCode() % 4_000) + drift; + } + + private MenuLayout() { + } + +} diff --git a/example/bukkit/proto/src/main/java/com/lunarclient/apollo/example/proto/module/inventorybuttons/MinigameLayout.java b/example/bukkit/proto/src/main/java/com/lunarclient/apollo/example/proto/module/inventorybuttons/MinigameLayout.java new file mode 100644 index 00000000..a86f527d --- /dev/null +++ b/example/bukkit/proto/src/main/java/com/lunarclient/apollo/example/proto/module/inventorybuttons/MinigameLayout.java @@ -0,0 +1,251 @@ +/* + * This file is part of Apollo, licensed under the MIT License. + * + * Copyright (c) 2026 Moonsworth + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +package com.lunarclient.apollo.example.proto.module.inventorybuttons; + +import com.lunarclient.apollo.button.v1.Button; +import com.lunarclient.apollo.button.v1.ButtonClientAction; +import com.lunarclient.apollo.button.v1.ButtonContent; +import com.lunarclient.apollo.button.v1.ButtonShape; +import com.lunarclient.apollo.button.v1.ButtonSize; +import com.lunarclient.apollo.button.v1.ButtonTooltip; +import com.lunarclient.apollo.button.v1.ButtonUpdate; +import com.lunarclient.apollo.common.v1.Icon; +import com.lunarclient.apollo.example.proto.util.AdventureUtil; +import com.lunarclient.apollo.example.proto.util.ProtobufPacketUtil; +import com.lunarclient.apollo.example.proto.util.ProtobufUtil; +import com.lunarclient.apollo.hud.v1.HudPosition; +import com.lunarclient.apollo.inventory.v1.DisplayInventoryButtonsMessage; +import com.lunarclient.apollo.inventory.v1.InventoryButton; +import com.lunarclient.apollo.inventory.v1.InventoryButtonBox; +import com.lunarclient.apollo.inventory.v1.UpdateInventoryButtonMessage; +import java.awt.Color; +import java.util.UUID; +import net.kyori.adventure.text.Component; +import net.kyori.adventure.text.format.NamedTextColor; +import org.bukkit.Statistic; +import org.bukkit.entity.Player; + +public final class MinigameLayout { + + public static void display(Player viewer) { + InventoryButton mapInfo = InventoryButton.newBuilder() + .setButton(Button.newBuilder() + .setId("map-info") + .setPosition(HudPosition.newBuilder().setX(6).setY(8).build()) + .setSize(ButtonSize.newBuilder().setWidth(80).setHeight(26).build()) + .setShape(ButtonShape.BUTTON_SHAPE_ROUNDED_SQUARE) + .setBackgroundColor(ProtobufUtil.createColorProto(InventoryButtonParts.BACKGROUND)) + .setBorderColor(ProtobufUtil.createColorProto(InventoryButtonParts.BORDER)) + .setContent(ButtonContent.newBuilder() + .addParts(InventoryButtonParts.textPart(Component.text("Map: Apollo", NamedTextColor.AQUA))) + .setScale(1.0F) + .build()) + .setTooltip(ButtonTooltip.newBuilder() + .addAdventureJsonLines(AdventureUtil.toJson(Component.text("Built by the Lunar Client Team"))) + .addAdventureJsonLines(AdventureUtil.toJson(Component.text("Released in 2024", NamedTextColor.GRAY))) + .build()) + .build()) + .setBox(InventoryButtonBox.INVENTORY_BUTTON_BOX_LEFT) + .build(); + + InventoryButton kills = InventoryButton.newBuilder() + .setButton(Button.newBuilder() + .setId("kills") + .setPosition(HudPosition.newBuilder().setX(6).setY(40).build()) + .setSize(ButtonSize.newBuilder().setWidth(80).setHeight(26).build()) + .setShape(ButtonShape.BUTTON_SHAPE_ROUNDED_SQUARE) + .setBackgroundColor(ProtobufUtil.createColorProto(InventoryButtonParts.BACKGROUND)) + .setBorderColor(ProtobufUtil.createColorProto(InventoryButtonParts.BORDER)) + .setContent(ButtonContent.newBuilder() + .addParts(InventoryButtonParts.iconPart(Icon.newBuilder() + .setItemStack(ProtobufUtil.createItemStackIconProto("IRON_SWORD", 0)) + .build())) + .addParts(InventoryButtonParts.textPart(killsContent(viewer))) + .setScale(1.0F) + .build()) + .build()) + .setBox(InventoryButtonBox.INVENTORY_BUTTON_BOX_LEFT) + .build(); + + InventoryButton lobby = InventoryButton.newBuilder() + .setButton(Button.newBuilder() + .setId("lobby") + .setPosition(HudPosition.newBuilder().setX(6).setY(136).build()) + .setSize(ButtonSize.newBuilder().setWidth(80).setHeight(26).build()) + .setShape(ButtonShape.BUTTON_SHAPE_ROUNDED_SQUARE) + .setBackgroundColor(ProtobufUtil.createColorProto(new Color(224, 64, 64, 128))) + .setBorderColor(ProtobufUtil.createColorProto(new Color(255, 200, 200, 140))) + .setContent(ButtonContent.newBuilder() + .addParts(InventoryButtonParts.textPart(Component.text("Back to Lobby"))) + .setScale(1.0F) + .build()) + .setTooltip(ButtonTooltip.newBuilder() + .addAdventureJsonLines(AdventureUtil.toJson(Component.text("Back to Lobby", NamedTextColor.RED))) + .addAdventureJsonLines(AdventureUtil.toJson(Component.text("Return to the main lobby", NamedTextColor.GRAY))) + .build()) + .setRunCommand("/lobby") + .build()) + .setBox(InventoryButtonBox.INVENTORY_BUTTON_BOX_RIGHT) + .build(); + + InventoryButton profile = InventoryButton.newBuilder() + .setButton(Button.newBuilder() + .setId("profile") + .setPosition(HudPosition.newBuilder().setX(4).setY(4).build()) + .setSize(ButtonSize.newBuilder().setWidth(40).setHeight(40).build()) + .setShape(ButtonShape.BUTTON_SHAPE_CIRCLE) + .setBackgroundColor(ProtobufUtil.createColorProto(InventoryButtonParts.BACKGROUND)) + .setBorderColor(ProtobufUtil.createColorProto(InventoryButtonParts.BORDER)) + .setContent(ButtonContent.newBuilder() + .addParts(InventoryButtonParts.iconPart(Icon.newBuilder() + .setItemStack(ProtobufUtil.createItemStackIconProto( + "PLAYER_HEAD", 0, null, // use "skull" for legacy with customModelData set to 3 + ProtobufUtil.createProfileProto( + UUID.fromString("f17627d8-1a97-487b-92ea-c04f413394bd"), + "e3RleHR1cmVzOntTS0lOOnt1cmw6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvOWQ4MjUwNWJjZjNiYTU5YzJiZTdlMmQzNmY0ZTJiZGE4MzZmMmZkMTk0YjYyMTJhMmExYzRiNGEyYTQ3MWUifX19", + "" + ) + )) + .build())) + .setScale(1.0F) + .build()) + .setTooltip(ButtonTooltip.newBuilder() + .addAdventureJsonLines(AdventureUtil.toJson(Component.text(viewer.getName(), NamedTextColor.GOLD))) + .addAdventureJsonLines(AdventureUtil.toJson(Component.text("View your stats", NamedTextColor.GRAY))) + .build()) + .setRunCommand("/profile") + .build()) + .setBox(InventoryButtonBox.INVENTORY_BUTTON_BOX_RIGHT) + .build(); + + InventoryButton settings = InventoryButton.newBuilder() + .setButton(Button.newBuilder() + .setId("settings") + .setPosition(HudPosition.newBuilder().setX(48).setY(4).build()) + .setSize(ButtonSize.newBuilder().setWidth(40).setHeight(40).build()) + .setShape(ButtonShape.BUTTON_SHAPE_CIRCLE) + .setBackgroundColor(ProtobufUtil.createColorProto(new Color(222, 160, 60, 85))) + .setBorderColor(ProtobufUtil.createColorProto(new Color(255, 218, 150, 140))) + .setContent(ButtonContent.newBuilder() + .addParts(InventoryButtonParts.iconPart(Icon.newBuilder() + .setItemStack(ProtobufUtil.createItemStackIconProto("COMPARATOR", 0)) + .build())) + .setScale(1.0F) + .build()) + .setTooltip(ButtonTooltip.newBuilder() + .addAdventureJsonLines(AdventureUtil.toJson(Component.text("Settings", NamedTextColor.WHITE))) + .addAdventureJsonLines(AdventureUtil.toJson(Component.text("Server preferences", NamedTextColor.GRAY))) + .build()) + .setRunCommand("/settings") + .build()) + .setBox(InventoryButtonBox.INVENTORY_BUTTON_BOX_RIGHT) + .build(); + + InventoryButton showMap = InventoryButton.newBuilder() + .setButton(Button.newBuilder() + .setId("show-map") + .setPosition(HudPosition.newBuilder().setX(6).setY(52).build()) + .setSize(ButtonSize.newBuilder().setWidth(80).setHeight(26).build()) + .setShape(ButtonShape.BUTTON_SHAPE_ROUNDED_SQUARE) + .setBackgroundColor(ProtobufUtil.createColorProto(InventoryButtonParts.BACKGROUND)) + .setBorderColor(ProtobufUtil.createColorProto(InventoryButtonParts.BORDER)) + .setContent(ButtonContent.newBuilder() + .addParts(InventoryButtonParts.iconPart(Icon.newBuilder() + .setItemStack(ProtobufUtil.createItemStackIconProto("FILLED_MAP", 0)) + .build())) + .addParts(InventoryButtonParts.textPart(Component.text("Show Map"))) + .setScale(1.0F) + .build()) + .setTooltip(ButtonTooltip.newBuilder() + .addAdventureJsonLines(AdventureUtil.toJson(Component.text("Show Map", NamedTextColor.AQUA))) + .addAdventureJsonLines(AdventureUtil.toJson(Component.text("Open the fullscreen minimap view", NamedTextColor.GRAY))) + .build()) + .setClientAction(ButtonClientAction.BUTTON_CLIENT_ACTION_OPEN_MINIMAP_VIEW) + .build()) + .setBox(InventoryButtonBox.INVENTORY_BUTTON_BOX_RIGHT) + .build(); + + InventoryButton waypoints = InventoryButton.newBuilder() + .setButton(Button.newBuilder() + .setId("waypoints") + .setPosition(HudPosition.newBuilder().setX(6).setY(84).build()) + .setSize(ButtonSize.newBuilder().setWidth(80).setHeight(26).build()) + .setShape(ButtonShape.BUTTON_SHAPE_ROUNDED_SQUARE) + .setBackgroundColor(ProtobufUtil.createColorProto(InventoryButtonParts.BACKGROUND)) + .setBorderColor(ProtobufUtil.createColorProto(InventoryButtonParts.BORDER)) + .setContent(ButtonContent.newBuilder() + .addParts(InventoryButtonParts.iconPart(Icon.newBuilder() + .setItemStack(ProtobufUtil.createItemStackIconProto("LODESTONE", 0)) + .build())) + .addParts(InventoryButtonParts.textPart(Component.text("Waypoints"))) + .setScale(1.0F) + .build()) + .setTooltip(ButtonTooltip.newBuilder() + .addAdventureJsonLines(AdventureUtil.toJson(Component.text("Waypoints", NamedTextColor.GOLD))) + .addAdventureJsonLines(AdventureUtil.toJson(Component.text("Manage your waypoints", NamedTextColor.GRAY))) + .build()) + .setClientAction(ButtonClientAction.BUTTON_CLIENT_ACTION_OPEN_WAYPOINTS_MENU) + .build()) + .setBox(InventoryButtonBox.INVENTORY_BUTTON_BOX_RIGHT) + .build(); + + DisplayInventoryButtonsMessage message = DisplayInventoryButtonsMessage.newBuilder() + .addInventoryButtons(mapInfo) + .addInventoryButtons(kills) + .addInventoryButtons(lobby) + .addInventoryButtons(profile) + .addInventoryButtons(settings) + .addInventoryButtons(showMap) + .addInventoryButtons(waypoints) + .build(); + + ProtobufPacketUtil.sendPacket(viewer, message); + } + + public static void sendKillsUpdate(Player viewer) { + UpdateInventoryButtonMessage message = UpdateInventoryButtonMessage.newBuilder() + .setId("kills") + .setUpdate(ButtonUpdate.newBuilder() + .setContent(ButtonContent.newBuilder() + .addParts(InventoryButtonParts.iconPart(Icon.newBuilder() + .setItemStack(ProtobufUtil.createItemStackIconProto("IRON_SWORD", 0)) + .build())) + .addParts(InventoryButtonParts.textPart(killsContent(viewer))) + .setScale(1.0F) + .build()) + .build()) + .build(); + + ProtobufPacketUtil.sendPacket(viewer, message); + } + + private static Component killsContent(Player viewer) { + return Component.text("Kills: ", NamedTextColor.GRAY) + .append(Component.text(viewer.getStatistic(Statistic.PLAYER_KILLS), NamedTextColor.RED)); + } + + private MinigameLayout() { + } + +} diff --git a/example/bukkit/proto/src/main/java/com/lunarclient/apollo/example/proto/module/inventorybuttons/StaffLayout.java b/example/bukkit/proto/src/main/java/com/lunarclient/apollo/example/proto/module/inventorybuttons/StaffLayout.java new file mode 100644 index 00000000..01a8f2bb --- /dev/null +++ b/example/bukkit/proto/src/main/java/com/lunarclient/apollo/example/proto/module/inventorybuttons/StaffLayout.java @@ -0,0 +1,398 @@ +/* + * This file is part of Apollo, licensed under the MIT License. + * + * Copyright (c) 2026 Moonsworth + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all + * copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + * SOFTWARE. + */ +package com.lunarclient.apollo.example.proto.module.inventorybuttons; + +import com.lunarclient.apollo.button.v1.Button; +import com.lunarclient.apollo.button.v1.ButtonContent; +import com.lunarclient.apollo.button.v1.ButtonShape; +import com.lunarclient.apollo.button.v1.ButtonSize; +import com.lunarclient.apollo.button.v1.ButtonUpdate; +import com.lunarclient.apollo.common.v1.Icon; +import com.lunarclient.apollo.example.proto.util.ProtobufPacketUtil; +import com.lunarclient.apollo.example.proto.util.ProtobufUtil; +import com.lunarclient.apollo.example.util.ServerStatsUtil; +import com.lunarclient.apollo.hud.v1.HudPosition; +import com.lunarclient.apollo.inventory.v1.DisplayInventoryButtonsMessage; +import com.lunarclient.apollo.inventory.v1.InventoryButton; +import com.lunarclient.apollo.inventory.v1.InventoryButtonBox; +import com.lunarclient.apollo.inventory.v1.UpdateInventoryButtonMessage; +import java.time.LocalTime; +import java.time.format.DateTimeFormatter; +import java.util.List; +import net.kyori.adventure.text.Component; +import net.kyori.adventure.text.format.NamedTextColor; +import net.kyori.adventure.text.format.TextDecoration; +import org.bukkit.Bukkit; +import org.bukkit.entity.Player; + +public final class StaffLayout { + + private static final DateTimeFormatter TIME_FORMAT = DateTimeFormatter.ofPattern("HH:mm:ss"); + + public static void display(Player viewer) { + InventoryButton players = InventoryButton.newBuilder() + .setButton(Button.newBuilder() + .setId("players") + .setPosition(HudPosition.newBuilder().setX(6).setY(8).build()) + .setSize(ButtonSize.newBuilder().setWidth(80).setHeight(26).build()) + .setShape(ButtonShape.BUTTON_SHAPE_ROUNDED_SQUARE) + .setBackgroundColor(ProtobufUtil.createColorProto(InventoryButtonParts.BACKGROUND)) + .setBorderColor(ProtobufUtil.createColorProto(InventoryButtonParts.BORDER)) + .setContent(ButtonContent.newBuilder() + .addParts(InventoryButtonParts.textPart(playersContent())) + .setScale(1.0F) + .build()) + .setTooltip(InventoryButtonParts.tooltipMessage(playersTooltip())) + .build()) + .setBox(InventoryButtonBox.INVENTORY_BUTTON_BOX_LEFT) + .build(); + + InventoryButton tps = InventoryButton.newBuilder() + .setButton(Button.newBuilder() + .setId("tps") + .setPosition(HudPosition.newBuilder().setX(6).setY(40).build()) + .setSize(ButtonSize.newBuilder().setWidth(80).setHeight(26).build()) + .setShape(ButtonShape.BUTTON_SHAPE_ROUNDED_SQUARE) + .setBackgroundColor(ProtobufUtil.createColorProto(InventoryButtonParts.BACKGROUND)) + .setBorderColor(ProtobufUtil.createColorProto(InventoryButtonParts.BORDER)) + .setContent(ButtonContent.newBuilder() + .addParts(InventoryButtonParts.textPart(tpsContent())) + .setScale(1.0F) + .build()) + .setTooltip(InventoryButtonParts.tooltipMessage(tpsTooltip())) + .build()) + .setBox(InventoryButtonBox.INVENTORY_BUTTON_BOX_LEFT) + .build(); + + InventoryButton cpu = InventoryButton.newBuilder() + .setButton(Button.newBuilder() + .setId("cpu") + .setPosition(HudPosition.newBuilder().setX(6).setY(72).build()) + .setSize(ButtonSize.newBuilder().setWidth(80).setHeight(26).build()) + .setShape(ButtonShape.BUTTON_SHAPE_ROUNDED_SQUARE) + .setBackgroundColor(ProtobufUtil.createColorProto(InventoryButtonParts.BACKGROUND)) + .setBorderColor(ProtobufUtil.createColorProto(InventoryButtonParts.BORDER)) + .setContent(ButtonContent.newBuilder() + .addParts(InventoryButtonParts.textPart(cpuContent())) + .setScale(1.0F) + .build()) + .setTooltip(InventoryButtonParts.tooltipMessage(cpuTooltip())) + .build()) + .setBox(InventoryButtonBox.INVENTORY_BUTTON_BOX_LEFT) + .build(); + + InventoryButton ram = InventoryButton.newBuilder() + .setButton(Button.newBuilder() + .setId("ram") + .setPosition(HudPosition.newBuilder().setX(6).setY(104).build()) + .setSize(ButtonSize.newBuilder().setWidth(80).setHeight(26).build()) + .setShape(ButtonShape.BUTTON_SHAPE_ROUNDED_SQUARE) + .setBackgroundColor(ProtobufUtil.createColorProto(InventoryButtonParts.BACKGROUND)) + .setBorderColor(ProtobufUtil.createColorProto(InventoryButtonParts.BORDER)) + .setContent(ButtonContent.newBuilder() + .addParts(InventoryButtonParts.textPart(ramContent())) + .setScale(1.0F) + .build()) + .setTooltip(InventoryButtonParts.tooltipMessage(ramTooltip())) + .build()) + .setBox(InventoryButtonBox.INVENTORY_BUTTON_BOX_LEFT) + .build(); + + InventoryButton survival = InventoryButton.newBuilder() + .setButton(Button.newBuilder() + .setId("survival") + .setPosition(HudPosition.newBuilder().setX(6).setY(8).build()) + .setSize(ButtonSize.newBuilder().setWidth(80).setHeight(26).build()) + .setShape(ButtonShape.BUTTON_SHAPE_ROUNDED_SQUARE) + .setBackgroundColor(ProtobufUtil.createColorProto(InventoryButtonParts.BACKGROUND)) + .setBorderColor(ProtobufUtil.createColorProto(InventoryButtonParts.BORDER)) + .setContent(ButtonContent.newBuilder() + .addParts(InventoryButtonParts.iconPart(Icon.newBuilder() + .setItemStack(ProtobufUtil.createItemStackIconProto("IRON_SWORD", 0)) + .build())) + .addParts(InventoryButtonParts.textPart(Component.text("Survival"))) + .setScale(1.0F) + .build()) + .setTooltip(InventoryButtonParts.tooltipMessage(InventoryButtonParts.tooltipJson( + Component.text("Click to switch!", NamedTextColor.YELLOW)))) + .setRunCommand("/gamemode survival") + .build()) + .setBox(InventoryButtonBox.INVENTORY_BUTTON_BOX_RIGHT) + .build(); + + InventoryButton creative = InventoryButton.newBuilder() + .setButton(Button.newBuilder() + .setId("creative") + .setPosition(HudPosition.newBuilder().setX(6).setY(40).build()) + .setSize(ButtonSize.newBuilder().setWidth(80).setHeight(26).build()) + .setShape(ButtonShape.BUTTON_SHAPE_ROUNDED_SQUARE) + .setBackgroundColor(ProtobufUtil.createColorProto(InventoryButtonParts.BACKGROUND)) + .setBorderColor(ProtobufUtil.createColorProto(InventoryButtonParts.BORDER)) + .setContent(ButtonContent.newBuilder() + .addParts(InventoryButtonParts.iconPart(Icon.newBuilder() + .setItemStack(ProtobufUtil.createItemStackIconProto("GRASS_BLOCK", 0)) + .build())) + .addParts(InventoryButtonParts.textPart(Component.text("Creative"))) + .setScale(1.0F) + .build()) + .setTooltip(InventoryButtonParts.tooltipMessage(InventoryButtonParts.tooltipJson( + Component.text("Click to switch!", NamedTextColor.YELLOW)))) + .setRunCommand("/gamemode creative") + .build()) + .setBox(InventoryButtonBox.INVENTORY_BUTTON_BOX_RIGHT) + .build(); + + InventoryButton adventure = InventoryButton.newBuilder() + .setButton(Button.newBuilder() + .setId("adventure") + .setPosition(HudPosition.newBuilder().setX(6).setY(72).build()) + .setSize(ButtonSize.newBuilder().setWidth(80).setHeight(26).build()) + .setShape(ButtonShape.BUTTON_SHAPE_ROUNDED_SQUARE) + .setBackgroundColor(ProtobufUtil.createColorProto(InventoryButtonParts.BACKGROUND)) + .setBorderColor(ProtobufUtil.createColorProto(InventoryButtonParts.BORDER)) + .setContent(ButtonContent.newBuilder() + .addParts(InventoryButtonParts.iconPart(Icon.newBuilder() + .setItemStack(ProtobufUtil.createItemStackIconProto("FILLED_MAP", 0)) + .build())) + .addParts(InventoryButtonParts.textPart(Component.text("Adventure"))) + .setScale(1.0F) + .build()) + .setTooltip(InventoryButtonParts.tooltipMessage(InventoryButtonParts.tooltipJson( + Component.text("Click to switch!", NamedTextColor.YELLOW)))) + .setRunCommand("/gamemode adventure") + .build()) + .setBox(InventoryButtonBox.INVENTORY_BUTTON_BOX_RIGHT) + .build(); + + InventoryButton spectator = InventoryButton.newBuilder() + .setButton(Button.newBuilder() + .setId("spectator") + .setPosition(HudPosition.newBuilder().setX(6).setY(104).build()) + .setSize(ButtonSize.newBuilder().setWidth(80).setHeight(26).build()) + .setShape(ButtonShape.BUTTON_SHAPE_ROUNDED_SQUARE) + .setBackgroundColor(ProtobufUtil.createColorProto(InventoryButtonParts.BACKGROUND)) + .setBorderColor(ProtobufUtil.createColorProto(InventoryButtonParts.BORDER)) + .setContent(ButtonContent.newBuilder() + .addParts(InventoryButtonParts.iconPart(Icon.newBuilder() + .setItemStack(ProtobufUtil.createItemStackIconProto("ENDER_EYE", 0)) + .build())) + .addParts(InventoryButtonParts.textPart(Component.text("Spectator"))) + .setScale(1.0F) + .build()) + .setTooltip(InventoryButtonParts.tooltipMessage(InventoryButtonParts.tooltipJson( + Component.text("Click to switch!", NamedTextColor.YELLOW)))) + .setRunCommand("/gamemode spectator") + .build()) + .setBox(InventoryButtonBox.INVENTORY_BUTTON_BOX_RIGHT) + .build(); + + DisplayInventoryButtonsMessage message = DisplayInventoryButtonsMessage.newBuilder() + .addInventoryButtons(players) + .addInventoryButtons(tps) + .addInventoryButtons(cpu) + .addInventoryButtons(ram) + .addInventoryButtons(survival) + .addInventoryButtons(creative) + .addInventoryButtons(adventure) + .addInventoryButtons(spectator) + .build(); + + ProtobufPacketUtil.sendPacket(viewer, message); + } + + public static void sendUpdates(Player viewer) { + ProtobufPacketUtil.sendPacket(viewer, UpdateInventoryButtonMessage.newBuilder() + .setId("players") + .setUpdate(ButtonUpdate.newBuilder() + .setContent(ButtonContent.newBuilder() + .addParts(InventoryButtonParts.textPart(playersContent())) + .setScale(1.0F) + .build()) + .setTooltip(InventoryButtonParts.tooltipMessage(playersTooltip())) + .build()) + .build()); + + ProtobufPacketUtil.sendPacket(viewer, UpdateInventoryButtonMessage.newBuilder() + .setId("tps") + .setUpdate(ButtonUpdate.newBuilder() + .setContent(ButtonContent.newBuilder() + .addParts(InventoryButtonParts.textPart(tpsContent())) + .setScale(1.0F) + .build()) + .setTooltip(InventoryButtonParts.tooltipMessage(tpsTooltip())) + .build()) + .build()); + + ProtobufPacketUtil.sendPacket(viewer, UpdateInventoryButtonMessage.newBuilder() + .setId("cpu") + .setUpdate(ButtonUpdate.newBuilder() + .setContent(ButtonContent.newBuilder() + .addParts(InventoryButtonParts.textPart(cpuContent())) + .setScale(1.0F) + .build()) + .setTooltip(InventoryButtonParts.tooltipMessage(cpuTooltip())) + .build()) + .build()); + + ProtobufPacketUtil.sendPacket(viewer, UpdateInventoryButtonMessage.newBuilder() + .setId("ram") + .setUpdate(ButtonUpdate.newBuilder() + .setContent(ButtonContent.newBuilder() + .addParts(InventoryButtonParts.textPart(ramContent())) + .setScale(1.0F) + .build()) + .setTooltip(InventoryButtonParts.tooltipMessage(ramTooltip())) + .build()) + .build()); + } + + private static Component playersContent() { + return Component.text("Players: ", NamedTextColor.GRAY) + .append(Component.text(Bukkit.getOnlinePlayers().size(), NamedTextColor.GREEN)); + } + + private static List playersTooltip() { + return InventoryButtonParts.tooltipJson( + Component.text("Players currently online", NamedTextColor.GRAY), + Component.empty(), + refreshedLine()); + } + + private static Component tpsContent() { + double[] tps = ServerStatsUtil.getTps(); + if (tps == null || tps.length == 0) { + return Component.text("TPS: N/A", NamedTextColor.GRAY); + } + + double recent = Math.min(20.0D, tps[0]); + return Component.text("TPS: ", NamedTextColor.GRAY) + .append(Component.text(String.format("%.1f", recent), tpsColor(recent))); + } + + private static List tpsTooltip() { + double[] tps = ServerStatsUtil.getTps(); + if (tps == null || tps.length < 3) { + return InventoryButtonParts.tooltipJson( + Component.text("TPS averages require a Paper based server", NamedTextColor.GRAY), + Component.empty(), + refreshedLine()); + } + + return InventoryButtonParts.tooltipJson( + tpsAverageLine("1m", tps[0]), + tpsAverageLine("5m", tps[1]), + tpsAverageLine("15m", tps[2]), + Component.empty(), + refreshedLine()); + } + + private static Component tpsAverageLine(String window, double average) { + double tps = Math.min(20.0D, average); + return Component.text(window + ": ", NamedTextColor.GRAY) + .append(Component.text(String.format("%.2f", tps), tpsColor(tps))); + } + + private static NamedTextColor tpsColor(double tps) { + if (tps >= 18.0D) { + return NamedTextColor.GREEN; + } + + return tps >= 15.0D ? NamedTextColor.YELLOW : NamedTextColor.RED; + } + + private static Component cpuContent() { + double load = ServerStatsUtil.getSystemLoadAverage(); + if (load < 0.0D) { + return Component.text("CPU: N/A", NamedTextColor.GRAY); + } + + return Component.text("CPU: ", NamedTextColor.GRAY) + .append(Component.text(String.format("%.2f", load), cpuColor(load))); + } + + private static List cpuTooltip() { + double load = ServerStatsUtil.getSystemLoadAverage(); + if (load < 0.0D) { + return InventoryButtonParts.tooltipJson( + Component.text("The system load average is unavailable", NamedTextColor.GRAY), + Component.empty(), + refreshedLine()); + } + + int cores = ServerStatsUtil.getAvailableProcessors(); + double perCore = load * 100.0D / cores; + return InventoryButtonParts.tooltipJson( + Component.text("System load average (last minute)", NamedTextColor.GRAY), + Component.text("Cores: ", NamedTextColor.GRAY) + .append(Component.text(cores, NamedTextColor.WHITE)), + Component.text("Per core: ", NamedTextColor.GRAY) + .append(Component.text(String.format("%.0f%%", perCore), cpuColor(load))), + Component.empty(), + refreshedLine()); + } + + private static NamedTextColor cpuColor(double load) { + double perCore = load / ServerStatsUtil.getAvailableProcessors(); + if (perCore < 0.5D) { + return NamedTextColor.GREEN; + } + + return perCore < 1.0D ? NamedTextColor.YELLOW : NamedTextColor.RED; + } + + private static Component ramContent() { + long used = ServerStatsUtil.getUsedRamMb(); + long max = ServerStatsUtil.getMaxRamMb(); + long percent = max <= 0 ? 0 : used * 100 / max; + + return Component.text("RAM: ", NamedTextColor.GRAY) + .append(Component.text(percent + "%", ramColor(percent))); + } + + private static List ramTooltip() { + return InventoryButtonParts.tooltipJson( + Component.text("Used: ", NamedTextColor.GRAY) + .append(Component.text(ServerStatsUtil.getUsedRamMb() + " MB", NamedTextColor.WHITE)), + Component.text("Max: ", NamedTextColor.GRAY) + .append(Component.text(ServerStatsUtil.getMaxRamMb() + " MB", NamedTextColor.WHITE)), + Component.empty(), + refreshedLine()); + } + + private static NamedTextColor ramColor(long percent) { + if (percent < 60) { + return NamedTextColor.GREEN; + } + + return percent < 85 ? NamedTextColor.YELLOW : NamedTextColor.RED; + } + + private static Component refreshedLine() { + return Component.text("Updated at " + LocalTime.now().format(TIME_FORMAT), NamedTextColor.YELLOW, TextDecoration.ITALIC); + } + + private StaffLayout() { + } + +} diff --git a/example/bukkit/proto/src/main/java/com/lunarclient/apollo/example/proto/util/ProtobufPacketUtil.java b/example/bukkit/proto/src/main/java/com/lunarclient/apollo/example/proto/util/ProtobufPacketUtil.java index f8a0e17c..b5171f58 100644 --- a/example/bukkit/proto/src/main/java/com/lunarclient/apollo/example/proto/util/ProtobufPacketUtil.java +++ b/example/bukkit/proto/src/main/java/com/lunarclient/apollo/example/proto/util/ProtobufPacketUtil.java @@ -59,6 +59,8 @@ public final class ProtobufPacketUtil { CONFIG_MODULE_PROPERTIES.put("packet_enrichment", "player-attack.send-packet", Value.newBuilder().setBoolValue(false).build()); CONFIG_MODULE_PROPERTIES.put("packet_enrichment", "player-chat-open.send-packet", Value.newBuilder().setBoolValue(false).build()); CONFIG_MODULE_PROPERTIES.put("packet_enrichment", "player-chat-close.send-packet", Value.newBuilder().setBoolValue(false).build()); + CONFIG_MODULE_PROPERTIES.put("packet_enrichment", "player-inventory-open.send-packet", Value.newBuilder().setBoolValue(false).build()); + CONFIG_MODULE_PROPERTIES.put("packet_enrichment", "player-inventory-close.send-packet", Value.newBuilder().setBoolValue(false).build()); CONFIG_MODULE_PROPERTIES.put("packet_enrichment", "player-use-item.send-packet", Value.newBuilder().setBoolValue(false).build()); CONFIG_MODULE_PROPERTIES.put("packet_enrichment", "player-use-item-bucket.send-packet", Value.newBuilder().setBoolValue(false).build()); CONFIG_MODULE_PROPERTIES.put("server_link", "legacy-button-placement", Value.newBuilder().setStringValue("NEW_ROW").build()); diff --git a/example/bukkit/proto/src/main/resources/plugin.yml b/example/bukkit/proto/src/main/resources/plugin.yml index f74f917e..da8661d0 100644 --- a/example/bukkit/proto/src/main/resources/plugin.yml +++ b/example/bukkit/proto/src/main/resources/plugin.yml @@ -1,6 +1,6 @@ name: Apollo-Proto-Example main: com.lunarclient.apollo.example.proto.ApolloProtoExamplePlatform -version: 1.2.8 +version: 1.2.9 author: Moonsworth softdepend: [ Apollo-Bukkit ] api-version: 1.13 @@ -32,6 +32,8 @@ commands: description: "Glint!" glow: description: "Glow!" + heightlimit: + description: "Height Limit!" hologram: description: "Holograms!" inventory: @@ -52,6 +54,8 @@ commands: description: "Pay Now!" richpresence: description: "Rich Presence!" + serverlink: + description: "Server Links!" saturation: description: "Saturation!" serverrule: diff --git a/extra/adventure4/src/main/java/com/lunarclient/apollo/common/ApolloComponent.java b/extra/adventure4/src/main/java/com/lunarclient/apollo/common/ApolloComponent.java index 93c11e7a..04176482 100644 --- a/extra/adventure4/src/main/java/com/lunarclient/apollo/common/ApolloComponent.java +++ b/extra/adventure4/src/main/java/com/lunarclient/apollo/common/ApolloComponent.java @@ -68,6 +68,30 @@ public static String toLegacy(@NonNull Component component) { return LegacyComponentSerializer.legacySection().serialize(component); } + /** + * Returns a new component from the provided legacy {@link String}, + * using {@code &} color codes. + * + * @param legacy the legacy string for this component + * @return the component from the legacy string + * @since 1.2.9 + */ + public static Component fromLegacyAmpersand(@NonNull String legacy) { + return LegacyComponentSerializer.legacyAmpersand().deserialize(legacy); + } + + /** + * Returns this component as a legacy {@link String}, + * using {@code &} color codes. + * + * @param component the component to make into a legacy string + * @return the legacy string for this component + * @since 1.2.9 + */ + public static String toLegacyAmpersand(@NonNull Component component) { + return LegacyComponentSerializer.legacyAmpersand().serialize(component); + } + private ApolloComponent() { } diff --git a/gradle.properties b/gradle.properties index 1cecc874..5909961d 100644 --- a/gradle.properties +++ b/gradle.properties @@ -1,5 +1,5 @@ group=com.lunarclient -version=1.2.8 +version=1.2.9 description=The API for interacting with Lunar Client players. org.gradle.parallel=true diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml index d83b4d64..5099e64b 100644 --- a/gradle/libs.versions.toml +++ b/gradle/libs.versions.toml @@ -11,7 +11,7 @@ geantyref = "1.3.11" idea = "1.1.7" jetbrains = "24.0.1" lombok = "1.18.38" -protobuf = "0.2.0" +protobuf = "0.2.4" gson = "2.10.1" shadow = "9.4.1" spotless = "8.4.0" diff --git a/platform/bukkit/src/main/java/com/lunarclient/apollo/ApolloBukkitPlatform.java b/platform/bukkit/src/main/java/com/lunarclient/apollo/ApolloBukkitPlatform.java index 6de2e988..dd49d311 100644 --- a/platform/bukkit/src/main/java/com/lunarclient/apollo/ApolloBukkitPlatform.java +++ b/platform/bukkit/src/main/java/com/lunarclient/apollo/ApolloBukkitPlatform.java @@ -50,9 +50,12 @@ import com.lunarclient.apollo.module.glint.GlintModule; import com.lunarclient.apollo.module.glow.GlowModule; import com.lunarclient.apollo.module.glow.GlowModuleImpl; +import com.lunarclient.apollo.module.heightlimit.HeightLimitModule; +import com.lunarclient.apollo.module.heightlimit.HeightLimitModuleImpl; import com.lunarclient.apollo.module.hologram.HologramModule; import com.lunarclient.apollo.module.hologram.HologramModuleImpl; import com.lunarclient.apollo.module.inventory.InventoryModule; +import com.lunarclient.apollo.module.inventory.InventoryModuleImpl; import com.lunarclient.apollo.module.limb.LimbModule; import com.lunarclient.apollo.module.limb.LimbModuleImpl; import com.lunarclient.apollo.module.marker.MarkerModule; @@ -98,6 +101,7 @@ import com.lunarclient.apollo.stats.ApolloStats; import com.lunarclient.apollo.wrapper.BukkitApolloStats; import java.util.ArrayList; +import java.util.concurrent.TimeUnit; import java.util.logging.Level; import java.util.logging.Logger; import lombok.Getter; @@ -149,8 +153,9 @@ public void onEnable() { .addModule(EntityModule.class, new EntityModuleImpl()) .addModule(GlintModule.class) .addModule(GlowModule.class, new GlowModuleImpl()) + .addModule(HeightLimitModule.class, new HeightLimitModuleImpl()) .addModule(HologramModule.class, new HologramModuleImpl()) - .addModule(InventoryModule.class) + .addModule(InventoryModule.class, new InventoryModuleImpl()) .addModule(LimbModule.class, new LimbModuleImpl()) .addModule(MarkerModule.class, new MarkerModuleImpl()) .addModule(ModSettingModule.class, new ModSettingModuleImpl()) @@ -224,6 +229,19 @@ public ApolloStats getStats() { return this.stats; } + private final Scheduler scheduler = new Scheduler() { + @Override + public void scheduleAsyncRepeating(Runnable task, long delay, long period, TimeUnit unit) { + Bukkit.getScheduler().runTaskTimerAsynchronously(ApolloBukkitPlatform.this.plugin, task, + Math.max(1L, unit.toMillis(delay) / 50L), Math.max(1L, unit.toMillis(period) / 50L)); + } + }; + + @Override + public Scheduler getScheduler() { + return this.scheduler; + } + @Override public Logger getPlatformLogger() { return Bukkit.getServer().getLogger(); diff --git a/platform/bukkit/src/platform-loader/resources/plugin.yml b/platform/bukkit/src/platform-loader/resources/plugin.yml index 6be0fb25..914e6589 100644 --- a/platform/bukkit/src/platform-loader/resources/plugin.yml +++ b/platform/bukkit/src/platform-loader/resources/plugin.yml @@ -1,6 +1,6 @@ name: Apollo-Bukkit main: com.lunarclient.apollo.loader.BukkitPlatformLoader -version: 1.2.8 +version: 1.2.9 author: Moonsworth api-version: 1.13 soft-depend: [LunarClient-API] diff --git a/platform/bungee/src/main/java/com/lunarclient/apollo/ApolloBungeePlatform.java b/platform/bungee/src/main/java/com/lunarclient/apollo/ApolloBungeePlatform.java index a5f50d27..2c35eb66 100644 --- a/platform/bungee/src/main/java/com/lunarclient/apollo/ApolloBungeePlatform.java +++ b/platform/bungee/src/main/java/com/lunarclient/apollo/ApolloBungeePlatform.java @@ -46,8 +46,12 @@ import com.lunarclient.apollo.module.cosmetic.CosmeticModuleImpl; import com.lunarclient.apollo.module.entity.EntityModule; import com.lunarclient.apollo.module.entity.EntityModuleImpl; +import com.lunarclient.apollo.module.heightlimit.HeightLimitModule; +import com.lunarclient.apollo.module.heightlimit.HeightLimitModuleImpl; import com.lunarclient.apollo.module.hologram.HologramModule; import com.lunarclient.apollo.module.hologram.HologramModuleImpl; +import com.lunarclient.apollo.module.inventory.InventoryModule; +import com.lunarclient.apollo.module.inventory.InventoryModuleImpl; import com.lunarclient.apollo.module.limb.LimbModule; import com.lunarclient.apollo.module.limb.LimbModuleImpl; import com.lunarclient.apollo.module.marker.MarkerModule; @@ -86,6 +90,7 @@ import com.lunarclient.apollo.stats.ApolloStats; import com.lunarclient.apollo.wrapper.BungeeApolloStats; import java.util.ArrayList; +import java.util.concurrent.TimeUnit; import java.util.logging.Level; import java.util.logging.Logger; import lombok.Getter; @@ -131,7 +136,9 @@ public void onEnable() { .addModule(CombatModule.class) .addModule(CooldownModule.class, new CooldownModuleImpl()) .addModule(EntityModule.class, new EntityModuleImpl()) + .addModule(HeightLimitModule.class, new HeightLimitModuleImpl()) .addModule(HologramModule.class, new HologramModuleImpl()) + .addModule(InventoryModule.class, new InventoryModuleImpl()) .addModule(LimbModule.class, new LimbModuleImpl()) .addModule(MarkerModule.class, new MarkerModuleImpl()) .addModule(ModSettingModule.class, new ModSettingModuleImpl()) @@ -202,4 +209,17 @@ public ApolloStats getStats() { return this.stats; } + private final Scheduler scheduler = new Scheduler() { + @Override + public void scheduleAsyncRepeating(Runnable task, long delay, long period, TimeUnit unit) { + ApolloBungeePlatform.this.plugin.getProxy().getScheduler() + .schedule(ApolloBungeePlatform.this.plugin, task, delay, period, unit); + } + }; + + @Override + public Scheduler getScheduler() { + return this.scheduler; + } + } diff --git a/platform/bungee/src/platform-loader/resources/plugin.yml b/platform/bungee/src/platform-loader/resources/plugin.yml index 2baf5bca..633e3deb 100644 --- a/platform/bungee/src/platform-loader/resources/plugin.yml +++ b/platform/bungee/src/platform-loader/resources/plugin.yml @@ -1,4 +1,4 @@ name: Apollo-Bungee main: com.lunarclient.apollo.loader.BungeePlatformLoader -version: 1.2.8 +version: 1.2.9 author: Moonsworth diff --git a/platform/folia/src/main/java/com/lunarclient/apollo/ApolloFoliaPlatform.java b/platform/folia/src/main/java/com/lunarclient/apollo/ApolloFoliaPlatform.java index 19a4878b..1bf3caea 100644 --- a/platform/folia/src/main/java/com/lunarclient/apollo/ApolloFoliaPlatform.java +++ b/platform/folia/src/main/java/com/lunarclient/apollo/ApolloFoliaPlatform.java @@ -48,8 +48,12 @@ import com.lunarclient.apollo.module.entity.EntityModuleImpl; import com.lunarclient.apollo.module.glow.GlowModule; import com.lunarclient.apollo.module.glow.GlowModuleImpl; +import com.lunarclient.apollo.module.heightlimit.HeightLimitModule; +import com.lunarclient.apollo.module.heightlimit.HeightLimitModuleImpl; import com.lunarclient.apollo.module.hologram.HologramModule; import com.lunarclient.apollo.module.hologram.HologramModuleImpl; +import com.lunarclient.apollo.module.inventory.InventoryModule; +import com.lunarclient.apollo.module.inventory.InventoryModuleImpl; import com.lunarclient.apollo.module.limb.LimbModule; import com.lunarclient.apollo.module.limb.LimbModuleImpl; import com.lunarclient.apollo.module.marker.MarkerModule; @@ -94,6 +98,7 @@ import com.lunarclient.apollo.stats.ApolloStats; import com.lunarclient.apollo.wrapper.FoliaApolloStats; import java.util.ArrayList; +import java.util.concurrent.TimeUnit; import java.util.logging.Level; import java.util.logging.Logger; import lombok.Getter; @@ -138,7 +143,9 @@ public void onEnable() { .addModule(CooldownModule.class, new CooldownModuleImpl()) .addModule(EntityModule.class, new EntityModuleImpl()) .addModule(GlowModule.class, new GlowModuleImpl()) + .addModule(HeightLimitModule.class, new HeightLimitModuleImpl()) .addModule(HologramModule.class, new HologramModuleImpl()) + .addModule(InventoryModule.class, new InventoryModuleImpl()) .addModule(LimbModule.class, new LimbModuleImpl()) .addModule(MarkerModule.class, new MarkerModuleImpl()) .addModule(ModSettingModule.class, new ModSettingModuleImpl()) @@ -207,6 +214,19 @@ public ApolloStats getStats() { return this.stats; } + private final Scheduler scheduler = new Scheduler() { + @Override + public void scheduleAsyncRepeating(Runnable task, long delay, long period, TimeUnit unit) { + Bukkit.getAsyncScheduler().runAtFixedRate(ApolloFoliaPlatform.this, + scheduledTask -> task.run(), delay, period, unit); + } + }; + + @Override + public Scheduler getScheduler() { + return this.scheduler; + } + @Override public Object getPlugin() { return getInstance(); diff --git a/platform/folia/src/main/resources/plugin.yml b/platform/folia/src/main/resources/plugin.yml index 25c7425f..3e38f5df 100644 --- a/platform/folia/src/main/resources/plugin.yml +++ b/platform/folia/src/main/resources/plugin.yml @@ -1,6 +1,6 @@ name: Apollo-Folia main: com.lunarclient.apollo.ApolloFoliaPlatform -version: 1.2.8 +version: 1.2.9 author: Moonsworth api-version: 1.13 folia-supported: true diff --git a/platform/minestom/src/main/java/com/lunarclient/apollo/ApolloMinestomPlatform.java b/platform/minestom/src/main/java/com/lunarclient/apollo/ApolloMinestomPlatform.java index 8c2e26ab..60ac7559 100644 --- a/platform/minestom/src/main/java/com/lunarclient/apollo/ApolloMinestomPlatform.java +++ b/platform/minestom/src/main/java/com/lunarclient/apollo/ApolloMinestomPlatform.java @@ -49,9 +49,12 @@ import com.lunarclient.apollo.module.glint.GlintModule; import com.lunarclient.apollo.module.glow.GlowModule; import com.lunarclient.apollo.module.glow.GlowModuleImpl; +import com.lunarclient.apollo.module.heightlimit.HeightLimitModule; +import com.lunarclient.apollo.module.heightlimit.HeightLimitModuleImpl; import com.lunarclient.apollo.module.hologram.HologramModule; import com.lunarclient.apollo.module.hologram.HologramModuleImpl; import com.lunarclient.apollo.module.inventory.InventoryModule; +import com.lunarclient.apollo.module.inventory.InventoryModuleImpl; import com.lunarclient.apollo.module.limb.LimbModule; import com.lunarclient.apollo.module.limb.LimbModuleImpl; import com.lunarclient.apollo.module.marker.MarkerModule; @@ -96,9 +99,12 @@ import com.lunarclient.apollo.option.OptionsImpl; import com.lunarclient.apollo.stats.ApolloStats; import com.lunarclient.apollo.wrapper.MinestomApolloStats; +import java.time.Duration; import java.util.ArrayList; import java.util.HashSet; import java.util.Set; +import java.util.concurrent.ForkJoinPool; +import java.util.concurrent.TimeUnit; import java.util.logging.Level; import java.util.logging.Logger; import lombok.Getter; @@ -171,8 +177,9 @@ public static void init(ApolloMinestomProperties properties) { .addModule(EntityModule.class, new EntityModuleImpl()) .addModule(GlintModule.class) .addModule(GlowModule.class, new GlowModuleImpl()) + .addModule(HeightLimitModule.class, new HeightLimitModuleImpl()) .addModule(HologramModule.class, new HologramModuleImpl()) - .addModule(InventoryModule.class) + .addModule(InventoryModule.class, new InventoryModuleImpl()) .addModule(LimbModule.class, new LimbModuleImpl()) .addModule(MarkerModule.class, new MarkerModuleImpl()) .addModule(ModSettingModule.class, new ModSettingModuleImpl()) @@ -246,7 +253,7 @@ public Options getOptions() { @Override public String getApolloVersion() { - return "1.2.8"; + return "1.2.9"; } @Override @@ -254,6 +261,22 @@ public ApolloStats getStats() { return this.stats; } + private final Scheduler scheduler = new Scheduler() { + @Override + public void scheduleAsyncRepeating(Runnable task, long delay, long period, TimeUnit unit) { + MinecraftServer.getSchedulerManager() + .buildTask(() -> ForkJoinPool.commonPool().execute(task)) + .delay(Duration.ofMillis(unit.toMillis(delay))) + .repeat(Duration.ofMillis(unit.toMillis(period))) + .schedule(); + } + }; + + @Override + public Scheduler getScheduler() { + return this.scheduler; + } + @Override public Logger getPlatformLogger() { return this.logger; diff --git a/platform/velocity/src/main/java/com/lunarclient/apollo/ApolloVelocityPlatform.java b/platform/velocity/src/main/java/com/lunarclient/apollo/ApolloVelocityPlatform.java index 8d3ed35f..cacb9393 100644 --- a/platform/velocity/src/main/java/com/lunarclient/apollo/ApolloVelocityPlatform.java +++ b/platform/velocity/src/main/java/com/lunarclient/apollo/ApolloVelocityPlatform.java @@ -46,8 +46,12 @@ import com.lunarclient.apollo.module.cosmetic.CosmeticModuleImpl; import com.lunarclient.apollo.module.entity.EntityModule; import com.lunarclient.apollo.module.entity.EntityModuleImpl; +import com.lunarclient.apollo.module.heightlimit.HeightLimitModule; +import com.lunarclient.apollo.module.heightlimit.HeightLimitModuleImpl; import com.lunarclient.apollo.module.hologram.HologramModule; import com.lunarclient.apollo.module.hologram.HologramModuleImpl; +import com.lunarclient.apollo.module.inventory.InventoryModule; +import com.lunarclient.apollo.module.inventory.InventoryModuleImpl; import com.lunarclient.apollo.module.limb.LimbModule; import com.lunarclient.apollo.module.limb.LimbModuleImpl; import com.lunarclient.apollo.module.marker.MarkerModule; @@ -100,6 +104,7 @@ import com.velocitypowered.api.proxy.messages.MinecraftChannelIdentifier; import java.nio.file.Path; import java.util.ArrayList; +import java.util.concurrent.TimeUnit; import java.util.logging.Level; import java.util.logging.Logger; import lombok.Getter; @@ -112,7 +117,7 @@ @Plugin( id = "apollo", name = "Apollo-Velocity", - version = "1.2.8", + version = "1.2.9", url = "https://moonsworth.com", description = "Implementation of Apollo for Velocity", authors = {"Moonsworth"} @@ -169,6 +174,22 @@ public ApolloStats getStats() { return this.stats; } + private final Scheduler scheduler = new Scheduler() { + @Override + public void scheduleAsyncRepeating(Runnable task, long delay, long period, TimeUnit unit) { + ApolloVelocityPlatform.this.server.getScheduler() + .buildTask(ApolloVelocityPlatform.this, task) + .delay(delay, unit) + .repeat(period, unit) + .schedule(); + } + }; + + @Override + public Scheduler getScheduler() { + return this.scheduler; + } + @Override public Object getPlugin() { return getInstance(); @@ -198,7 +219,9 @@ public void onProxyInitialization(ProxyInitializeEvent event) { .addModule(CombatModule.class) .addModule(CooldownModule.class, new CooldownModuleImpl()) .addModule(EntityModule.class, new EntityModuleImpl()) + .addModule(HeightLimitModule.class, new HeightLimitModuleImpl()) .addModule(HologramModule.class, new HologramModuleImpl()) + .addModule(InventoryModule.class, new InventoryModuleImpl()) .addModule(LimbModule.class, new LimbModuleImpl()) .addModule(MarkerModule.class, new MarkerModuleImpl()) .addModule(ModSettingModule.class, new ModSettingModuleImpl())