Skip to content

CubicMC/cubic-parsing

Repository files navigation

Cubic Parser/Serializer

The parser/serializer used for serialization/parsing inside the cubic projects group

Status

This has been started, but is not fully tested yet. soon:tm:

Goals

Centralize the different function and classes related to parsing/serialization into a single project

Running

Precompiled binaries are not currently available.

See Building section to know how to compile the library.

Building

Currently only Linux x86_64 is targeted, it might build on another system but it isn't guaranted for now (Windows, FreeBSD and OpenBSD will be supported later down the road, but not until we have a solid codebase.)

Dependencies

Here is the list of dependencies required to build CubicNBT:

  • gcc7* (Any c++17 compliant compiler should work but it is not guarranted as we do not code strictly to the standard)
  • gnumake (Build system, other make versions might work but have not been tested)

* gcc7 is the lowest version that should work with this codebase but it has not been tested yet, a higher compiler version will always be recommended for optimization reasons. See the gcc c++17 feature matrix here.

How to build

Build from source on your machine

To build follow those steps :

git clone https://github.com/CubicMC/cubic-parser
cd cubic-parser
# The minecraft version to build for
# This is not useful for the parser and will surely be removed down the road
export MC_VERSION=1.21
# Currently doesn't work as the project hasn't been started yet
make -j `nproc --exclude 1` # The -j option is here to speed-up the compilation

TODO for this README

  • Testing
  • Lib deps
  • Build system explaination

Contributing

Any contributions are welcome, if you don't know what to do you can take a look at our issues tab and start talking in one of them to contribute :D.

About

Parser/Serializer library used by the cubic projects

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published