WIP Minecraft clone project
 
 
 
 
Go to file
BodgeMaster 6d6b0dae5a add warranty disclaimer 2022-06-27 14:22:16 +02:00
bin add placeholder files because Git doesn't handle empty folders 2022-06-24 06:42:19 +02:00
dependencies prepare for handling dependencies 2022-06-27 06:40:43 +02:00
scripts minor rewording of an error message 2022-06-27 13:06:09 +02:00
src Add license and copyright notices 2022-06-27 11:46:13 +02:00
test add manually decoded servers.dat 2022-06-25 13:09:11 +02:00
.gitignore prepare for handling dependencies 2022-06-27 06:40:43 +02:00
COPYING add warranty disclaimer 2022-06-27 14:22:16 +02:00
LICENSE.md Add license and copyright notices 2022-06-27 11:46:13 +02:00
README.md formatting 2022-06-27 11:59:02 +02:00
code_style.md add verbosity to shell scripts 2022-06-27 13:07:47 +02:00
copyright_notice_template Add license and copyright notices 2022-06-27 11:46:13 +02:00
setupenv.bashrc Show a message when loading the provided shell environment 2022-06-27 11:47:36 +02:00

README.md

FOSS-VG (FOSS Voxel Generator)

This is a WIP Minecraft clone.

For now, we target feature parity with 1.18.2.

Immediate goals:

  • Networking library
    • build a dummy server that Minecraft clients can detect
    • get Minecraft to connect to the dummy server
  • Dummy server
    • send an empty void
    • send a surface to stand on
    • handle chat
  • NBT library
    • parse NBT
    • decode and encode data

Project Setup Instructions

Prerequisites:

This project requires bash and a C++20 compiler.

The project setup requires wget or curl, gzip, and tar.

For people using other shells than bash: You need to at least have bash installed to use the scripts, but using it as your shell while working on this project also allows you to use the provided aliases.

If you dont want to use bash as your shell, not even temporarily for this project, you can use the scripts by running them from the project's base directory and run any generated executables with LD_LIBRARY_PATH set to point to bin/lib.

Setup

  • git clone this repository
  • if using bash:
    • source the file setupenv.bashrc from the project's base directory to load the provided shell environment
    • setup_project
  • if not using bash or not using the provided environment:
    • cd to the project's base directory
    • scripts/setup_project.sh

This will download the following dependenceis:

Building

To build the project, just use the build alias or invoke the build.sh script from the project's base directory.

build and build.sh accept the environment variables CXX and CXXFLAGS. CXXFLAGS must at least specify the C++ version.

To clean out the build or dependency directories, use clean and clean_dependencies or their corresponding scripts respectively. setup_project will clean out both before doing its thing.

See the file COPYING for copyright information.