Minecraft 1.17 (Caves and Cliffs Update) is here! This script and guide are written to help you get a great performing Raspberry Pi Minecraft server up and running in only a few minutes.
This is the standalone version. It runs on most flavors of Linux and should work on most architectures as well (arm, aarch64, etc.).
I highly recommend using Docker over the standalone version for most people. Installing Docker is as simple as sudo apt install docker.io. There are 3 Docker options available:
- The Docker version that has Geyser + Floodgate installed (allowing people running Minecraft Bedrock Edition such as on iOS, Android, and console to connect)
- The Docker version that runs the Purpur Minecraft server with Geyser + Floodgate installed (allowing people running Minecraft Bedrock Edition to connect)
- The Docker version that only includes the Paper Minecraft server (the same as this standalone version)
It’s now possible to convert your worlds between Bedrock and Java versions. Check out my guide on Chunker here for more information.
Features
- Sets up fully operational Minecraft server in a couple of minutes
- Runs the highly efficient “Paper” Minecraft server
- Raspbian / Ubuntu / Debian distributions supported
- Installs and configures OpenJDK 18
- Sets up Minecraft as a system service with option to autostart at boot
- Automatic backups to minecraft/backups when server restarts
- Updates automatically to the latest version when server is started
- Easy control of server with start.sh, stop.sh and restart.sh scripts
- Optional scheduled daily restart of Pi using cron
Requirements
- Raspberry Pi model with 1 GB of RAM or higher. Basically a Raspberry Pi 2B or higher. (No Zero unfortunately, 512MB is not enough RAM to do this, I’ve tried!)
- Headless Linux distribution such as Raspbian Buster Lite, Ubuntu Server 18.04.2, or any Debian based distribution (GUI distros can be used at the expense of available RAM and server performance)
- Solid state drive highly recommended but not required.
You can get a SSD setup on a Pi for less than most Micro SD cards cost. See my article here for details - If using MicroSD you want to be using a high range card otherwise you will really be hurting on IO when the server is reading/writing chunks of terrain! Click here for MicroSD card benchmarks/recommendations.
Recommended Gear
The Raspberry Pi 4 is available in different memory configurations all the way up to 8 GB. It’s about the size of a credit card and uses an extremely low amount of power making it ideal for all sorts of projects and ideas!
Links: Amazon.com*, AliExpress*, Amazon.ca*, Amazon.com.au*, Amazon*.co.jp*, Amazon.co.uk*, Amazon.de*, Amazon.es*, Amazon.fr*, Amazon.it*, Amazon.nl*, Amazon.pl*, Amazon.se*, Amazon.sg*
The Raspberry Pi 400 kit includes everything you need for a full Pi 400 desktop build. The Pi 400 is the fastest Raspberry Pi ever released and comes in the form factor of a keyboard!
Links: Amazon.com*, AliExpress*, Amazon.ca*, Amazon.com.au*, Amazon.co.jp*, Amazon.co.uk*, Amazon.de*, Amazon.es*, Amazon.fr*, Amazon.it*, Amazon.nl*, Amazon.pl*, Amazon.se*, Amazon.sg*
The Kingston A400 has been a great drive to use with the Pi for years. It’s reliable, widely available around the world, has low power requirements and performs very well. It’s also very affordable. This drive has been benchmarked over 1000 times at pibenchmarks.com and is the #1 most popular SSD among the Pi community!
Links: AliExpress*, Amazon.com*, Amazon.ca*, Amazon.com.au*, Amazon.co.jp*, Amazon.co.uk*, Amazon.de*, Amazon.es*, Amazon.fr*, Amazon.it*, Amazon.nl*, Amazon.pl*, Amazon.se*, Amazon.sg*
The USB 3.1 variant of the StarTech 2.5″ SATA adapter works well with the Pi 4. The USB 3.0 variant doesn’t have firmware updates available and is not recommended.
Links: Amazon.com*, Amazon.ca*, Amazon.com.au*, Amazon.co.jp*, Amazon.co.uk*, Amazon.de*, Amazon.es*, Amazon.fr*, Amazon.it*, Amazon.nl*, Amazon.pl*, Amazon.se*, Amazon.sg*
SD Card Setup:
The SanDisk Extreme A1-A2 SD card has the best scoring SD card on Pi Benchmarks for years and is second in popularity only to the SanDisk Ultra (often included in combo kits). The application class (A1) means random I/O speeds (very important when running an OS) have to meet a higher standard. There’s no benefit on the Pi for A2 right now so get whichever is cheaper/available.
Links: AliExpress*, Amazon.com*, Amazon.ca*, Amazon.com.au*, Amazon.co.jp*, Amazon.co.uk*, Amazon.de*, Amazon.es*, Amazon.fr*, Amazon.it*, Amazon.nl*, Amazon.pl*, Amazon.se*, Amazon.sg*
Choosing a Linux Distribution
The most important consideration when choosing which flavor of Linux to run the server on is simple: available RAM. Headless Linux distributions such as Raspbian Lite that don’t have a built in GUI have
Our biggest obstacle when running a Minecraft server on the Pi is available RAM since 1 GB is extremely low for this type of server. To have a playable experience you should not be running anything else on the Pi so all memory is available to be used.
After testing on many different distros I am finding Raspbian Lite and Ubuntu Server 18.04.4 32-bit to be the best choices. These distributions come with very few background processes and have rock solid support and performance.
64-bit vs 32-bit
There’s a lot of discussion in the Pi world about the up and coming aarch64 64-bit distributions vs. armhf 32-bit distributions. They have been and continue to improve dramatically. There are already use cases where 64-bit is far superior such as video encoding, advanced compression, etc.
So how about for running a Minecraft server? I have been testing extensively with Ubuntu Server 18.04 64-bit and the Debian Buster 64-bit. I have consistently had worse performance and stability than on 32-bit versions of the exact same distros.
But how can that be? It’s certainly true that Minecraft servers benefit in CPU performance from 64-bit versions of Java. The answer is actually incredibly simple: memory. The server running on a 64-bit Java Virtual Machine uses a minimum of about 100 MB more memory. This makes perfect sense because 64 bits > 32 bits by definition!
The Raspberry Pi’s 1 GB of memory has been the biggest obstacle for this project since the very beginning. Back when I first went into the Paper Minecraft developer IRC room and told them what I was trying to do I was practically laughed out of the chat room for even thinking of trying this. Most Minecraft server branches including vanilla can’t even start on the Pi because of the limited memory.
For a dedicated Minecraft server on the Pi I very highly recommend staying 32-bit. You will have more available memory which means it will be much faster and more stable. Since memory is our bottleneck the increased CPU throughput does not help us and losing *any* of our memory is disastrous!
If the Raspberry Pi 4 has more memory like we all expect it to this recommendation will change completely. Even 2 GB of memory would make the extra memory that 64-bit uses a non-issue and the CPU throughput performance gains very desirable. For now though stay 32-bit for a Minecraft server!
Tested Distributions
Raspberry Pi OS – It’s Raspbian. It has very low memory usage and is the official distribution of the Raspberry Pi. The server runs very well on this. It’s overall the best choice. The Buster release has made OpenJDK 11 available on it so it’s no longer behind the rest of the distros.
Ubuntu Server 18.04 / 20.04 – Ubuntu Server is my favorite Linux distro. I use it for nearly all of my projects. The performance of the 32-bit armhf version is on par with Raspbian. It’s a great choice! Click here for my Ubuntu setup guide for Raspberry Pi. The 64-bit version is not a fantastic choice and not recommended because of the higher memory usage. Stick with 32-bit and you’ll be a happy camper with Ubuntu Server.
Debian Buster 64-bit – Debian is the distribution Raspbian is based on. This version is a preview of Debian “Buster” which is the successor to Stretch and will be the next version of Raspbian when it is released. I like this distribution but it is currently still unofficial and unsupported. Performance and stability was less than Ubuntu and Raspbian.
Minecraft Server Installation
SSH into your Raspberry Pi and paste the following commands:
curl https://raw.githubusercontent.com/TheRemote/RaspberryPiMinecraft/master/SetupMinecraft.sh | bash
The script will setup the Minecraft sever and ask you some questions on how to configure it. I’ll explain here what they mean.
“Enter amount of memory in megabytes to dedicate to the Minecraft server” – The amount of memory that will be dedicated to the Minecraft server. The more the better, but you must leave some room for the operating system background processes.
If you exceed the total available memory either the server will crash or the Pi will get incredibly slow to the point where your SSH session will start timing out. The setup script will make a recommendation to you which is your available memory – 10% for headroom. If you aren’t sure what to put just go with the recommended amount.
Note for Raspberry Pi 4: Currently on 32-bit Raspbian 2700 MB is the maximum that Linux will let us allocate in a 32 bit environment. The script has been updated to check for this as the server will not start if it is set over 2700M on a 32 bit server. 64 bit operating systems will be able to allocate all available memory as Pi 4 support rolls out for them.
“Start Minecraft server at startup automatically (y/n)?” – This will set the Minecraft service to start automatically when your Pi boots. This is great because whenever you want to play you can just plug it in and go without having to SSH in.
“Automatically reboot Pi and update server at 4am daily (y/n)?” – This will add a cron job to the server that reboots the Pi every day at 4am. This is great because every time the server restarts it backs up the server and updates to the latest version. See the “Scheduled Daily Reboots” section below for information on how to customize the time or remove the reboot.
That is it for the setup script. The server will finish configuring and start!
Check Java Version
Sometimes if you have multiple versions of Java installed the wrong version of Java will be selected as the default. If the server didn’t start check that the right version of Java is selected with this command:
sudo update-alternatives --config java
If you get the message “update-alternatives: error: no alternatives for java” then you only have one version of Java installed and can skip to the next section.
If you are presented with a list of choices then your machine has multiple versions of Java installed. It will look like this:
update-alternatives: warning: /etc/alternatives/java has been changed (manually or by a script); switching to manual updates only There are 2 choices for the alternative java (providing /usr/bin/java). Selection Path Priority Status ------------------------------------------------------------ 0 /usr/lib/jvm/java-11-openjdk-amd64/bin/java 1101 auto mode 1 /usr/lib/jvm/java-11-openjdk-amd64/bin/java 1101 manual mode 2 /usr/lib/jvm/java-8-openjdk-amd64/jre/bin/java 1081 manual mode
You will usually want to just select the newest version of OpenJDK that is listed so you would type 0 and press enter. In some cases on some platforms you may want to switch to the official Oracle JDK although I strongly recommend sticking with OpenJDK!
First Run
The first time you run the server it will take a little longer to start since it is generating all the server data. If you try to log in before it fully starts you will get a connection timeout error. Watch for the line: “Timings Reset”. This is the last line that prints when the server is ready to rock and roll. At this point you will be able to connect successfully.
The very first time you log into the server it will be slow for about 1-2 minutes. This is because since nobody has logged in before the server has to scramble to generate all the chunks within your view distance (10 by default) and send them to you/store them. During this time you may not be able to see very far and if you try to destroy blocks there will be noticeable lag from when they break to when they actually disappear.
Don’t panic! This will go away within a couple of minutes as the Pi catches up with all the first time login stuff it needs to do. Performance stabilizes and it will feel very much like the offline experience after that.
If you are hosting for a few friends I’d recommend logging in for the first time right after you set up the server instead of having several people nail a blank server at first startup. This gets it out of the way and when everyone is ready to log in the starting area chunks will be fully fleshed out and the Pi just has to read them. It’s an order of magnitude faster for the Pi to read chunks than to generate and store chunks.
In my experience after the initial login exploring new parts of the server doesn’t cause any lag even though new chunks are being generated. The reason for this is that when you’re walking it’s really only having to generate a new chunk as you get close to the border instead of a huge square area of chunks in all directions and all at the same time like during the first login.
Benchmarking / Testing Storage
If you’re getting poor performance or just want to verify everything is working correctly you may want to run my storage benchmark with:
sudo curl https://raw.githubusercontent.com/TheRemote/PiBenchmarks/master/Storage.sh | sudo bash
If you search for the model of your drive on pibenchmarks.com you can compare your score with others and make sure the drive is performing correctly!
Changing Minecraft Server Version
To override the default version let’s grab a copy of the script locally:
wget https://raw.githubusercontent.com/TheRemote/RaspberryPiMinecraft/master/SetupMinecraft.sh
nano SetupMinecraft.sh
Now make these changes from inside nano:
Version="1.16.5"
AllowLocalCopy="1"
Now press Ctrl+X to exit nano and answer “y” to save. Now let’s run the script:
chmod +x SetupMinecraft.sh
./SetupMinecraft.sh
And the setup will run and install the version of Minecraft you set at the top of the file!
Changing Minecraft Client Version
If you are wisely running the “stable” branch instead of the “development” branch there will be times where you need to select the version of Minecraft to run otherwise you will get an error message that your client is outdated when you try to log in.
Fortunately this is very easy. Open up the Minecraft launcher and instead of hitting “Play” choose “Launch Options” in the menu at the top of the window. It will look like this:
Click the “Add new” button and pick which version you want to add. You can optionally gave it a name or just click save.
Now when you go back to the “News” tab you will see a dropdown arrow where you can select which version of Minecraft you want to play!
Start, Stop and Restart Server
The server can be started, stopped and restarted two different ways. You can use the provided scripts in the Minecraft folder or you can use systemctl. Here are the commands:
cd ~/minecraft ./start.sh ./stop.sh ./restart.sh -OR- sudo systemctl start minecraft sudo systemctl stop minecraft sudo systemctl restart minecraft
Automatic Backups
The server backs up each time it starts. This helps you recover easily if something goes wrong. This system works best if you configured the server to restart daily since it means you will have a backup every day.
To access these backups type:
cd ~/minecraft/backups
ls
When a backup is made the filename will be the date and time the backup was taken. If you need to restore a backup it’s very easy. Substitute the timestamp in my example to the backup you want to roll back to. Type:
cd ~/minecraft ./stop.sh rm -rf world world_nether world_the_end tar -xf backups/2019.02.15.22.06.30.tar.gz ./start.sh
Your world has now been restored! It’s a good idea to download these backups off the Pi periodically just in case the Pi’s storage fails.
Scheduled Daily Reboots
The daily reboots are scheduled using cron. It’s very easy to customize the time your server restarts.
To change the time that the server restarts type: crontab -e
This will open a window that will ask you to select a text editor (I find nano to be the easiest) and will show the cronjobs scheduled on the Pi. The Minecraft one will look like the following:
0 4 * * * /home/ubuntu/minecraft/restart.sh
There are 5 fields here. The default restart time is set to reboot at 0 minutes of the 4th hour of the day (4 AM). The other 3 fields are left as * to represent every day of every month. Make any desired changes here and press Ctrl+X to exit nano and update the cronjob.
To remove the daily reboot simply delete the line and save.
Installing Mods / Plugins
The server supports plugins that are compatible with Bukkit / Spigot / Paper. A popular place that you can get plugins is at dev.bukkit.org where there are thousands of them!
To install a plugin you simply download the .jar to the minecraft/plugins folder and restart the server. For example, WorldGuard is a very popular plugin that lets you add protection to different areas of your server.
To install this plugin on our Minecraft server we would use the following commands:
cd ~/minecraft/plugins curl -H "Accept-Encoding: identity" -H "Accept-Language: en" -L -A "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/90.0.12.212 Safari/537.36" -o worldguard.jar https://dev.bukkit.org/projects/worldguard/files/latest sudo systemctl restart minecraft
The reason the middle line is so long is that “robots” (roughly anything that isn’t a web browser being used by a user in this context) including scripts and utilities are blocked by the Bukkit server. The extra parameters we’re including in this line will add the location (-L) flag as well as a user agent and an identity / language header which will allow us to fetch the files without getting a 403 forbidden error.
Make sure to change “-o worldguard.jar” (second to last parameter) and the URL (very last parameter) to match the project you want to download.
The server will restart and the plugin will be installed. It’s that simple! To use the plugin refer to the documentation on the plugin download page to find out which commands you use to configure/interact with it.
Warning: be advised that plugins are the #1 issue for performance degradation on Minecraft servers. This isn’t because all plugins are bad. Some plugins are coded very inefficiently or perform features that require a lot of hooks in the code.
You should be careful about what plugins you install on the server and if you start having bad performance disable your plugins one by one until you find the culprit!
Reconfigure / Update Scripts
The scripts can always be reconfigured and updated by downloading the latest SetupMinecraft.sh and running the installer again. It will update all of the scripts in the Minecraft directory and reinstall the startup service for you.
Running SetupMinecraft.sh again will also give you a chance to reconfigure options such as the memory dedicated to the server, daily reboots, starting the server on boot, etc.
This will not overwrite your world or any other data so it is safe to run!
Port Forwarding
If everyone on your server is on the same LAN or WiFi network as you then you don’t need to do this. If you want people to connect from outside your local network then you need to set up port forwarding on your router.
The process for this is different for every router so the best thing to do is just look at your router and find the model # and put that in google with port forwarding for easy instructions on how to do it for your specific router.
You want to forward port 25565. The type of connection is TCP if your router asks. Once you do this people will be able to connect to your Minecraft server through your public IP address. This is different than your local IP which is usually a 192.x.x.x or 10.x.x.x. If you don’t know what that is just go to google and type “what’s my ip” and Google will kindly tell you!
Wired vs. Wireless
Going with an ethernet (wired) connection is going to be faster and more reliable. There’s so much wireless traffic and other interference in the air that running your server on WiFi is not recommended.
Even if it is working great 99% of the time it can ruin your experience very quickly if the WiFi drops for a couple of seconds and you get blown up by a creeper!
All that being said, the server works fine on wireless. The script will work fine as is with a wireless connection.
Upgrading
PLEASE BACK UP YOUR SERVER FIRST! The server makes automated backups by default for you in the backups folder but I recommend you back up the entire server folder yourself (basically the entire minecraft folder) any time you attempt to upgrade or downgrade. If you need to roll back to older versions it won’t work without a backup from that version or older!
The easiest way to upgrade an installation is to download the latest SetupMinecraft.sh and run it. This will automatically upgrade you to the latest version.
Upgrading and downgrading to versions that aren’t the default the script chooses is pretty simple. Simply change the Version line at the top in the SetupMinecraft.sh script:
#!/bin/bash
# Minecraft Server Installation Script - James A. Chambers - https://jamesachambers.com
# More information at https://jamesachambers.com/raspberry-pi-minecraft-server-script-with-startup-service/
# GitHub Repository: https://github.com/TheRemote/RaspberryPiMinecraft
# Minecraft server version
Version="1.16.1"
Edit this file in your favorite text editor (you can use nano or vi on the Pi like nano SetupMinecraft.sh) and change the Minecraft version to what you want.
Downgrading
PLEASE RESTORE USING A BACK UP FROM THE VERSION YOU ARE DOWNGRADING TO
If you are having problems on a newer version of Minecraft and want to downgrade you can do so using a complete backup of your server before you ran it on a newer version.
The reason you can’t take server data that has been touched by a version such as 1.17 and go back to 1.16 is that the new version adds all sorts of new data types/structures for the new content into your server data files. If you try to roll back the old versions of the Minecraft server will not understand these data types since they didn’t exist in that version and will crash.
As long as you use a backup for your server files from that version (or older) it’s as simple as changing the version in SetupMinecraft.sh just like I show in the “Upgrading” section.
You can upgrade any old version of Minecraft to any version, but again make sure you have a backup first as it is a one way street and you will need that backup if you want to roll back!
Troubleshooting Note – Oracle Virtual Machines
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.
It is because there are several steps you need to take to open the ports on the Oracle VM. You need to both:
- Set the ingress ports (TCP/UDP) in the Virtual Cloud Network (VCN) security list
- *and* set the ingress ports in a Network Security Group assigned to your instance
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.
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.
Troubleshooting Note – Hyper-V
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.
Version History
To view the version history check out the GitHub README here:
Update History – RaspberryPiMinecraft – Official GitHub Page
Other Resources
If you’re trying to set up SSD / USB storage booting check out my Raspberry Pi USB booting setup guide
For benchmarks and recommendations on the fastest storage drives/adapters for the Raspberry Pi check out my 2021 Storage Roundup
If you’re having firmware issues and need to update/restore your firmware check out my Raspberry Pi firmware guide here
Hi there, thank you so much for the tutorial, I have set everything up and it works fine locally. Unfortunately my port forwarding doesn’t seem to work, even though I have checked multiple times wether the correct device and port is selected. Both the IPv4 address and the IPv6 address show “minecraft” on port 25565 when I check them using an online ipv scanner tool but they always get listed as “filtered”. I have tried everything from resetting the router to resetting the pi but nothing seems to work.
Is there anything else I need to do besides opening port 25565 on TCP when I want to make my server available publicly? Like any settings on the pi or contacting my ISP for them to open something up?
Thanks in advance,
Leon
Hey Leon,
There’s a couple key things to check for. First try setting both “UDP” and “TCP” for your port forwarding types. Minecraft can utilize both protocols and most routers let you pick which one. Many will have a “Both” choice for TCP and UDP or you can add separate entries for each type. This can often explain issues like this and has weird side effects like sometimes you can see the server and not connect to it, etc.
If you are still seeing filtered then it still must be hitting a firewall somewhere. Make sure your computer if it’s running Windows with the client has the “Public” type allowed in Windows Firewall sometimes has helped with this and it ended up being on the client side. On Linux I usually tell people to make sure they do a ufw allow 25565 to allow it through the software firewall but usually Pi distributions don’t have this set up. I wanted to mention it though in case you’re running a secured distro or installed a firewall.
There are some ISPs that do port filtering so it is possible but if you’re on a pretty standard fiber/cable/DSL connection then it’s most likely still hitting a firewall at some point. Is there anything unusual about your network such as are you going through multiple routers (aka “double NATting”)? This can create a situation like this where the ports won’t be reachable but the connection will otherwise seem to work normally (you also will get a “poor” connection status in Xbox Live or Playstation Network in a double NAT setup for this same reason, even if the ports are open it won’t be reachable from the outside world through if it goes through NAT twice).
Can you get port forwarding to work through your router with any ports? Like if you set up a port forward for a common port like port 80 for a web server does that still show up as filtered? If it does then you may indeed need to talk to your ISP especially if this is something like a shared community connection/co-op/shared apartment setups/etc. because in that case you really may have another firewall set up between you and the outside world that is outside of your control. Let us know what you find!
Hey James,
thank you so much for your quick response.
I opened both the UDP and TCP ports 25565 on the raspberry pi.
My operating system is raspberry pi OS lite and it is a fresh install so no previous settings. Also, I already found the suggestion to make a rule for a possible firewall inside the raspi and ran the sudo ufw allow 25565 command and it didn’t help.
My router setup is very basic. One router that is connected via DSL to my ISP and my raspi is connected via ethernet. I think I found the problem though. Since IPv4 addresses are getting scarce these days, my internet provider has given me a “DS-Lite-Tunnel” (I don’t know whether that is a thing outside Germany, but seems to be a common problem here), where I get the same public IPv4 address as hundreds or maybe thousands of others. Now the weird thing is: Why would minecraft show up on IPv4 scanners if I share the IP address with many others? Is port 25565 only used for minecraft and this could be any customer? On the other hand, there probably is a firewall or some kind of software generally blocking direct connections because the ISP wouldn’t know which customer to reroute it to. I have now set up ngrok, a tcp tunneling service, that gives me a random subdomain where my friends can connect to. As far as I understand, traffic from localhost is now rerouted through their servers and their DNS is set up to make connections like this possible. On the paid plan, I get a fixed TCP address (even 2 but I only need one). I have tried connecting to the raspi via mobile networking and it seems to work, but the last time my friend tried, he couldn’t get in. We are retrying but I am hopeful this is the solution. $10 a month for this service is still cheaper than getting a hosted server with the raspi specs and the freedom of programming it however I like so I am thinking of getting the pro version if it works. Could be a nice addition to your tutorial for people with the same problem.
I’ll keep you updated!
Have a good one,
Leon
Hey Leon,
Thanks so much for the detailed explanation! That actually makes perfect sense. This is how a lot of the examples of the shared internet connections I gave work as well.
It looks like the $10/mo ngrok should work. There’s a guide on setting it up here. ngrok doesn’t do UDP so I don’t think the server browser would work (things like showing players online) but they should be able to connect still.
They’ll also need their Windows Firewall settings set up correctly if they’re on Windows. They need “public” networks allowed, and not just private etc. It’s likely to be on their end if you can connect to it through your public address. When you connect you have to go through the same encrypted tunnel and you are being routed to a server somewhere far away and then sent back into your house when you do it. You’ll also notice your ping will be higher to reflect that.
I think you’re really close, let me know how it turns out!
Hey James,
it finally works!
Ngrok was the solution after all. I decided to go for the $10/mo option to get a static address and my friends can connect now!
As I want the convenience of not having to restart the ngrok service manually every time the server restarts I spent a couple of hours trying to autoconnect via ngrok on startup. I finally found the solution here. If you set up the given ngrok.yml config file with the instructions on the ngrok website, the tcp tunnel connection to the permanent address is established automatically on boot.
It’s such a great feeling when everything works!
I am now figuring out whether I can put a CNAME DNS record on my personal domain that routes to the ngrok domain, because the ngrok domain is pretty long and difficult to remember. Something like mc.domain.com would be nicer. Unfortunately I tried pinging the CNAME record (host: mc, address: …ngrok.io) and I get a “host not found” error, while I can ping the address …ngrok.io just fine. Is there more to setting this up? I can’t find anything through google for this specific use case.
It’s not really important, it would just be the cherry on top.
Thank you for your quick responses and your great tutorial again. I really appreciate it.
Cheers,
Leon
Hey Leon,
That’s fantastic news! You should be able to get the CNAME working theoretically for sure but it sounds like it’s tricky. The default configuration seems to use the “Host” header to route you to the correct place. Check out this here.
Is your .ngrok.io a “reserved” hostname? Or is it just the randomly assigned one? It sounds like if you have the deluxe/premium plan you should be able to reserve it and use custom hostnames. I couldn’t tell from this specific answer if they tried this with a CNAME record or if they just meant a static hostname, which may be what you have already but it’s long and ugly.
I then found this. That sounds like there’s some options to specify upon ngrok startup to use a specific domain. The requirement is you have to have a CNAME created for this option to work but it sounds like you have that requirement met already.
ngrok http -hostname=dev.example.com 8000
was the example they gave. Maybe this is the missing configuration piece and everything else is already set up correctly (hopefully)!Just a couple ideas to help, definitely let us know how it turns out!
I got it to work!
The configuration was fairly easy, I was just a tad impatient haha! The DNS records don’t get updated immediately so it worked after a couple of hours.
My …ngrok.io is reserved and static as I am paying for the premium plan, with a changing address it would be a lot harder to do this.
The CNAME record should just be a subdomain name in the HOST field – in my case “mc” because it’s short and clear and the Value is the assigned static TCP Address by ngrok without the port on the premium plan for $10.
Once you’ve configured that and the DNS settings are updated by your provider, you can connect via
mc.yourdomain.com:[ngrokport]
which is kinda neat.You’re getting two TCP addresses on the ngrok $10 plan so I just set up a static ssh address to be able to type commands from my phone from anywhere, and it works, too! Now I can leave town for a couple of days and I don’t have to worry about the server crashing and staying down because I can access everything via ssh.
This is a cool setup for ngrok to be started automatically on boot like the minecraft server by the way – for anyone who stumbles across these comments in the future.
Hey Leon,
That’s fantastic, I’m glad you got it working! Thanks for sharing the ngrok setup as well, that will indeed be helpful as I know static IPs and even real IPv4 addresses are getting extremely hard to come by and this is going to continue to be a bigger and bigger problem.
Cheers and take care!
Hey James,
Sorry if i comment to much i just really admire your work!
I wonder if i can create any custom commands for my server.
I want to have a command that is kind of like ifttt If-This-Then-That. Its supposed to be /meme_fly and /meme_run etc.etc.
And the commands are supposed to apply potion effects like levitation and speed 1000.
If this is possible
Thanks,
Oscar
And i have also have problems with Phantoms Drowneds etc etc not spawning :(.
Can you help?
With best regards,
Oscar
Hey Oscar,
Do you mean using commands? Try this one to spawn a phantom:
/summon phantom ~ ~1 ~
and then a drowned is pretty similar:
/summon drowned ~ ~1 ~
It’s pretty easy to do on the custom commands page here.
If that’s not what you meant then give me a little bit more detail about what you’re seeing/not seeing with the spawns (which ones are working, if everything else is working normally, if you’ve tried with a fresh server, etc.) and I can definitely help!
Hey James,
I can spawn the mobs with commands,
But they don’t spawn naturally “for some reason”
Thanks,
Oscar.
Hey
I have a fresh server i live by an ocean, But I cant find any drowneds.
All the mobs i know don’t exist drowneds and phantoms (Idk any more mobs)
But thanks for all the help so far,
Oscar
That is a funny problem, they’re usually quite difficult to get to not spawn!
The only way I know of to get them to not spawn is with game rules so I am wondering if something changed yours or they aren’t set to vanilla rules. Let’s try:
/gamerule doInsomnia true
This tells the game to enable the “insomnia” mechanic which spawns the phantoms if you haven’t slept for however many days (can’t remember off the top of my head).
I would definitely also try creating a blank server as a test and see which of these problems go away. Most of this stuff is controlled by settings that are stored across various files and even in the server database files themselves (which you can open with a NBT editor and see/edit the properties with). This can help narrow things down at least.
You can also try raising the monster limits in the bukkit.yml configuration file. I’ve found references to people talking about this in Bukkit/Spigot/Paper Minecraft servers (they’re all closely related). I’ve seen this problem before and it’s not really anything to do with the specific monsters as much as it is to do with these global caps. With a global cap of 70 monsters (or whatever yours is set at in bukkit.yml) the 70 slots usually get chewed up by zombies and spiders. A lot of the time they’ll even be underneath you in a tunnel and will just use up some of the monster count. This can make the more interesting/rare spawns seem like they never show up since all the slots are taken.
I’d try giving editing those monster spawn-limits in bukkit.yml a try with some adjustments (restart the server after changing the bukkit.yml file). You’re looking for the spawn-limits section and you can adjust any of those numbers (some of monsters/animals/npcs are classified in ways one wouldn’t necessarily expect). Also take a backup of the files before changing just in case things get strange. Let me know what you find!
Thanks,
I will try it, But i really dont want to restart my server bc I have restarted it 3 times already! But I will test it when I get home!
I will update you in about 3-5 hours
Oscar.
Thanks,
Whats the name of the site?
And what can/should i do of some mobs not spawning?
Can I like check in the source code if the mobs “exist”?
Best regards,
Oscar.
Hey Oscar,
Sorry, I edited the comment not realizing you would see it already. I misread your comment originally. You will actually want a plugin to do what you want but it’s pretty straightforward! Check out my edited reply for some links etc.
Lol im a swede i dont live in some us time zone
Thanks
il check the links
Oscar
Hey Oscar,
Thanks so much for the kind words!
I believe for custom commands like that you will need to use a plugin. That is not a problem since the server is compatible with plugins. Here’s an example of one that looks like it would work.
That was recently updated April 17th 2021 so it looks like it’s being actively maintained and should let you do what you want! I’m sure there are dozens of other ones that would work but I think you will want to look toward a plugin for this!
Thanks i looked for plugins first but i didnt know how to work them, I found a tutorial at the bottom of the page so I’m good
Thanks
Oscar.
Hey james i have a question… I love the script and im very happy with choosing your script. But i wonder how do i delete My current world and start a completley new one. If you can help please give me a very explained answer.
With best redards
Oscar:
Hey Oscar,
There’s a couple different ways to do it. If you want to wipe out everything including inventories etc. then you can just stop the server and then delete the entire ~/minecraft folder and install again and you will have a fresh instance! The minecraft folder is located in your “home” folder which is usually something like /home/pi/minecraft.
If you want to keep the existing characters/inventories on the server and just reset the world then stop the server and go to your ~/minecraft folder. Look for a folder called “world” and rename it to something like “world_old” temporarily. Now restart the server and it should regenerate a clean map!
Thanks so much for the help i found a comment lower down in the section, i was scared first so i commented this, but then found out it was easy so i did it and it worked! But anyway thanks so much for the reply, with this quick off a reply it shows that you really care about your clients! You are doing great work that i and many others appreciate. Keep up that great work, You replyed so quick, You really care about us!
With the BEST regards,
Oscar.
MARCH 20, 2021 AT 1:49 AM
First, thank you for your aswesome Support.
But I have a problem: my home directory is at a SD-Card while the server is on a SSD (/mnt/mc/HERE). I already have changed the location of the java paperclip command (the cmd which runs the paperclip) but I dont know how to place the updated paperclip.jar in the right folder. And the server keeps crashing…
I hope you unsterstand what I’m trying to say.
Paul
Hey Paul,
You could probably honestly just do a Find and Replace for the ~ symbol in the different scripts and change it to /mnt/mmc/here. The ~ just means home directory.
All the files will need to be together. Your whole “minecraft” folder needs to be with the server since it depends on pretty much all the files in there and will crash otherwise. If the server is crashing that wouldn’t be script related (it won’t start at all if your scripts are broken). It likely can’t find what it needs.
You’d need to do every single file to set a custom directory and use the find and replace function of your text editor and replace ~ with your SD card’s folder. Maybe even SetupMinecraft.sh itself as well as start.sh, stop.sh, restart.sh, etc. so it sets it up to go to the right folder. People have done it before though so if this is the configuration you need to use then we can definitely get it working!
I wouldn’t worry about moving paperclip or anything else. The script will download and update that for you. You just need to point it to the right folder. If you don’t want to use your home folder replace all ~ with your custom folder and let me know how it goes!
I have installed your script on a raspberry PI4 8GB and the server is all working however it crashes every 10 to 15 mins due to a Java memory shortage
There is insufficient memory for the Java Runtime Environment to continue.
# Native memory allocation (malloc) failed to allocate 131080 bytes for Chunk::
I have checked the start script and its set to allocate the max memory
screen -dmS minecraft java -jar -Xms400M -Xmx2700M /home/pi/minecraft/paperclip.jar
Would anyone have any ideas on what else i could check.
Michael
Hey Michael,
Turn it down. You have it too high! There’s not enough memory for the other processes on your Pi.
I’ve never seen someone have a memory crash from not having enough memory since like the Raspberry Pi 1 where we made it work on incredibly tiny amounts of memory. It’s always too much and not enough for everything else.
The recommended usage is too high. I just updated the script to add 200MB of breathing room so I would try with the latest update or you can set yours to 2500 or maybe lower and it will stop crashing but that should get you taken care of!
Thanks for the info and ill give it a try and report back.
Michael
Hi James ps. sorry if this is my second comment couldn’t find my last reply
first i just wan’t to say damn good work i really appriciate the work you’ve put into this! impressive.
background info:
raspberry pi 4 4gb model running raspbian with DE(desktop enviroment), allocated 2700mb(recomended) ram to the server, scored over 1000 in micro sd card test.
so i’ve run this server for a little week now and i’ve noticed a problem: i ran the server where me and two of my friends joined and it worked really stunning, but however the server crashed because of a memory error it did gave me a hs log file and sometimes it gives a crashreport aswell. I later tried debugging to find out when and why it happened, so i fired up ‘htop’ a command line tool which monitors memory usage and ran the server (please check background info to see what im running the server on). when i ran the server and connected the htop tool reported that i was using 730mb ram, i stayed in the spawn for the chuncks to load proberly and then began to ‘stress’ the server. I switched to creative and began flying around to force load chunks and i could se that htop was reporting an increase of ram to about 790mb where it crashed. the wierd thing is that htop reported that there was a little over 2.8gb of free ram. and the server still crashed because of a memory error. what should i do? run raspbian lite? decrease the server ram?
really hope you have any idea of what i should do. i can send you the crashreports aswell as the other log files (hs, replay) if that would help, please ask any questions, thanks!:)
Hey Benjamin,
No worries about the other replies, I was able to see the right one!
I think you’re really close. I definitely think you do need to decrease the memory slightly. The type of memory crash you’re describing sounds like we need to try reducing the memory usage first.
I think I may need to lower the recommended memory because you are not the first one who has gone with the default and ended up with too much allocated (or another way to say it is too little memory left for everything else to run, so the OS kills the server to prevent from crashing).
Before we try anything else try running SetupMinecraft.sh again and try setting the memory limit to something like 2300 or maybe even 2000 just for a test. Then what you want to do is get on it and fly around exactly the same way. If it’s still having issues we can definitely examine some log files as well!
it works so much better now did a whole tnt test and it didn’t crash at all thank you!
would you recomend using a 64 bit os for the pi 4 4gb model, and will i then be able to use more ram?
Hey Benjamin,
You actually can use more RAM if it’s available using the 64 bit version!
I’d say it’s definitely more worth it if you have something like the 8 GB Pi but I have had other people tell me here in the comments in the past that they did take their 4GB to 64 bit and were able to allocate more than 2700 without crashing! You have to disable almost every system process though and definitely use a “lite” or “server” distro that has pretty much nothing running. It does remove that limit since that’s a 32 bit thing and you can allocate more than 2700 MB if it’s available.
I’d give it a try in the current configuration and see if you’re experiencing any problems. If you have a lot of people playing or are experiencing lag then it may be worth the trouble! The thing to watch out for though is that 64 bit won’t make a difference if all the resources are already being used up and there’s nothing free available extra to use. Hopefully that helps!
hi james thanks for the replies!
i did a pretty stupid thing i was trying to make a new save by moving the world/ worl_nether/ world_the_end/ to a folder called other_saves. But i already had a world in the “other_saves” folder so i tried removing them before moving my current world to the folder… but i thought i changed directory to the “other_saves” folder and ran ‘rm -rf *’ but i realised i typed:
ls other_saves
rm -rf *
and i thought i was in that directory , but i ended up removing the entire minecraft folder aswell as the backups. are there any other backup locations or any way of redoing ‘rm -rf *’ ? damn if i just took 1 second to think before just deleting..
Hey Benjamin,
So I have actually done this before too believe it or not! It’s actually incredibly easy to do so I wouldn’t be too hard on yourself.
Linux doesn’t really have a recycle bin for the console commands unfortunately. It is possible to recover from a rm -rf but for the best chance of success you pretty much have to disconnect/remove the drive/SD card immediately and not write anything further to it (at all preferably) until you can attempt a recovery. This is because once the files are deleted that space is marked available as “free” space so the next time your drive tries to write something that space is fair game to start writing new stuff to. Typically for a Minecraft server your files will be scattered all over the available space as they aren’t all created at once. As your map expands totally new files are created and other stuff from your OS/activities will have filled the gaps in the mean time since the last files were written.
One command is ‘extundelete’ but it usually isn’t installed by default and can be installed with apt-get install extundelete (but don’t do this on the drive with the files deleted preferably). Normally you would want to put the drive into a different computer and install extdelete on that one (so you don’t have apt overwrite the files you are trying to recover since they are marked as free space). Check out this article for some more background on this if you want to attempt this as well as some other utilities (check the second to last reply in the thread) that can help.
I did not successfully recover my server when I accidentally removed my whole minecraft folder as there was pretty much nothing else on the Pi except for the server and the files were almost immediately overwritten by logs and other system utilities damaging some of them. Fortunately I did have a backup from a few weeks earlier but tons and tons was lost. I’ve tried to think of ways to deal with this in the script but haven’t had a clear answer. Maybe in the home directory the backups could be placed into something like mcbackups? I’m not sure how to totally prevent it but I myself have done it!
Hopefully all that helps and best of luck, you may yet succeed where I failed if the files happened to be at the end of the drive or something and nothing has been overwritten on the disk yet!
Thank you so much for the replies, apriciate it alot!
I think i would maybe set a crontab to move the bsckups to another folder, or possibly maybe change the scripts path to outside the mc folder
Thanks again!
Hi James,
Is there available raspberry pi OS 64bit? I have 8gb Pi and I searched the official web and there is available only beta version of 64bit OS. And also many users are complainig about lots of bugs.
Thanks for headsup with too much RAM. I’m facing a lot of crashing. I will try to adjust as you mentioned in previous comment, thanks for that!
Lukas
Hey Lukas,
Great question! It used to be in the rpi-imager tool but last time I checked it was no longer in there.
Not to worry, I have the link for you here.
The last time they updated the image was August of 2020 but it definitely still works. Just make sure you do a:
sudo apt update
sudo apt dist-upgrade -y
and it will get you all up to date!
Hey,
it’s me again to troubleshoot my problems (mentioned in an earlier post) i wanted to install multiple servers in differnt directories. (Don’t wanted to run multiple at the same time.) But then I noticed the path problems, this is creating. Could you please help me with this? (maybe contact me trough email?)
Thanks
Paul
Hey Paul,
Welcome back!
There’s a few different ways to deal with this. Some people have opened the start.sh script and changed the paths for just those folders. This is really common when people actually do want to run multiple servers.
In your case there is an easier solution. The way I like to do it is to just have a separate “minecraft” folder for each server and rename the entire thing. For example in your home directory you have the “minecraft” folder by default.
If you wanted to switch servers you would stop the server completely first and then rename the “minecraft” folder to something like “survivalserver” or something that describes the server you were previously running. Now you would rename a different minecraft folder you already have, like “newfortserver” back to the default “minecraft” folder name.
This leaves all startup services intact and all folder paths across every one of your servers exactly what they should be without having to fight with editing any files or really complex solutions. You can basically just “drop” a new server in after stopping it and then starting it back up!
This prevents you from having to mess with the /etc/system/system services which is likely the problem you are running into. You can sidestep all of that by just stopping the server and renaming the whole “minecraft” folder and then swapping a new one in. Hopefully that helps!
First, thank you for your aswesome Support.
But I have a problem: my home directory is at a SD-Card while the server is on a SSD (/mnt/mc/HERE). I already have changed the location of the java paperclip command (the cmd which runs the paperclip) but I dont know how to place the updated paperclip.jar in the right folder.
I hope you unsterstand what I’m trying to say.
Paul