Big Balls Roll

Dependencies

Linux: sudo apt install clang ninja-build libglew-dev libsndio-dev libflac-dev libspeex-dev libopus-dev libogg-dev libvorbis-dev libasound2-dev libvorbis-dev libxinerama-dev libxcursor-dev libxi-dev libxrandr-dev doxygen graphviz

Note: It is recommended that you download and install cmake from somewhere else other then apt as the cmake version is extremely dated. Click here for example.

Windows: vcpkg install libflac:x64-windows libogg:x64-windows libvorbis:x64-windows opus:x64-windows openal-soft:x64-windows doxygen graphviz Note: VCPKG is windows package manager, you can download it here. Please ensure you read how to use it. Also be aware, by default it will install x86 binaries over x64. You can change the default by adding a system enviroment variable like so VCPKG_DEFAULT_TRIPLET=x64-windows

macOS: brew install vorbis-tools opus-tools cmake ninja llvm --with-toolchain

Cloning

GIT LFS

Ensure you have GIT LFS installed.

git lfs install

First time cloning

git clone https://github.com/MajorArkwolf/BigBallsRoll.git
cd BigBallsRoll
git submodule update --init --recursive
git checkout develop

Building

From CLI (macOS & Linux)

From project root directory.

cmake -S . -B build -G Ninja
cd build
ninja

Windows:

* Open Visual Studio 2019 as Administrator (required to make symbolic links).
* In Visual Studio, select "Continue without code" near the bottom left.
* Select File -> Open -> Cmake and navigate to your project file.
* Select the root CMakeLists.txt file.

Contributing

Ensure your editor uses Unix line endings
- Use the Line Endings Unifier plugin for Visual Studio
- Here's the suggested configuration
Use clang-format to format your source code to the project standard
- Install a clang-format extension to your text editor:

License

This project is licensed under the MIT license. Please see the LICENSE file for details.

mhwdvs/BigBallsRoll