Skip to content

Adding Minecraft documentation - #560

Merged
Spencer Jones (spencerjunraid) merged 1 commit into
unraid:mainfrom
SpaceinvaderOne:add-minecraft-documentation
Oct 9, 2026
Merged

Spencer Jones (spencerjunraid) merged 1 commit into
unraid:mainfrom
SpaceinvaderOne:add-minecraft-documentation

Conversation

@SpaceinvaderOne

@SpaceinvaderOne SpaceInvader One (SpaceinvaderOne) commented Oct 9, 2026 •

Copy link
Copy Markdown
Contributor

Adds a guide to setting up Minecraft with Crafty 4 on Unraid, with screenshots.

Summary by CodeRabbit

  • Documentation
    • Added a guide to install and configure Crafty 4 on Unraid, create and manage a Minecraft Java Paper server, and connect players.
    • Covered server passwords, whitelists, backups, logs, software updates, and optional Harbour Adventure world setup.
    • Explained how to share the server through Tailscale, including access restrictions and connection requirements.

@coderabbitai

coderabbitai Bot commented Oct 9, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Repository UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 610849cf-5c90-4cb3-9914-5713746be80b

📥 Commits

Reviewing files that changed from the base of the PR and between df8d2e6 and 75ff091.


⛔ Files ignored due to path filters (12)
  • guides/minecraft-with-crafty/images/backup-schedule-enabled.png is excluded by !**/*.png
  • guides/minecraft-with-crafty/images/backup-schedule-settings-enabled.png is excluded by !**/*.png
  • guides/minecraft-with-crafty/images/backup-settings-and-saved-backup.png is excluded by !**/*.png
  • guides/minecraft-with-crafty/images/change-password-dialog.png is excluded by !**/*.png
  • guides/minecraft-with-crafty/images/container-tailscale-settings.png is excluded by !**/*.png
  • guides/minecraft-with-crafty/images/minecraft-add-server.png is excluded by !**/*.png
  • guides/minecraft-with-crafty/images/new-paper-server-terminal.png is excluded by !**/*.png
  • guides/minecraft-with-crafty/images/paper-selected.png is excluded by !**/*.png
  • guides/minecraft-with-crafty/images/server-auto-start-enabled.png is excluded by !**/*.png
  • guides/minecraft-with-crafty/images/tailscale-connect-device.png is excluded by !**/*.png
  • guides/minecraft-with-crafty/images/tailscale-share-machine.png is excluded by !**/*.png
  • guides/minecraft-with-crafty/images/unraid-harbour-world.png is excluded by !**/*.png

📒 Files selected for processing (1)
  • guides/minecraft-with-crafty/index.md

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.



📝 Walkthrough

Walkthrough

Adds a guide to install Crafty on Unraid, create and manage a Minecraft Java Paper server, configure backups, import an optional world, and share game access through Tailscale.

Changes

Crafty Minecraft server guide

Layer / File(s) Summary
Install Crafty and set up the server
guides/minecraft-with-crafty/index.md
Introduces the guide and covers Crafty installation, initial credentials, Paper server setup, Java connections, and whitelist controls.
Manage the server and backups
guides/minecraft-with-crafty/index.md
Explains startup settings, player controls, backup policies and schedules, logs, metrics, and software updates.
Import the optional Harbour Adventure world
guides/minecraft-with-crafty/index.md
Describes world import steps and the server properties needed to load it.
Share access through Tailscale
guides/minecraft-with-crafty/index.md
Documents network-mode constraints, web interface access, game-port sharing, and connection scope. Adds acknowledgments and a guide summary.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~12 minutes

Change: Other


Merge Risk: ⚪ Minimal · up to 75ff0

This PR adds a setup guide, and no supported behavior failure remains. The validation date may refer to a September prerelease, but the exact tested build is unknown; the uncertainty alone does not establish a merge-blocking defect.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check Warning The description accurately summarizes the guide, but it does not include the repository’s required checklist or confirm the required documentation, asset, link, duplicate PR, and build checks. Add the required checklist from the repository template and mark each item after verification. Confirm relative internal links, lowercase dash-separated filenames, asset placement in an assets/ subfolder, duplicate pull request status, and …
✅ Passed checks (4 passed)
Check name Status Explanation
Title check Passed The title clearly and concisely describes the main change: adding Minecraft documentation.
Docstring Coverage Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.

Full details: Description check

Resolution

Add the required checklist from the repository template and mark each item after verification. Confirm relative internal links, lowercase dash-separated filenames, asset placement in an assets/ subfolder, duplicate pull request status, and build success.



  • Fix all pre-merge checks with AI
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR


  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

A rabbit hops beside the server light
Crafty starts, and Paper joins the night
Backups tuck the world away
Friends can find the game and play
One soft paw checks ports are right
Then moonlit carrots mark the night

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

@spencerjunraid
Spencer Jones (spencerjunraid) merged commit e44e678 into unraid:main Oct 9, 2026
2 checks passed
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.

2 participants