Building Coral

Coral is written in C++ 20, but should work with projects that are using C++17. However we don't officially support C++17, so any issues you encounter as a result of using C++17 will not be addressed.

Build System

Coral uses the Premake build system by default, and currently it's the only officially supported build system. These build instructions are written under the assumption that you use Premake as well.

Supported Compilers

Coral has been tested on these compilers:

• MSVC / CL (Visual Studio 2022)
• Clang 14+
• GCC 11.4+

Building

Windows

Building Coral as a standalone library is fairly simple.

1. Install the .NET SDK or install the ".NET desktop development" workload in the Visual Studio Installer if you're using that.
2. Clone the repository using this command: git clone https://github.com/StudioCherno/Coral
3. Start a terminal in the root folder of the repository
4. Run premake5 vs2022 to generate the Visual Studio solution (Coral currently only supports building using Visual Studio on Windows)
5. Open Coral.sln
6. Build Coral.Native and Coral.Managed

Linux

1. Install the .NET SDK through whatever package manager you're using.
2. Clone the repository using this command: git clone https://github.com/StudioCherno/Coral
3. Start a terminal in the root folder of the repository
4. Run Build.sh
5. Run make in the root of folder of the repository
6. Run dotnet build CoralManaged.sln in the root folder of the repository

NOTE: These instructions may change in the future! If you're struggling to build Coral in the future please refer back to this guide!