Skip to content

Release prep: README (Modrinth) + prebuilt jar#2

Merged
ohnodev merged 2 commits intomainfrom
release/modrinth-readme-prebuilt
Apr 12, 2026
Merged

Release prep: README (Modrinth) + prebuilt jar#2
ohnodev merged 2 commits intomainfrom
release/modrinth-readme-prebuilt

Conversation

@ohnodev
Copy link
Copy Markdown
Owner

@ohnodev ohnodev commented Apr 12, 2026

Summary

Prepare LegacyLink for Modrinth/GitHub distribution: README structure aligned with Reaper-AC (badges, downloads, requirements, version policy, build, resources) and a prebuilt prebuilt/legacylink-0.1.0.jar with documented SHA-256.

Checksum

78369b9d2cec9b95ecef54d8cb153ecb4fd2fd799d0ec532dc6d5ae399410b76  prebuilt/legacylink-0.1.0.jar

Verify: shasum -a 256 prebuilt/legacylink-0.1.0.jar

Made with Cursor

Summary by CodeRabbit

  • Documentation
    • Redesigned README with centered title and badge section (GitHub, license, website, Discord).
    • Reworded “What it does” and clarified scope/limitations for legacy outbound behavior and item remapping distinctions.
    • Added top-level sections: Downloads, Requirements & Installation (compatibility notes), Version Policy, Build from Source, and Prebuilt Artifact with SHA-256 verification.
    • Expanded configuration and logging guidance with new trace options and outbound capture instructions (including environment-variable support).
    • Updated Resources, Contributing, and License links.

- README aligned with Reaper-AC layout (badges, downloads, requirements, policy,
  build, resources).
- Add prebuilt/legacylink-0.1.0.jar with SHA-256 for integrity checks.

Made-with: Cursor
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 12, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 48dd2c02-16b0-4880-9dac-9129ae08eed1

📥 Commits

Reviewing files that changed from the base of the PR and between b90f145 and aacb083.

⛔ Files ignored due to path filters (1)
  • prebuilt/legacylink-0.1.0.jar is excluded by !**/*.jar
📒 Files selected for processing (1)
  • README.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • README.md

📝 Walkthrough

Walkthrough

Updated README to replace the plain header with a centered HTML title and badge block; reorganized and expanded documentation into Downloads, Requirements & installation, Version policy, Build from source, and Prebuilt artifact sections; clarified the “What it does” scope (emphasizing outbound rewrite in LegacyPacketHandler and excluding a second rewrite in Connection.send); adjusted v0.1 scope wording; added Fabric/Java compatibility notes, trace flags including traceCamera, and environment-variable support (LEGACYLINK_CAPTURE_OUTBOUND); added SHA-256 verification instructions and relative LICENSE linking.

Changes

Cohort / File(s) Summary
Documentation Restructure & Enhancement
README.md
Replaced top header with centered HTML title and badge block. Reorganized into: Downloads, Requirements & installation (Java 25+ note, Fabric Loader/Fabric API guidance, minecraft_version compile-target), Version policy, Build from source, Prebuilt artifact (jar path + SHA-256 verification). Reworded "What it does" to emphasize outbound rewrite via LegacyPacketHandler and explicitly exclude a second rewrite in Connection.send. Updated v0.1 scope/limitations (blockstate ID ceiling rephrased, pinning wording adjusted, outbound item-stack remapping vs inbound payloads clarified). Expanded configuration/logging docs: renamed headings, added traceCamera, added full legacy outbound capture instructions and LEGACYLINK_CAPTURE_OUTBOUND env var. Updated Resources, Contributing, and linked LICENSE relatively.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 I hopped through docs to tidy each line,
Badges centered bright, sections now fine,
Downloads, builds, and checksums in view,
Trace the camera, capture outbound too—woo! 🎉

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'Release prep: README (Modrinth) + prebuilt jar' directly aligns with the PR's main objectives: preparing the README for Modrinth distribution and adding prebuilt artifact documentation, which are explicitly stated as the core purposes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch release/modrinth-readme-prebuilt

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@README.md`:
- Line 92: The README documents LEGACYLINK_CAPTURE_OUTBOUND but the code only
checks the JVM system property via
System.getProperty("legacylink.captureOutbound"); update the code that reads
configuration (the logic that calls System.getProperty) to also honor the
environment variable by checking System.getenv("LEGACYLINK_CAPTURE_OUTBOUND")
(falling back to the system property), and update any related config parsing to
treat "1"/"true" equivalently so the environment variable actually enables
outbound capture; reference the existing System.getProperty usage and replace or
augment it with a combined lookup using System.getenv and System.getProperty.
- Line 84: Update the README line documenting the JVM property and grep token
for entity metadata tracing: replace the incorrect flag
`-Dlegacylink.tracePlayerEntityData=true` with the actual JVM property
`-Dlegacylink.traceEntityDataRewrite=true`, and update the grep token from
`[LegacyLink][EntityDataTrace]` to the actual log tag
`[LegacyLink][EntityDataRewrite]` so the docs match the implementation.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: d1c24c5b-a41d-4119-9397-be025d6a9ad5

📥 Commits

Reviewing files that changed from the base of the PR and between d296f12 and b90f145.

⛔ Files ignored due to path filters (1)
  • prebuilt/legacylink-0.1.0.jar is excluded by !**/*.jar
📒 Files selected for processing (1)
  • README.md

Comment thread README.md Outdated
Comment thread README.md Outdated
### Entity metadata for the local player (wrong POV / pose)
### Full legacy outbound capture

`-Dlegacylink.captureOutbound=true` (or `LEGACYLINK_CAPTURE_OUTBOUND=1`) → grep `[LegacyLink][OutboundCapture]`. **Very verbose** — disable after capture.
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

LEGACYLINK_CAPTURE_OUTBOUND=1 is documented but not supported by code.

Current implementation reads only JVM system property legacylink.captureOutbound via System.getProperty(...); the environment variable alternative won’t enable capture.

Suggested README fix
-`-Dlegacylink.captureOutbound=true` (or `LEGACYLINK_CAPTURE_OUTBOUND=1`) → grep `[LegacyLink][OutboundCapture]`. **Very verbose** — disable after capture.
+`-Dlegacylink.captureOutbound=true` → grep `[LegacyLink][OutboundCapture]`. **Very verbose** — disable after capture.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@README.md` at line 92, The README documents LEGACYLINK_CAPTURE_OUTBOUND but
the code only checks the JVM system property via
System.getProperty("legacylink.captureOutbound"); update the code that reads
configuration (the logic that calls System.getProperty) to also honor the
environment variable by checking System.getenv("LEGACYLINK_CAPTURE_OUTBOUND")
(falling back to the system property), and update any related config parsing to
treat "1"/"true" equivalently so the environment variable actually enables
outbound capture; reference the existing System.getProperty usage and replace or
augment it with a combined lookup using System.getenv and System.getProperty.

- Merge origin/main (LEGACYLINK_CAPTURE_OUTBOUND + capture/trace code paths).
- README: entity metadata docs use traceEntityDataRewrite / [EntityDataRewrite];
  outbound capture documents env var (matches LegacyOutboundPacketCapture).
- Rebuild prebuilt jar; update SHA-256 in README.

Made-with: Cursor
@ohnodev ohnodev merged commit 5862d66 into main Apr 12, 2026
1 check passed
@ohnodev ohnodev deleted the release/modrinth-readme-prebuilt branch April 12, 2026 05:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant