Getting Started
Current state
Section titled “Current state”Veyl is an experimental pre-alpha prototype rather than a playable engine. The engine README documents running its current native graphics application with Cargo.
Prerequisites
Section titled “Prerequisites”- A current stable Rust toolchain, including Cargo.
- A development environment capable of building native Rust applications.
- A graphics-capable system and drivers for attempting to run the prototype.
The project has not yet published a complete platform-by-platform hardware or graphics-backend requirements list. Runtime graphics support has only been verified on the development Mac described in the engine README.
Build and run
Section titled “Build and run”From the root of a checkout of the Veyl engine repository:
cargo runThe repository README documents this command. It also records a workaround for one specific setup: Intel Iris Pro graphics on macOS 15. That setup uses a vendored wgpu-hal patch and WGPU_VALIDATION_INDIRECT_CALL=0; these are machine-specific compatibility workarounds, not general installation steps. Review the engine README before using that configuration.
Repository structure
Section titled “Repository structure”The project is a Cargo binary application. Its internal module boundaries and file layout are evolving, so this documentation does not prescribe a stable crate or source-tree structure. The repository README mentions a vendored wgpu-hal patch for the specific Intel Metal compatibility case described above.
Inspect the checked-out repository and its Cargo.toml for the current source layout rather than relying on a fixed directory map.
Controls
Section titled “Controls”The engine README currently documents:
- W / A / S / D to move horizontally.
- Space / Left Shift to move up or down.
- Hold the right mouse button and move the mouse to look around.
- Escape to quit.
Movement speed is fixed. Pointer capture, collision, and gravity are not currently implemented.