WIP Minecraft clone project
 
 
 
 
Go to file
BodgeMaster 845b3fb922 Documentation: update build system documentation and prerequisites in preparation for next commit 2022-07-30 21:08:03 +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
doc Documentation: update build system documentation and prerequisites in preparation for next commit 2022-07-30 21:08:03 +02:00
include Build system: add a central directory to collect all the include files 2022-07-20 12:15:31 +02:00
resources Documentation: add detailed build system documentation, add documentation for some files in resources 2022-07-06 13:33:10 +02:00
scripts Build system: Use -Wextra 2022-07-23 10:54:05 +02:00
src lib/nbt.cpp: Implement writeString function 2022-07-28 17:15:04 +05:30
.gitignore Build system: cache downloaded files 2022-07-20 15:52:04 +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
Makefile Switched spaces for tabs in the makefile so it works 2022-06-28 22:33:19 -04:00
README.md Documentation: update build system documentation and prerequisites in preparation for next commit 2022-07-30 21:08:03 +02:00
code_style.md comply with code style guidelines, also minor fix to them 2022-06-28 14:25:32 +02:00
copyright_notice_template Add license and copyright notices 2022-06-27 11:46:13 +02:00
setupenv.bashrc environment: allow for local customizations using a hidden file 2022-07-19 01:19:17 +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:

Build dependencies:

  • bash
  • a C++ 20 compiler

Setup dependencies:

  • wget or curl
  • gzip
  • sha256sum (or NetBSD's sha256, hashalot's sha256 will not work)
  • tar
  • a C compiler (for sockpp)
  • CMake (for sockpp)

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 (local customizations to the environment can be placed in a fiile .localenv.bashrc in the project's root directory if necessary)
    • 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 (and build if applicable) the following dependenceis:

Building

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

For more details, have a look at the build system documentation.

See the file COPYING for copyright information.