Lightweight: Documentation #172
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ItsNature
changed the title
…ne()) for backwards compatibility
ItsNature
changed the title
ItsNature
requested review from
TrentinTheKid and
vectrixdevelops
and removed request for
vectrixdevelops
TrentinTheKid
approved these changes
Oct 9, 2024
Strafin
approved these changes
Oct 10, 2024
vectrixdevelops
approved these changes
Oct 11, 2024
Merged
ItsNature
added a commit
that referenced
this pull request
Oct 28, 2024
* Deploy as 1.1.5-SNAPSHOT * Lightweight (#162) * WIP: lightweight docs * Lightweight doc revamp * Simple touch-ups * Switch methods to tabs * Attempt to fix tabs * Close tabs * again * Revert tabs * Attempt to add tabs once more * Add tab import * Fix tab import * Add lightweight-wrapper & lightweight-example modules * Register "lunar:apollo" for player detection * Add protobuf repo section * Remove lightweight-wrapper & lightweight-example * Add the Apollo repository & protobuf-java-util as dependency to docs * Use correct ` * Fix typo --------- Co-authored-by: TrentinTheKid <25537885+TrentinTheKid@users.noreply.github.com> * fix: ClassCastException for Color conversion in newer Java versions (#161) * fix: ClassCastException for Color conversion in newer Java versions This commit corrects the issue by converting the Color object to its RGB hex string representation. * fix: Restore HEX string compatibility while retaining Color object support This commit addresses the regression introduced in the previous fix that enabled Color object usage but broke HEX string compatibility. The code has been adjusted to ensure that both HEX strings (e.g., "#FFFFAA00") and Color objects (e.g., Color.RED) can be used interchangeably when setting color values in options.set(). This fix ensures backward compatibility with the previous behavior while retaining the ability to use Color objects without causing a ClassCastException. * Throw RuntimeException for invalid Color types --------- Co-authored-by: ItsNature <matej.bucaric@gmail.com> * make player an audience (#163) * Deploy as 1.1.6-SNAPSHOT * Feature - Tebex Module (#167) * Implement Tebex module * Rename TebexCheckoutSupportType to TebexEmbeddedCheckoutSupport & add basket id parameter to the tebex command * basketId -> basketIdent * Remove callout & doc page --------- Co-authored-by: TrentinTheKid <25537885+TrentinTheKid@users.noreply.github.com> * Feature - Add Tebex locale field (#174) * Add locale field to the tebex module * Add seperate method to not break the API * Use correct locale arg * Lightweight: Documentation (#172) * Add a bunch of lightweight examples * Add more examples * Even more examples... * More examples & prepare for example plugin merge * Fix adventure usages * Testable state * Add more notes * Add switch implementation command * Finish more examples, start working on markdown * Spotless fixes * Update beam.mdx with new examples * Finish team examples * More markdown work * Add missing import to chat.mdx * Move builders outside tabs again * Fix remaining serialization issues * Add more markdown examples * Add hologram & limb examples * move builders inside API tab, add nametag, nickhider & notification examples * Finish proto examples * Remove object utils * add temp layout * Finish all Json Examples * Add Tebex module locale field to lightweight examples * The merge! * Start lightweight.mdx rewrite * Close tab * Import callout * ADd modsettings examples * richpresence, serverrule, staffmod, stopwatch, title, tntcountdown, tranfser, vignette & waypoint markdown examples * Protobuf Lightweight Documentation * Minor changes * Updating player world code & markdown, packet enrichment & minor parameter fixups * Fix links * Fix the fixed links * Spotless fixes * Add lightweight callout to intro * add intro to meta json * Finish JSON lightweight docs * Remove old lightweight.mdx * Link usage methods, add module examples note * resolve callout issue? * Rebuild * Team markdown examples * update callout * update callout * remove placeholder text * Remove build status * Replace Component#appendNewLine with Component.append(Component.newline()) for backwards compatibility * Default implementation type to API * Remove protobuf-java-util dependency * Final touch-ups * fix typo * Wording Change * Lightning -> Lighting * Use Futures for Roundtrip example & implement timeout * Mark player data fields with `@Nullable` --------- Co-authored-by: TrentinTheKid <25537885+TrentinTheKid@users.noreply.github.com> * Feature - Add packet spam debug command example (#177) * add spam packet debug command * decrease delay on packet spam * improve spam packets command --------- Co-authored-by: ItsNature <matej.bucaric@gmail.com> * Sync LunarClient Mods & Options (#181) * Sync LunarClient Mods & Options * Update version tags to 1.1.6 --------- Co-authored-by: LunarClient Bot <lc-bot@moonsworth.com> * Bump to 1.1.6 (#182) --------- Co-authored-by: TrentinTheKid <25537885+TrentinTheKid@users.noreply.github.com> Co-authored-by: Hugo <58655174+Rhodless@users.noreply.github.com> Co-authored-by: Connor <vectrixu+gh@gmail.com> Co-authored-by: LunarClient Bot <lc-bot@moonsworth.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
Description:
This update enhances documentation for Apollo’s Lightweight integration, providing comprehensive examples for each integration type. It includes guides on detecting Apollo players, listening for Apollo packets, and utilizing utilities to simplify integration.
Changes:
apollo-bukkit-exampleNow demonstrates three different approaches to Apollo integration:
Added
/switch <API:PROTO:JSON>command to switch Apollo integration types.A new
Lightweightdirectory was added to the documentation page.🔗 Getting Started
🔗 Player Detection
🔗 Serverbound Packets
🔗 Roundtrip Packets
🔗 Packet Util
🔗 Object Util
🔗 Adventure Util
🔗 Getting Started
🔗 Player Detection
🔗 Packet Util
🔗 Object Util
🔗 Adventure Util
Added Protobuf and JSON code examples for each Apollo module, providing sample integration snippets on every module documentation page. These examples offer direct guidance for implementing Apollo features across different integration methods.
For instance, sample code for the BorderModule is available in its Sample Code section on the BorderModule page.
Review Request Checklist
feature/add-module&bugfix/fix-issue)