Release prep: README (Modrinth) + prebuilt jar#2
Conversation
- 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
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: ⛔ Files ignored due to path filters (1)
📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughUpdated 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 Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
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
⛔ Files ignored due to path filters (1)
prebuilt/legacylink-0.1.0.jaris excluded by!**/*.jar
📒 Files selected for processing (1)
README.md
| ### 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. |
There was a problem hiding this comment.
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
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.jarwith documented SHA-256.Checksum
Verify:
shasum -a 256 prebuilt/legacylink-0.1.0.jarMade with Cursor
Summary by CodeRabbit