Skip to content

Commit

Permalink
Minor changes
Browse files Browse the repository at this point in the history
  • Loading branch information
ItsNature committed Sep 19, 2024
1 parent c957e50 commit afed09a
Show file tree
Hide file tree
Showing 12 changed files with 11 additions and 20 deletions.
1 change: 0 additions & 1 deletion docs/_meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,5 @@
"server-owners": "Server Owners",
"license": "License",
"acceptable-use": "Acceptable Use",
"lightweight": "Lightweight",
"internals": "Internals"
}
3 changes: 2 additions & 1 deletion docs/developers/_meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,6 @@
"mods": "Mods",
"utilities": "Utilities",
"platform-utilities": "Platform Utilities",
"adventure": "Adventure"
"adventure": "Adventure",
"lightweight": "Lightweight"
}
3 changes: 3 additions & 0 deletions docs/developers/lightweight/_meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"protobuf": "Protobuf"
}
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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)<br/>
🔗 [Detecting players using LunarClient](apollo/developers/lightweight/protobuf/player-detection)<br/>
🔗 [Common Apollo Objects](apollo/developers/lightweight/protobuf/object-util)<br/>
🔗 [Adventure Util](apollo/developers/lightweight/protobuf/adventure-util)<br/>
🔗 [Apollo Serverbound packets](apollo/developers/lightweight/protobuf/serverbound-packets)<br/>
🔗 [Apollo Roundtrip packets](apollo/developers/lightweight/protobuf/roundtrip-packets)<br/>

TODO mention module examples
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

1 comment on commit afed09a

@LunarClientBot
Copy link
Collaborator

@LunarClientBot LunarClientBot commented on afed09a Sep 19, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📄 Documentation Deployment

Status:✅ Completed
Environment:preview
URL:https://7fe8851d.lunarclient-dev.pages.dev

Please sign in to comment.