Veil is a self-hosted cloud gaming platform that enables you to stream games and applications from your server to a web browser. It uses WebRTC for low-latency streaming and a custom Wayland compositor to capture and transmit graphical output.

The recommended way to set up the development environment is using Dev Containers. This ensures all dependencies are correctly installed and configured, regardless of your local environment.

1. Install the prerequisites:
   • Docker
   • Dev Container CLI (https://github.com/devcontainers/cli)
2. Clone the repository

   git clone https://github.com/yourusername/veil.git
   cd veil
       

3. Start the dev container:

   devcontainer up --workspace-folder .
       

4. Enter the container:

   devcontainer exec --workspace-folder . /bin/zsh
       

If you have an NVIDIA GPU and wish to use it for hardware acceleration:

• Ensure the NVIDIA Container Toolkit is installed on your host
• The default configuration enables NVIDIA GPU passthrough when available

If you prefer not to use Dev Containers, you’ll need to install:

• Node.js (v18+)
• Rust (latest stable)
• pnpm (v9+)
• Buf CLI
• Protocol Buffer compiler

1. Install dependencies

   pnpm install
       

2. Start development environment

   pnpm dev