id Software's Quake (1996), rebuilt for virtual reality

Quake VR: UNLEASHED (QVR:U) is an opinionated VR mod for Quake (1996) by Vittorio Romeo.

The mod aims to give total freedom to the player, turning most interactions into physics-based one and introducing fun and immersive mechanics such as dual wielding, melee, throwing, swimming, climbing, and more.

The original campaign and all official mission packs are fully playable. QVR:U also features an in-game map browser to play custom content from Quaddicted.

Quake VR: UNLEASHED 🔥 | Release Trailer

QVR:U runs on the Ironwail engine and talks to your headset through OpenXR. It is the successor of the original Quake VR, which ran on QuakeSpasm-Spiked and SteamVR's OpenVR (see comparison).

[!WARNING] QVR:U is in active development. It was playtested on a Meta Quest 3 through Virtual Desktop. Other headsets and controllers should work through OpenXR but have not been tested. Expect rough edges, and please report any issue.

---

Getting started | Configuration | Features | Compared with the original | Documentation | Building from source | Support | Credits

---

Getting started

Requirements:

• An x64 Windows PC that can run PCVR. The graphics card needs OpenGL 4.3.
• A PCVR headset and an OpenXR runtime: VDXR (recommended), SteamVR, Meta Quest Link, or another.
• Quake, the full game, from Steam, GOG or Epic.
  • Optional, but highly recommended: the official mission packs and the re-release's newer campaigns.

Installation:

1. Download and run QuakeVR-Setup.exe from the latest release on the Releases page.
2. Start your OpenXR runtime (e.g. Virtual Desktop, SteamVR), put the headset on, and press Play in VR (or use the shortcuts on the desktop or in the Start menu).

The first start runs VR Calibration, which measures your height and body, then leads to the VR Hub, where you can select a campaign and start playing. The hub also leads to the tutorial and the firing range.

Updating:

• When a new version is out, the in-game menu will show an alert.
• Download and run the new QuakeVR-Setup.exe: it will automatically update your existing installation and keep your saves/settings.

[!TIP] docs/INSTALL.md has the details: each installer page, where everything goes, installing from the QuakeVR.zip package by hand instead, the official campaigns, custom maps and mods, HD textures, relit maps, performance and troubleshooting.

[!NOTE] The game connects to the internet, but sends nothing about you or your play. It only goes online for update checks, custom map downloads, and downloading relighting tools when required.

Configuration

Default Meta Quest Touch controller bindings on VDXR:

[!WARNING] The SteamVR bindings might differ due to specific SteamVR settings.

[!WARNING] The game was only tested on a Meta Quest Touch controller.

Every button can be rebound in-game in Options > Key Setup or with bind in the console. They are named like gamepad keys (RTRIGGER, LSHOULDER, ABUTTON, ...) -- see docs/SETTINGS.md for more information.

The in-game VR Settings menu has the settings most people need.

The main menu's VR Calibration entry runs the calibration again. Worth checking first, top to bottom:

1. Height and hands: Height (stand straight and pick Set Height Now), World Scale, Floor Offset; then Show Controller and the Hand Calibration rows to line the drawn hands up with your real ones.
   • If shots go above or below where the gun seems to point, change Hand Pitch first.
2. Moving: Move Towards (head or a hand), Default Speed, Swap Stick Functions, the comfort Vignette, Teleport, and Turning Mode (smooth, or snap 30/45/90 degrees) with its speed or angle.
3. Weapons and body: Weapon Grip set to Sticky keeps weapons in your hand without holding the grip; Two-Handed, Body Type, Wrist Gadget Arm, the Flashlight and its side.
4. Sound and display: Volume, Music Volume, HUD (wrist gadget or status bar), Crosshair, Headset Gamma, Render Scale with its upscaling and foveated rendering, and the main graphics switches.

Everything else is in the Advanced VR menu: there are over 2000 tweakable settings in this mod, so it can be quite overwhelming. The search feature can help.

Search: the top-left corner's Search button finds any setting by its name or what it does, as you type, and opens its page on it (a cvar's name works too, e.g. vr_snap_turn).

Console: the corner's Console button shows Quake's console with a keyboard under it, to type commands in the headset: Run runs the line, Tab completes it, Prev and Next go through the history; the stick, the wheel or Page Up and Down scroll the text.

[!NOTE] The shipped settings are tuned for a fast PC. If frames drop, pick a lower Preset (Advanced VR > Graphics, with Menu Detail: Advanced: Off, Low, Medium, High or Ultra) and lower Render Scale (VR Settings) below 1.

More: every page ends with Menu Detail. Standard shows common options; Advanced shows every gameplay, display and graphics setting; Developer adds the tuning pages, recording, debug and tests. A setting you changed has a * by it; Changed Settings (Advanced VR) lists them all, and each page's Reset This Page puts its settings back. docs/SETTINGS.md covers them.

Starting over: Options > Reset All restores the shipped settings and bindings. Your settings are saved in quakevr\ironwail.cfg in the install folder: delete it for a completely fresh start (VR Calibration then runs again).

Features

[!NOTE] For a more detailed explanatioh of each feature, see docs/FEATURES.md.

Weapons

• A weapon in each hand: every weapon of Quake and both mission packs, with modelled grips, iron sights, a glowing ammo screen, recoil, muzzle flashes and tracers, and a button on top for a second ammo type.
• Two-handed aiming by the foregrip, an optional virtual stock, and weight: heavy guns lag, want two hands, and can be wrenched from your grip. Hands and barrels stop at walls.
• Holsters at your hips, chest and shoulders; reload at a holster or flick the super shotgun open. Hand grenades from a pouch at your back.
• New weapons to take: knights' swords, the ogres' chainsaws (pull the cord), the grunts' burst rifles, the enforcers' laser rifles, crowbars from crates, and the grappling hook with a physical rope.

Combat

• Melee that reads real swings: punches, blades, clubs and pistol-whips that land on the monster's real shape; axes that stick where you throw them.
• Parry with a weapon or crossed forearms (it stops the attack), counter-attack, bash, shove, headbutt, and bat spikes, lasers and grenades back. Catch grenades, or shoot them.
• Bullet time, from your wrist or a stick, with an optional Sandevistan mode.
• Ragdolls and knockdowns: corpses go limp as physical bodies you can drag and throw; a hard shove knocks a monster down to struggle back up, and off a ledge it always falls.
• Stamina and tired arms (optional), enemy shoves, and a training dummy that can be any enemy and fights back.
• Positional damage (headshots, arms and legs) and knockback in both directions.

Physics and gore

• Everything is physical: thrown weapons, boxes, crates, rocks, explosive boxes you can stack and stand on, wall torches you take off the wall, gibs and heads, all rigid bodies with true-scale gravity. Throws are read from your hand as in Half-Life: Alyx and feel the same at any frame rate.
• Force grab: point, pull the trigger, flick your wrist, and catch.
• Gore you can tune: blood on walls, you, your weapons and props (water washes it off), sticking and dripping gibs, small gibs and brain chunks, wounds, beheading, head pops and limb gore.
• Fire and lightning: flames spread over monsters, corpses and crates and smoulder out; lightning leaves arcs, convulsions and burns, on you too.

Movement and body

• Smooth or teleport locomotion, smooth or snap turning, comfort presets, and room-scale play with crouching, real jumps and leaning.
• Swimming with arm strokes, climbing ledges and rungs hand over hand, and the grappling hook.
• Full body with arms and legs (IK), three builds, your armour, wounds and powerups on it; hands fitted to what they hold. VR Calibration measures you at the first start.
• Left- or right-handed, every side-dependent option at once or one by one. Haptics for shots, hits, holsters and catches.

Interface

• Wrist gadget HUD: health, armour, ammo and stamina on a CRT screen on your forearm, with the game's messages as a hologram. The classic status bar on a hand is still there.
• Doom on your wrist: a real game of Doom on the gadget's screen, running beside Quake: a touchscreen under your fingertip, or the gadget hand's stick while you look at it. Freedoom is included; your own DOOM (Steam, GOG, or DOOM.WAD dropped into quakevr\doom\wads) is found and played instead.
• Flashlight on your belt: a shadow-casting torch you switch, take in hand, flip with a flick, or clip on a gun or your head.
• VR menus with a laser, live previews, drop-down lists, search (with your recent results), a console with a keyboard, Menu Detail levels and per-page reset; tips for new players, also placed by mappers.

Graphics and sound

• Relit maps, made on your PC in the game (one map or every map; the installer can queue them all for the first start) or by a script, with coloured light, ambient occlusion and lamps that light their rooms; see-through water.
• HD textures: the Quake Revitalization Project's, offered by the installer.
• A darker, moodier look like DarkPlaces: coloured dynamic lights, real-time shadows, bloom, lit particles, models lit by the map's lights, bump maps (Quetoo's material maps shipped), parallax and detail textures.
• Teleporters that show where they lead, live: you, your missiles and the monsters' sight pass through.
• Water with waves, reflections, refraction, caustics, splashes and foam; tone mapping and colour grades; an optional retro look; FSR/NIS upscaling and foveated rendering.
• Spatial sound with Steam Audio (HRTF, occlusion, reverb), physics sounds, and the soundtrack played from the Quake you own.

Maps, campaigns and play

• Quake and both mission packs in one game, from a VR hub with a tutorial and a firing range. The re-release's Dimension of the Past, Dimension of the Machine (with its Horde mode) and Dawn of the Machine play natively in single player, when you own them.
• Map Library: browse Quaddicted's custom maps and download, install, uninstall and play them in the game. Other mods run in a compatibility mode.
• Multiplayer and bots (FrikBot), with a fixed 72 Hz server tick: work in progress, expect rough edges and missing features in co-op and deathmatch.
• Flat-screen play (vr_enabled 0, or the flat screen shortcut).
• For recording and testing: a spectator camera, slow motion and highlight markers for trailers; voice notes, an in-game checklist, a motion recorder and debug pages for playtesters.

Compared with the original Quake VR

The original Quake VR (the quakevr-old branch, up to v0.0.7 beta) was built on QuakeSpasm-Spiked and OpenVR. QVR:U keeps its gameplay and QuakeC and rebuilds the rest.

[!WARNING] Saves and configs from the original Quake VR don't carry over.

Documentation

For players:

• docs/INSTALL.md: installation in detail (the installer, or the zip by hand), OpenXR runtimes, mission packs and official campaigns, custom maps and mods, HD textures, relit maps, performance, troubleshooting.
• docs/RELIGHTING.md: relighting your own copy of Quake's maps, for the relit look and see-through water, step by step.
• docs/FEATURES.md: every feature, and how to use it.
• docs/SETTINGS.md: advanced settings, all the menu pages, console variables, config files.

docs/README.md lists every document, with a line on each.

For developers:

• docs/BUILDING.md: building the engine, the QuakeC and the release package, and the tool scripts.
• Installer/README.md: the installer (C#, WPF): its build, command lines and tests.
• docs/vr-port/RELEASING.md: making a release.
• docs/vr-port/: the port's design notes. PLAYTEST.md is the playtest guide, TESTING.md the testing tools, ROUND21.md the log of the current feedback round (its older sections in archive/, the earlier rounds in git history), and there are deep dives into graphics, lighting, throwing, hitboxes and body IK.

Building from source

You need Windows x64, Visual Studio 2022 with the C++ desktop workload and its C++ Clang tools for Windows (the engine is built by clang-cl), and FTEQCC for the QuakeC.

• Engine and QuakeC: build Windows\VisualStudio\ironwail.sln (Release | x64), in Visual Studio or with msbuild Windows\VisualStudio\ironwail.sln -p:Configuration=Release -p:Platform=x64 -p:QvrQcCompiler=<path to fteqcc64.exe> -m. The build compiles the QuakeC too (quakevr\progs.dat).
• Package: powershell -ExecutionPolicy Bypass -File Windows\package-quakevr.ps1 -Fteqcc <path to fteqcc64.exe> puts it in dist\QuakeVR and dist\QuakeVR.zip.
• Installer: dotnet build Installer\QuakeVR.Installer.sln (.NET 9 SDK): see Installer/README.md.
• Release: one command, Misc\release\make_release.ps1 (builds, tests, packages, tags and publishes on GitHub): see docs/vr-port/RELEASING.md.
• CMake also works, for development (on Windows, configure it for clang-cl with -T ClangCL). VR needs Windows x64; the other platforms (CMake or the Makefiles) build with a mock headset only.

docs/BUILDING.md has the details.

Support

QVR:U is free and open-source.

If you enjoy my work, please support the project on Ko-fi.

Talk about it on Discord, and report bugs and ideas on the GitHub issues page.

Credits and licence

Quake VR: UNLEASHED is a project created by Vittorio Romeo. It builds on:

• Ironwail by Andrei Drexler and contributors: a fast QuakeSpasm fork, which descends from FitzQuake and id Software's Quake. Ironwail's own features, such as playing the 2021 re-release content, the Mods menu and its HUD styles, are described in its README.
• The original Quake VR and the ports it grew from: Fishbiter's and Zackin5's OpenVR ports, Dominic Szablewski's Oculus port, and Spike's QuakeSpasm-Spiked.
• Hand models by CrazyHairGuy. Weapon models are based on Authentic Model Improvements.
• The world's normal, specular and glow maps are from the Quetoo game data by Jay Dolan (jdolan) and contributors, made for Rygel's Texturepack Ultra (from the Quake Retexture Project and others; id Software's textures retextured), under CC BY-SA 4.0: see quakevr/textures_quetoo/README.md for every author.
• The HD textures are the Quake Revitalization Project's (docs/vr-port/TEXTURES.md: contents, credits, licence).
• Box3D (Erin Catto) for the physics, Steam Audio (Valve) for the spatial sound, Zancle (Vittorio Romeo), FrikBot (Ryan "FrikaC" Smith), the OpenXR SDK (Khronos), SDL2, GLM, FTEQCC, and ericw-tools. The Map Library's maps come from Quaddicted.

The full list, with the research and techniques used, is in docs/vr-port/CREDITS.md.

QVR:U is free software under the GNU General Public License v2 (LICENSE.txt), like the Quake engine it comes from. Quake's game data (maps, models, sounds, textures) belongs to id Software and isn't included: you need your own copy of Quake.