Plasma

The Cyan Worlds Engine

Building

Currently, the complete game client can only be built for Windows, using Visual Studio.

By default these steps will compile a client targeting your machine architecture. It is possible to build a 64-bit game client, but only the 32-bit (x86) client is officially supported.

Library Dependencies

Plasma requires a number of third-party libraries as dependencies. All required libraries are available through the vcpkg package manager and can be downloaded as part of the build process, or can be built using their individual build instructions.

Expand to view the complete list of libraries

Plasma currently requires the following third-party libraries:

The following libraries are optional:

Building on Windows

Compiling on Windows requires Visual Studio. We recommend Visual Studio 2019 Community Edition, which is available as a free download. Install the “Desktop development with C++” workload.

  1. Clone the repository from GitHub, including all submodules, using a git client. On the command line, this can be done by executing the following:
    git clone --recurse-submodules https://github.com/H-uru/Plasma.git

    Note: We recommend using Git for Windows. Using the git program provided by Cygwin will not set permissions properly on some files and result in build failures.

    Note: Some dependencies may fail to build if the path to the code contains spaces.

  2. Launch Visual Studio.

  3. Select Open a local folder and choose the folder where you cloned the repository.

  4. Compile the project by using Build > Install Plasma. All required dependencies will automatically be downloaded from vcpkg as part of the build process.

    Building a 32-bit client on a 64-bit system
    1. Wait for Visual Studio to finish preparing the workspace.
      Look for a line that says “CMake generation finished” in the Output window.

    2. Open the CMake Settings (Project > CMake Settings for Plasma).

    3. Click the green + button to add a new configuration.

    4. Select “x86-Release” from the popup window.

    5. Save the CMake settings, using Ctrl+S or the Save button in the toolbar.

    6. In the dropdown menu in the toolbar, select the new “x86-Release” configuration.

    7. Compile the project by using Build > Install Plasma.

  5. The client will be built and installed into a subfolder of where you cloned the repo.

    32-bit Debug:
    out\install\x86-Debug\client
    32-bit Release:
    out\install\x86-Release\client
    64-bit Debug:
    out\install\x64-Debug\client
    64-bit Release:
    out\install\x64-Release\client

    The client output folder will be referred to as your “MOUL-OS” folder in the instructions on Running Plasma.

Building on macOS & Linux

Linux and macOS are not officially supported targets, and the game client does not compile. However, several of the tools can be built and run.

You will need to ensure all the required dependencies are available. You may be able to use vcpkg on these platforms, but it has not been extensively tested.

  1. Clone the repository from GitHub, including all submodules, using a git client. On the command line, this can be done by executing the following:
    git clone --recurse-submodules https://github.com/H-uru/Plasma.git

  2. In the folder where you cloned the repository, run CMake to create a build folder:
    cmake --builddir build -S .

    If you want to use vcpkg to automatically build dependencies, enable the USE_VCPKG option:
    cmake -D USE_VCPKG=ON --builddir build -S .

  3. Compile the project with the following command:
    cmake --builddir build --config RelWithDebInfo

  4. Install the resulting tools with the following command:
    cmake --install build --config RelWithDebInfo

  5. The tools will be built and installed into the build/install/tools subfolder of where you cloned the repo.