Skip to main content

Installation

This guide provides clear, user-friendly instructions to help you install and integrate Varjus.

Building Varjus​

Follow these steps to build the Varjus API:

  1. Clone the project from GitHub:

    git clone https://github.com/kejjjjj/Varjus.git
    cd Varjus

  2. Run build.ps1 from the root directory using PowerShell:

    ./build.ps1

  3. Select Option 2 to build the API.

  4. Follow the on-screen instructions to complete the build process.

  5. If the build is successful, the output will be located in:

    Varjus/VarjusAPI/VarjusAPI

Note: If you prefer a custom build configuration, you can manually run CMake instead of using the script.

Integrating Varjus into Your Project​

To use Varjus in your project:

  1. Include the API headers

    • Add the VarjusAPI/include/ directory to your project's include paths.

  2. Link against the API library

    • Add VarjusAPI/lib/VarjusAPI to your project's library dependencies.

⚠ Important: Ensure your project's build settings (compiler, standard library, and flags) match those used to build the Varjus API to avoid compatibility issues.