diff --git a/docs/_meta.json b/docs/_meta.json index fa9761eb..951b575d 100644 --- a/docs/_meta.json +++ b/docs/_meta.json @@ -5,6 +5,5 @@ "server-owners": "Server Owners", "license": "License", "acceptable-use": "Acceptable Use", - "lightweight": "Lightweight", "internals": "Internals" } diff --git a/docs/developers/_meta.json b/docs/developers/_meta.json index f5f6cd1c..9a1ca48a 100644 --- a/docs/developers/_meta.json +++ b/docs/developers/_meta.json @@ -7,5 +7,6 @@ "mods": "Mods", "utilities": "Utilities", "platform-utilities": "Platform Utilities", - "adventure": "Adventure" + "adventure": "Adventure", + "lightweight": "Lightweight" } diff --git a/docs/developers/lightweight/_meta.json b/docs/developers/lightweight/_meta.json new file mode 100644 index 00000000..a2ac9a84 --- /dev/null +++ b/docs/developers/lightweight/_meta.json @@ -0,0 +1,3 @@ +{ + "protobuf": "Protobuf" +} diff --git a/docs/lightweight/introduction.mdx b/docs/developers/lightweight/introduction.mdx similarity index 100% rename from docs/lightweight/introduction.mdx rename to docs/developers/lightweight/introduction.mdx diff --git a/docs/lightweight/protobuf/_meta.json b/docs/developers/lightweight/protobuf/_meta.json similarity index 100% rename from docs/lightweight/protobuf/_meta.json rename to docs/developers/lightweight/protobuf/_meta.json diff --git a/docs/lightweight/protobuf/adventure-util.mdx b/docs/developers/lightweight/protobuf/adventure-util.mdx similarity index 81% rename from docs/lightweight/protobuf/adventure-util.mdx rename to docs/developers/lightweight/protobuf/adventure-util.mdx index fc62ec93..2490a34b 100644 --- a/docs/lightweight/protobuf/adventure-util.mdx +++ b/docs/developers/lightweight/protobuf/adventure-util.mdx @@ -4,8 +4,6 @@ Provides a single method responsible for serializing the Adventure Component to a String -TODO: provide a direct link to the source code for this class? - ## Integration ```java diff --git a/docs/lightweight/protobuf/getting-started.mdx b/docs/developers/lightweight/protobuf/getting-started.mdx similarity index 92% rename from docs/lightweight/protobuf/getting-started.mdx rename to docs/developers/lightweight/protobuf/getting-started.mdx index 95a99c3d..4de87e2e 100644 --- a/docs/lightweight/protobuf/getting-started.mdx +++ b/docs/developers/lightweight/protobuf/getting-started.mdx @@ -63,11 +63,11 @@ Available fields for each message, including their types, are available on the B ## Integration Examples -🔗 [Sending Apollo packets & Enabling Apollo modules](apollo/developers/lightweight/protobuf/packet-util) -🔗 [Detecting players using LunarClient](apollo/developers/lightweight/protobuf/player-detection) -🔗 [Common Apollo Objects](apollo/developers/lightweight/protobuf/object-util) -🔗 [Adventure Util](apollo/developers/lightweight/protobuf/adventure-util) -🔗 [Apollo Serverbound packets](apollo/developers/lightweight/protobuf/serverbound-packets) -🔗 [Apollo Roundtrip packets](apollo/developers/lightweight/protobuf/roundtrip-packets) +🔗 [Sending Apollo packets & Enabling Apollo modules](apollo/developers/lightweight/protobuf/packet-util)
+🔗 [Detecting players using LunarClient](apollo/developers/lightweight/protobuf/player-detection)
+🔗 [Common Apollo Objects](apollo/developers/lightweight/protobuf/object-util)
+🔗 [Adventure Util](apollo/developers/lightweight/protobuf/adventure-util)
+🔗 [Apollo Serverbound packets](apollo/developers/lightweight/protobuf/serverbound-packets)
+🔗 [Apollo Roundtrip packets](apollo/developers/lightweight/protobuf/roundtrip-packets)
TODO mention module examples diff --git a/docs/lightweight/protobuf/object-util.mdx b/docs/developers/lightweight/protobuf/object-util.mdx similarity index 98% rename from docs/lightweight/protobuf/object-util.mdx rename to docs/developers/lightweight/protobuf/object-util.mdx index 5bd8a1c7..51fb3278 100644 --- a/docs/lightweight/protobuf/object-util.mdx +++ b/docs/developers/lightweight/protobuf/object-util.mdx @@ -4,8 +4,6 @@ These utilities facilitate the creation of Apollo objects, commonly used across various Apollo Modules. The utility methods are used for converting objects to and from their corresponding Protocol Buffers representations. -TODO: provide a direct link to the source code for this class? - ## Integration ```java diff --git a/docs/lightweight/protobuf/packet-util.mdx b/docs/developers/lightweight/protobuf/packet-util.mdx similarity index 98% rename from docs/lightweight/protobuf/packet-util.mdx rename to docs/developers/lightweight/protobuf/packet-util.mdx index 897e37ad..fcac5c9b 100644 --- a/docs/lightweight/protobuf/packet-util.mdx +++ b/docs/developers/lightweight/protobuf/packet-util.mdx @@ -8,8 +8,6 @@ These utilities are designed to handle packet transmission and creation for inte The methods in this utility leverage the same plugin messaging channel as the Apollo API `lunar:apollo`. -TODO: provide a direct link to the source code for this class? - ## Integration To utilize Apollo Modules, first define a list of the modules you want to use: diff --git a/docs/lightweight/protobuf/player-detection.mdx b/docs/developers/lightweight/protobuf/player-detection.mdx similarity index 95% rename from docs/lightweight/protobuf/player-detection.mdx rename to docs/developers/lightweight/protobuf/player-detection.mdx index 0c766b43..19263c12 100644 --- a/docs/lightweight/protobuf/player-detection.mdx +++ b/docs/developers/lightweight/protobuf/player-detection.mdx @@ -4,8 +4,6 @@ This example demonstrates how to detect whether a player is using Lunar Client by listening for the `PlayerRegisterChannelEvent` on the `lunar:apollo` channel. Additionally, it showcases how to enable Apollo Modules using utility methods from [ProtobufPacketUtil](/apollo/developers/lightweight/protobuf/packet-util) -TODO: provide a direct link to the source code for this class? - ## Integration ```java diff --git a/docs/lightweight/protobuf/roundtrip-packets.mdx b/docs/developers/lightweight/protobuf/roundtrip-packets.mdx similarity index 98% rename from docs/lightweight/protobuf/roundtrip-packets.mdx rename to docs/developers/lightweight/protobuf/roundtrip-packets.mdx index 26ccb542..e67c360a 100644 --- a/docs/lightweight/protobuf/roundtrip-packets.mdx +++ b/docs/developers/lightweight/protobuf/roundtrip-packets.mdx @@ -4,8 +4,6 @@ This example demonstrates how to handle roundtrip packets between the server and the Lunar Client. These packets are sent from the server, expecting a corresponding response from the client. The example utilizes a map to track the requests and their corresponding responses. For instance, this pattern is common in modules like `TransferModule` where a request packet is sent and a response is awaited. -TODO: provide a direct link to the source code for this class? - ## Integration ```java diff --git a/docs/lightweight/protobuf/serverbound-packets.mdx b/docs/developers/lightweight/protobuf/serverbound-packets.mdx similarity index 98% rename from docs/lightweight/protobuf/serverbound-packets.mdx rename to docs/developers/lightweight/protobuf/serverbound-packets.mdx index 17bf529a..b5e58be5 100644 --- a/docs/lightweight/protobuf/serverbound-packets.mdx +++ b/docs/developers/lightweight/protobuf/serverbound-packets.mdx @@ -6,8 +6,6 @@ Players using Lunar Client may send packets to the server for specific Apollo mo Additionally, the `Transfer Module` expects a response packet from the client after the server sends a request. For an example of how to handle roundtrip packets, visit [Packet Roundtrip Example](apollo/developers/lightweight/protobuf/roundtrip-packets) -TODO: provide a direct link to the source code for this class? - ## Integration ```java