Skip to content

Commit

Permalink
Link usage methods, add module examples note
Browse files Browse the repository at this point in the history
  • Loading branch information
ItsNature committed Oct 1, 2024
1 parent 17db1a2 commit 6ab20b8
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 6 deletions.
3 changes: 2 additions & 1 deletion docs/developers/lightweight/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,5 @@ The message format used to communicate, follows a loosely structured JSON schema

### Usage Methods

TODO
🔗 [Protobuf](/apollo/developers/lightweight/protobuf/getting-started)<br/>
🔗 [JSON](/apollo/developers/lightweight/json/getting-started)<br/>
4 changes: 2 additions & 2 deletions docs/developers/lightweight/json/getting-started.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { Tab, Tabs } from 'nextra-theme-docs'
import { Callout } from 'nextra-theme-docs'

# Getting Started

Expand All @@ -19,4 +19,4 @@ While constructing messages, note that the `@type` field isn't required if the m
🔗 [Common Apollo Objects](/apollo/developers/lightweight/json/object-util)<br/>
🔗 [Adventure Util](/apollo/developers/lightweight/json/adventure-util)<br/>

TODO mention module examples
For examples of module integration, refer to the specific Module pages. Each page contains code samples under the `Manual JSON Object Construction` tab. For instance, you can find sample code for the `BorderModule` on its dedicated page [BorderModule](/apollo/developers/modules/border#sample-code) in the `Sample Code` section.
6 changes: 4 additions & 2 deletions docs/developers/lightweight/json/player-detection.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import { Callout } from 'nextra-theme-docs'

# Player Detection

## Overview
Expand All @@ -12,11 +14,11 @@ This example demonstrates how to detect whether a player is using Lunar Client b
## Integration

```java
public class ApolloPlayerProtoListener implements Listener {
public class ApolloPlayerJsonListener implements Listener {

private final Set<UUID> playersRunningApollo = new HashSet<>();

public ApolloPlayerProtoListener(ApolloExamplePlugin plugin) {
public ApolloPlayerJsonListener(ApolloExamplePlugin plugin) {
Messenger messenger = Bukkit.getServer().getMessenger();
messenger.registerIncomingPluginChannel(plugin, "lunar:apollo", (s, player, bytes) -> { });
messenger.registerIncomingPluginChannel(plugin, "apollo:json", (s, player, bytes) -> { });
Expand Down
3 changes: 2 additions & 1 deletion docs/developers/lightweight/protobuf/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -70,4 +70,5 @@ Available fields for each message, including their types, are available on the B
🔗 [Apollo Serverbound packets](/apollo/developers/lightweight/protobuf/serverbound-packets)<br/>
🔗 [Apollo Roundtrip packets](/apollo/developers/lightweight/protobuf/roundtrip-packets)<br/>

TODO mention module examples
For examples of module integration, refer to the specific Module pages. Each page contains code samples under the `apollo-protos library` tab. For instance, you can find sample code for the `BorderModule` on its dedicated page [BorderModule](/apollo/developers/modules/border#sample-code) in the `Sample Code` section.

1 comment on commit 6ab20b8

@LunarClientBot
Copy link
Collaborator

@LunarClientBot LunarClientBot commented on 6ab20b8 Oct 1, 2024

Choose a reason for hiding this comment

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

📄 Documentation Deployment

Status:❌ Failed
Environment:preview
URL:Pending...

Please sign in to comment.