Installation

Platform-specific installation instructions

Ubuntu / Debian

terminal 
# Install dependencies
sudo apt update
sudo apt install -y cmake g++ vulkan-sdk

# Clone and build
git clone https://github.com/parallax-compiler/parallax-runtime.git
cd parallax-runtime
mkdir build && cd build
cmake .. -DCMAKE_BUILD_TYPE=Release
make -j$(nproc)
sudo make install

Arch Linux

terminal 
# Install dependencies
sudo pacman -S cmake gcc vulkan-headers vulkan-icd-loader

# Clone and build
git clone https://github.com/parallax-compiler/parallax-runtime.git
cd parallax-runtime
mkdir build && cd build
cmake .. -DCMAKE_BUILD_TYPE=Release
make -j$(nproc)
sudo make install

macOS

terminal 
# Install dependencies
brew install cmake molten-vk vulkan-loader

# Clone and build
git clone https://github.com/parallax-compiler/parallax-runtime.git
cd parallax-runtime
mkdir build && cd build
cmake .. -DCMAKE_BUILD_TYPE=Release
make -j$(sysctl -n hw.ncpu)
sudo make install

Windows

  1. Download and install Vulkan SDK
  2. Install Visual Studio 2022 with C++ tools
  3. Clone the repository
  4. Open CMake GUI and configure
  5. Build with Visual Studio

Verify Installation

terminal 
# Check if library is installed
ldconfig -p | grep parallax

# Run test
cd parallax-runtime/build/tests
./test_vulkan_backend