Giter Site home page Giter Site logo

codacy-badger / balena-minecraft-server Goto Github PK

View Code? Open in Web Editor NEW

This project forked from alexprogrammerde/balena-minecraft-server

0.0 0.0 0.0 41.45 MB

Build a Minecraft Server using a Raspberry Pi 4! Supports common Servers, SCP and Wifi Connect.

License: Apache License 2.0

Shell 100.00%

balena-minecraft-server's Introduction

Balena Server Logo

A Minecraft server for the Raspberry Pi 4 CodeFactor

Starter project enabling you a Minecraft Server using just a Raspberry Pi.

This project has been tested on and Raspberry Pi 4 B 4GB. We do not recommend using a Raspberry Pi 3 or deeper. They have not enough RAM and power to calculate all the things. ๐Ÿ’ฅ

Why balenaMinecraftServer?

  • It works out of the box, just start it and it just works. ๐Ÿ‘
  • You can play anywhere. You can take the Pi to a friend, connect to his Wifi and enjoy playing. ๐ŸŽฎ
  • It is free. No costs, no big server and no complication. ๐Ÿ†“
  • Why hosting on a computer? A Pi is power efficient! ๐Ÿš€
  • You can easy maintain the files on the Pi by using your PC. ๐Ÿ’ป

Hardware required

  • Raspberry Pi 4B (The best is 4GB. 1GB is not enough.) ๐ŸŽ‰
  • Micro SD Card (we recommend 8GB Sandisk Extreme Pro) ๐Ÿ’พ
  • Power supply ๐Ÿ”Œ

Software required

Setup and use ๐ŸŒ 

To run this project is as simple as deploying it to a balenaCloud application; no additional configuration is required.

Setup the Raspberry Pi ๐Ÿ’ฟ

  • Sign up for or login to the balenaCloud dashboard
  • Create an application, selecting the correct device type for your Raspberry Pi
  • Add a device to the application, enabling you to download the OS
  • Flash the downloaded OS to your SD card with balenaEtcher
  • Power up the Pi and check it's online in the dashboard

Deploy this application โœˆ๏ธ

  • Install the balena CLI tools
  • Login with balena login
  • Download this project and from the project directory run balena push <appName> where <appName> is the name you gave your balenaCloud application in the first step.

Connect to the server ๐Ÿ“ก

You can see in the Dashboard a IP-adress and a UUID. They are the adress the from your server. One example:

IP-Adress

In my case is it 192.168.178.35or 463e101. You can connect to it like that:

NOTE: Please donยดt use the copy option of the UUID. If i copy i get 463e101d32c154b6d68e8ddac6eca552. Thats wrong. Copy the short part 463e101.

Server-IP

Now you are the one with a balenaServer ๐Ÿ˜Ž:

NOTE: This works only in the connected Wifi. If you want to play worldwide click here: https://github.com/AlexProgrammerDE/balena-server/blob/master/README.md#play-worldwide-optional-earth_americas

Minecraft Screenshot

Connect to the terminal ๐Ÿ“ก

The server has no console input option in the cloud dashboard, so you need RCON. The port is 25575 and the password is balenaserver. It is a protocol for connecting to the server. There are many clients, but you can pick one here:

NOTE: You will need for starting this script this batchfile if you are using windows (Just paste it in the unzipped directory.): https://github.com/AlexProgrammerDE/RCON-Script/blob/master/launch.bat

Connect to the file-directory ๐Ÿ“ก

You can connect to the server and change your serverfiles. I recommend using a Tool like WinSCP. The IP is the one above, the protocoll SCP, the port 22, the username root and the password is balenaserver. The files are in the root directory folder serverfiles.

NOTE: You can also change your scp password by setting the SCP_PASSWORD enviroment variable.

Connect to another Wifi ๐Ÿ“ก

balenaMinecraftServer has wifi-connect integrated. You can use it for taking the Pi everywhere. If you want to read more is here the link to the programm: https://github.com/balena-io/wifi-connect (There is explained how it works.)

Double RAM (optional) ๐Ÿ”—

Devices like the Raspberry Pi 4B 4GB have enough RAM to run the server with 2GB RAM(at defaulf 1GB). If you set DOUBLE_RAM to true will be the double of RAM used.

Add plugins (optional) ๐Ÿ”ง

balenaMinecraftServer also supports plugins. Just drop the in the plugins folder using SCP. The current Minecraft version is 1.15. You can get your plugins from there(Other work too.):

NOTE: Before adding the plugin and getting an error look if the plugin supports 1.15.

Custom Server (optional) ๐Ÿ‘“

You can also add with the scp feature new servers. You want something different, but donยดt know where to start? Here are some servers listed:

Not satisfied:expressionless:? There are many tutorials, just google it. If you need help can you ask in an issue, but first google it. balenaServer uses Paper. It is a efficient and powerfull server. It is compatible with spigot and bukkit plugins.

Play worldwide (optional) ๐ŸŒŽ

You are maybe asking yourself how this works. Here is a little explanation:

NO-IP Picture

You need first to create a No-IP account. Then you need to create a hostname (It is no matter what.). Then you need to Port Forward the Port 25565 on your Pi (UDP and TCP). The devicename is what is in your UUID field. After this you need to Log in to NO-IP in your Router (Somewhere at Dynamic DNS). At least you need to paste the internet adress your router is saying you(NOT something like 192.168.178.xx) in the NO-IP dashoard. Youre done. ๐Ÿ‘

Here is also a link to a guide: https://www.noip.com/support/knowledgebase/getting-started-with-no-ip-com/ (Skip the DUC part please. You need to write in the dashboard the Internet IP your router is giving you.)

This project is in active development so if you have any feature requests or issues please submit them here on GitHub. PRs are welcome, too. :octocat:

Here is a little server demo ๐Ÿ‘‘:

Server Demo

balena-minecraft-server's People

Contributors

alexprogrammerde avatar chrisys avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.