ezhangle / open-builder

Open source "Minecraft-like" game with multiplayer support.

Open Builder

Open source Minecraft-like voxel sandbox game with multiplayer support.

More information about the project can be fouund in the Open Builder Wiki

This was made mostly for a YouTube series which can be found here: Lets Code A Multiplayer Voxel Game

Screenshot

Game is in uh very early stages

Project Structure

A quick overview of the code and project structure can be found in the wiki artle:

Project Structure

Contributing

Please see main article here:

Contributing

Installing, Building and Running

Windows [Visual Studio]

Please use the links below:

Build With Visual Studio

Running the Unit Tests With Visual Studio

Linux

We offer an automated installer for a bunch of different Linux distributions including Debian, Arch/Manjaro and Fedora. It can be ran via

sudo bash scripts/install.sh

from the project root directory. If you are interested in the manual way of installation, check below instructions. To then finally run the application see Running below.

Manual Installation

Libraries

These are required for the project, and usually can be downloaded via your distributions

sudo apt install libsfml-dev libglm-dev

If not, then you can download them from the website:

SFML Download

GLM Download

Building

This project uses CMake to create the build files. You can install using your package manager eg

sudo apt install cmake

First clone the project and cd:

git clone https://github.com/Hopson97/open-builder.git
cd open-builder

To build, at the root of the project:

sh scripts/build.sh

Running

To run, at the root of the project:

sh scripts/run.sh               # Launches both client and server  
sh scripts/run.sh -server 8     # Launches server only, allowing upto 8 connections
sh scripts/run.sh -client xyz   # Launches client, with player name xyz

To build and run in release mode, simply add the release suffix:

sh scripts/build.sh release
sh scripts/run.sh release <args>

Unit Tests

The unit tests can be ran using

sh scripts/tests.sh

Similar Projects

This project was heavily influenced by the following projects:

Minetest

Another open source voxel sandbox game, one of the original ones. Also created using C++, and also has multiplayer support.

Website - GitHub

Terasolgy

Open source multiplayer voxel sandbox game created using Java like the original minecraft.

Website - GitHub

Craft

Minecraft clone created by Fogleman in C.

Website - GitHub

Special Thanks

D3PSI - Added GitHub actions, and created the install.sh file to automate the installation process on Linux systems

History

Originally, this was going to be a Zombie game, but I got very bored of that very quickly, and so changed the project to be a voxel game instead.

As a result of this, the code was created for the zombie game, so when I decided to switch over, the code got messy very quickly.

To combat this, I did a masive refactor in just over 2 weeks, re-creating the most the project.

The before refactor can be found here

The commit that adds the refactored code can be found here