README.md

MineColab

Run Minecraft Server on Google Colab

🙉 First of all, what is google Colab?

As the official FAQ says, colaboratory, or “Colab” for short, is a product from Google Research. Colab allows anybody to write and execute arbitrary python code through the browser, and is especially well suited to machine learning, data analysis and education. More technically, Colab is a hosted Jupyter notebook service that requires no setup to use, while providing free access to computing resources including GPUs. In short, it is a vm provided for learning, running python code, machine learning or for general purpose.

💰 Is it really free to use?

Yes, Colab is free to use. But there are some points which, according to me one should keep in mind:

1. Though colab is a free service, it shouldn't be exploited indiscriminately or without any care. One should value that its a resource offered for no cost and can get depleted/restricted if the demand increases out of control.
2. If it isn't obvious, one shouldn't run mission-critical services (like large and important servers/databases/python programs) on it. Its resources are not guaranteed and not unlimited, and the usage limits sometimes fluctuate. Also, the notebook has a maximum runtime of 12 hours, after which, it should be manually restarted.
3. One should not try to spread it as wildfire (in my opinion), that there's a free service available to every living being out there. If such a sudden boom in user base happens, Google would be forced to close down the free tier of google colab, devoiding many hobbists of the free service. Keep it like a secret, telling it to only those who are worthy and know how to use it.

In the end, it is just my personal opinion and can be ignored safely. Just ask your heart whats right and whats wrong. Also, please try to use it as a once in a while resource and not 24x7 so that others can avail the free resources too.

📃 Instructions

1. Open the notebook in google colab.
2. Read through the notebook, most of the code is self explanatory. Run the cells which are useful for your use-case.
3. Run the first cell which runs the Minecraft server.
4. Now you have two options. You can either use ngrok or cloudflare's argo. Ngrok is easy to setup and doesn't requires anything to be installed by the clients but it can often be quite unreliable. Argo doesn't have such limitations but requires a bit more work.

• Ngrok: Change tunnel_service variable and follow the prompts.
• Cloudflare argo:
  1. After running the first cell,Your free tunnel has started! Visit it <tunnel_address> would be logged in the notebook console.
  2. Download Cloudflared client on all the client machines.
  3. Now on your local machine, launch the binary with ./cloudflared-linux-amd64 access tcp --hostname <tunnel_address> --url 127.0.0.1:25565
  4. Finally, connect to 127.0.0.1:2556 from your minecraft client.

⚡ So, how does it actually work?

As Google Colab is a VM running Ubuntu server as base OS, it can be easily used as a Minecraft server. Here are the steps which the notebook performs to setup the server:

1. Update the system's apt cache.
2. Install Openjdk-15 (Java) through apt-get.
3. Mount Google Drive to access the minecraft folder (Drive is used here to provide persistent storage).
4. Setup Argo Tunnel (Opening a tunnel at port 25565).
5. Change directory to the minecraft-server folder on google drive (I have here used "Minecraft-server" as the server folder in the root directory of my Google Drive.)
6. List/Print the file list on the screen to indicate succesful directory change.
7. Startup the Minecraft server (with optimized JVM parameters from Aikar's guide)

🐛 Found a bug?

Report report the bug by creating a new issue and use this helpful issue template.

Or suggest a new feature using this template.

👍 Tips

• Use RaiDrive to manage your server's files
• If something does not work, try using a VPN like windscribe before opening an issue.