RaspberryPiMinecraft

This script will automatically download and configure the Paper Minecraft server!<br> For the full article and guide visit https://jamesachambers.com/raspberry-pi-minecraft-server-script-with-startup-service/<br>

<h2>Installation Instructions</h2> To get started / install the server type:<br> <pre>curl https://raw.githubusercontent.com/TheRemote/RaspberryPiMinecraft/master/SetupMinecraft.sh | bash</pre><br> <h2>Getting Help</h2> To get help you may open an issue here or visit my web site at https://jamesachambers.com/raspberry-pi-minecraft-server-script-with-startup-service/ which contains lots of comments from myself and users helping each other out! <h2>Changing Minecraft Server Versions</h2> If a new version of Minecraft is out and the script hasn't been updated yet you can change it in the SetupMinecraft.sh script. If you use the command nano SetupMinecraft.sh it will be the first line in the file like this:<br> <br> Version="1.18.1"<br> AllowLocalCopy="1"<br> <br> Make sure to change AllowLocalCopy="1" to tell the script you want to actually run the local copy instead of the latest version.<br> Note that for this to work the Paper Minecraft server must also have released the latest version or the download will fail. You can check here: <a href="https://papermc.io/downloads">https://papermc.io/downloads</a><br> <h2>Tested Distributions</h2> <ul> <li>Raspberry Pi OS - Bullseye/Buster/Stretch</li> <li>Ubuntu / Ubuntu Server 22.04 / 21.10 / 20.04 (LTS)</li> <li>Debian 11 Bullseye / Debian 10 Buster / Debian 9 Stretch</li> <li>Arch Linux</li> <li>TinkerOS Stretch</li> </ul> <h2>Troubleshooting Note - Oracle Virtual Machines</h2> A very common problem people have with the Oracle Virtual Machine tutorials out there that typically show you how to use a free VM is that the VM is much more difficult to configure than just about any other product / offering out there.<br> The symptom you will have is that nobody will be able to connect.<br> It is because there are several steps you need to take to open the ports on the Oracle VM. You need to both:<br> <ul> <li>Set the ingress ports (TCP/UDP) in the Virtual Cloud Network (VCN) security list</li> <li>*and* set the ingress ports in a Network Security Group assigned to your instance</li> </ul><br> Both of these settings are typically required before you will be able to connect to your VM instance. This is purely configuration related and has nothing to do with the script or the Minecraft server itself.<br><br> I do not recommend this platform due to the configuration difficulty but the people who have gone through the pain of configuring an Oracle VM have had good experiences with it after that point. Just keep in mind it's going to be a rough ride through the configuration for most people.<br><br> Here are some additional links:<br> <ul> <li>https://jamesachambers.com/official-minecraft-bedrock-dedicated-server-on-raspberry-pi/comment-page-8/#comment-13946</li> <li>https://jamesachambers.com/minecraft-bedrock-edition-ubuntu-dedicated-server-guide/comment-page-53/#comment-13936</li> <li>https://jamesachambers.com/minecraft-bedrock-edition-ubuntu-dedicated-server-guide/comment-page-49/#comment-13377</li> <li>https://jamesachambers.com/legendary-minecraft-bedrock-container/comment-page-2/#comment-13706</li> </ul> <h2>Troubleshooting Note - Hyper-V</h2> There is a weird bug in Hyper-V that breaks UDP connections on the Minecraft server. The fix for this is that you have to use a Generation 1 VM with the Legacy LAN network driver.<br> See the following links:<br> <ul> <li>https://jamesachambers.com/minecraft-bedrock-edition-ubuntu-dedicated-server-guide/comment-page-54/#comment-13863</li> <li>https://jamesachambers.com/minecraft-bedrock-edition-ubuntu-dedicated-server-guide/comment-page-56/#comment-14207</li> </ul> <h3>Buy A Coffee / Donate</h3> <p>People have expressed some interest in this (you are all saints, thank you, truly)</p> <ul> <li>PayPal: 05jchambers@gmail.com</li> <li>Venmo: @JamesAChambers</li> <li>CashApp: $theremote</li> <li>Bitcoin (BTC): 3H6wkPnL1Kvne7dJQS8h7wB4vndB9KxZP7</li> </ul> <h2>Update History</h2> <h3>January 25th 2026</h3> <ul> <li>Upgrade to 1.21.11 (make backups first, and make sure you've copied backup out of the main backups folder as they are rotated)</li> <li>Fix script to use Paper API v3</li> </ul> <h3>July 24th 2025</h3> <ul> <li>Upgrade to 1.21.8 (make backups first, and make sure you've copied backup out of the main backups folder as they are rotated)</li> </ul> <h3>February 8th 2025</h3> <ul> <li>Fix Paper API URLs</li> <li>Upgrade to 1.21.4 (make backups first, and make sure you've copied backup out of the main backups folder as they are rotated)</li> </ul> <h3>December 1st 2024</h3> <ul> <li>Upgrade to 1.21.3 (make backups first, and make sure you've copied backup out of the main backups folder as they are rotated)</li> </ul> <h3>May 19th 2024</h3> <ul> <li>Upgraded Java to OpenJDK 21</li> <li>Upgraded default version to 1.20.6</li> <li>32 bit ARM is no longer supported -- make sure you are running a 64 bit OS to use 64 bit ARM (aarch64)</li> </ul> <h3>April 27th 2024</h3> <ul> <li>Upgrade to 1.20.5 (make backups first, and make sure you've copied backup out of the main backups folder as they are rotated)</li> </ul> <h3>January 4th 2024</h3> <ul> <li>Upgrade to 1.20.4 (make backups first, and make sure you've copied backup out of the main backups folder as they are rotated)</li> </ul> <h3>October 1st 2023</h3> <ul> <li>Upgrade to 1.20.2 (make backups first, and make sure you've copied backup out of the main backups folder as they are rotated)</li> </ul> <h3>March 16th 2023</h3> <ul> <li>Upgrade to 1.19.4 (make backups first, and make sure you've copied backup out of the main backups folder as they are rotated)</li> </ul> <h3>January 14th 2023</h3> <ul> <li>Change connectivity check from google.com to papermc.org to prevent blocking in some countries</li> </ul> <h3>December 9th 2022</h3> <ul> <li>Upgrade to 1.19.3</li> <li>Upgrade to OpenJDK 19</li> </ul> <h3>September 20th 2022</h3> <ul> <li>Update to OpenJDK 18.0.2.1</li> </ul> <h3>September 11th 2022</h3> <ul> <li>Fix memory recommendation to allow a little bit more breathing room to prevent heap errors</li> </ul> <h3>September 4th 2022</h3> <ul> <li>Remove pointless and confusing automation code</li> </ul> <h3>September 2nd 2022</h3> <ul> <li>Fix tail warning message if there is no existing log file</li> </ul> <h3>August 26th 2022</h3> <ul> <li>Raise server startup timeout from 600 seconds to 1800 seconds to prevent startup failure when backing up large servers</li> </ul> <h3>August 10th 2022</h3> <ul> <li>Moved custom directories to the top of SetupMinecraft.sh to eliminate confusion about how to use the feature (and almost nobody should unless you are storing your server on a separate drive)</li> <li>Improve JRE update detection in SetupMinecraft.sh</li> </ul> <h3>August 6th 2022</h3> <ul> <li>Upgrade to 1.19.2</li> </ul> <h3>August 4th 2022</h3> <ul> <li>Script now removes non-alphanumeric characters from the servername variable (to prevent using quotes and other symbols that will break it)</li> </ul> <h3>August 2nd 2022</h3> <ul> <li>Fix ARM link for Adoptium OpenJDK (thanks zqigolden, <a href="https://github.com/TheRemote/RaspberryPiMinecraft/pull/42">PR #42</a></li> <li>OpenJDK will now detect if you have an older version than SetupMinecraft is installing (or a broken Java install) and reinstall the newest version</li> </ul> <h3>July 31st 2022</h3> <ul> <li>Upgrade Adoptium OpenJDK to 18.0.2 -- if you want to upgrade your Adoptium you can remove the ~/minecraft/jre folder and run SetupMinecraft.sh again to upgrade to the latest one</li> </ul> <h3>July 27th 2022</h3> <ul> <li>Update to 1.19.1 (always make sure you've copied some backups out of the backups folder first!)</li> </ul> <h3>June 15th 2022</h3> <ul> <li>Fix Paper 1.19 version upgrades (thanks Meganium97, <a href="https://github.com/TheRemote/RaspberryPiMinecraft/issues/41">issue #41</a>)</li> </ul> <h3>June 11th 2022</h3> <ul> <li>Update to Paper experimental 1.19 release as default installation</li> <li>Make sure you have backups of your server from your "backups" folder stored separately before upgrading</li> <li>If you have problems with 1.19 you need to restore a backup to go back to 1.18 as it will not take your server data files on 1.18 once the 1.19 structures/data have been added</li> <li>Change update.sh to /bin/bash instead of /bin/sh</li> <li>Add PATH variable to update.sh</li> </ul> <h3>May 22nd 2022</h3> <ul> <li>Update OpenJDK installation paths</li> </ul> <h3>May 21st 2022</h3> <ul> <li>Switched from JDK to JRE to save space</li> <li>Added Adoptium OpenJDK support for s390x and ppc64le architectures</li> </ul> <h3>May 16th 2022</h3> <ul> <li>Add -DPaper.IgnoreJavaVersion=true to allow OpenJDK 17 to run the older Paper Minecraft versions (thanks NotMick, <a href="https://github.com/TheRemote/RaspberryPiMinecraft/issues/39">issue #39</a>)</li> </ul> <h3>May 15th 2022</h3> <ul> <li>Added screen -wipe to beginning of start.sh to prevent a startup issue that could occur if there was a "dead" screen instance (thanks grimholme)</li> </ul> <h3>May 11th 2022</h3> <ul> <li>Fix Adoptium arm and aarch64 OpenJDK links (thanks 407pilot, <a href="https://github.com/TheRemote/RaspberryPiMinecraft/issues/38">issue #38</a></li> </ul> <h3>May 10th 2022</h3> <ul> <li>Update Adoptium OpenJDK version</li> <li>Add safety check for backups to make sure folder exists before pruning</li> </ul> <h3>May 8th 2022</h3> <ul> <li>Fixed a problem with restart.sh having a #!/bin/sh at the top which could cause restart.sh to run in a POSIX shell that doesn't recognize the [[ operator (thanks jmswan, <a href="https://github.com/TheRemote/RaspberryPiMinecraft/issues/37">issue #37</a></li> </ul> <h3>