Skip to content
JonCastawayPublic

About

The Blockheads Server for Linux and MacOS

Topics

Resources

Security policy

Stars

12 stars

Watchers

2 watching

Forks

Latest commit

ย 

History

290 Commits

Folders and files

NameName
Last commit message
Last commit date
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

โ›๏ธ The Blockheads Game Server Script

A script for the self-hosted multiplayer server for The Blockheads

Contributors Forks Stargazers Issues

macOS Debian Ubuntu Arch Linux Pop!_OS Trisquel Linux Mint Zorin OS elementary OS Kali Linux Tails MX Linux Devuan BunsenLabs

Warning

Running curl | bash scripts from the internet can be risky. Always review the script before executing it.

๐Ÿ“– Table of Contents

๐Ÿš€ Getting Started

โœ… Requirements

Before installing, make sure your system has:

  • A Linux distribution or macOS installation
  • A terminal with bash available
  • curl installed for downloading the server files
  • nano, or another text editor, for editing configuration files
  • An internet connection for the initial download
  • A free TCP port for the Blockheads server
  • Enough disk space for the server binary, world data, and backups

On Debian, Ubuntu, Linux Mint, Pop!_OS, and similar systems, install the basic tools with:

sudo apt update
sudo apt install -y curl nano

On Arch Linux and derivatives:

sudo pacman -S --needed curl nano

On Fedora:

sudo dnf install -y curl nano

Note

The exact package manager and package names can vary between distributions.

โšก Quick Start

Follow the instructions below to install and set up the Blockheads server on your system.

Download and inspect the server script

Rather than piping a remote script directly into bash, download it first and review it:

curl -sL [https://raw.githubusercontent.com/JonCastaway/BHS/main/start.sh](https://raw.githubusercontent.com/JonCastaway/BHS/main/start.sh) -o start.sh

Review the script before running it:

less start.sh

If you are happy with it, run:

bash start.sh

Important

Only run scripts you understand. If the script changes unexpectedly, stop and review the diff before running it again.

Create your server

./blockheads_server171 -n MyFirstServer

View available options

./blockheads_server171 -h

Configure your server

You will need to replace WORLD_ID and PORT inside the run.sh script.

nano run.sh

Replace the placeholders with your WORLD_ID and PORT.

To find your WORLD_ID, run:

./blockheads_server171 -l

Save and exit nano by pressing CTRL+X, then Y, then ENTER.

Start the server in the background

nohup ./start.sh &>/dev/null &

๐ŸŽ Installation | macOS

Download the Blockheads Server App from the App Store:

๐Ÿ“ฆ Original Server Binaries | Manual Install

You can download the original server binaries from the links below:

After downloading, extract the archive:

tar -xzf blockheads_server171.tar.gz

Then follow the Linux configuration instructions above.

๐Ÿค– The Blockheads | Android APK

If version 1.76 does not launch, try an earlier version such as 1.75 or 1.74.

๐Ÿ› ๏ธ 5. Server Management

Check whether the server is running

pgrep -af blockheads_server171

View running server processes

ps aux | grep -i blockheads

Stop the server

Find the process ID:

pgrep -af blockheads_server171

Then stop it, replacing PID with the process ID shown:

kill PID

If it does not stop cleanly:

kill -TERM PID

Caution

Avoid using kill -9 unless the server will not terminate normally, as it prevents a clean shutdown.

View server output

If you started the server with output redirected to a log file, view it with:

tail -f server.log

If you used the command exactly as shown earlier, output was discarded:

nohup ./start.sh &>/dev/null &

To keep logs instead, start it like this:

nohup ./start.sh > server.log 2>&1 &

Then view live logs with:

tail -f server.log

Back up your world

Before updating or making major configuration changes, stop the server and copy the server directory:

cp -a /path/to/blockheads-server /path/to/backups/blockheads-server-$(date +%Y-%m-%d)

Tip

Store backups outside the live server directory, ideally on another disk or remote storage location.

๐Ÿณ Docker

Docker support is currently in testing.

Once available, this section will include:

  • A Dockerfile
  • A docker-compose.yml example
  • Volume mappings for world data and configuration
  • Port mappings
  • Container update and backup guidance

๐Ÿ—บ๏ธ Roadmap

        ๐Ÿšง ROADMAP ๐Ÿšง
 โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”
 โ”‚ โœ… Current Active Servers      โ”‚
 โ”‚ ๐ŸŒ World Configuration Editor  โ”‚
 โ”‚ ๐Ÿ–ฅ๏ธ Web-based User Interface    โ”‚
 โ”‚ ๐Ÿณ Docker File                 โ”‚
 โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜

Explore our progress towards significant milestones, and read the wiki roadmap.

  • Current Active Servers โ€” in test
  • World Configuration Editor
  • Web-based User Interface
  • Docker file โ€” in test

Review the open issues for suggested features and known issues.

๐Ÿค Contributing

   โ•ญโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ
   โ”‚  ๐ŸŽ‰ Contributions welcome!  โ”‚
   โ”‚   Fork โ†’ Change โ†’ PR ๐Ÿ’ช     โ”‚
   โ•ฐโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฏ

Contributions are welcome. Feel free to fork this repository and submit pull requests.

๐Ÿ‘ฅ Contributors

Contributors

๐Ÿ“œ License

This project is licensed under the GPL-3.0 License.

See the License file for details.

๐Ÿ“ฌ Contact

  ๐Ÿ“ฎ Questions?  ๐Ÿ› Problems?  ๐Ÿ’ก Ideas?
       โ””โ”€โ”€โ”€โ”€ Open a GitHub issue โ”€โ”€โ”€โ”€โ”˜

For questions or support, please open an issue on GitHub.

๐Ÿ™ Acknowledgments

Projects we are inspired by and have obtained valuable information from:

About

The Blockheads Server for Linux and MacOS

Topics

Resources

Security policy

Stars

12 stars

Watchers

2 watching

Forks

Releases

Sponsor this project

Used by

Contributors

Languages