All Projects → SuperV1234 → Quakevr

SuperV1234 / Quakevr

Licence: gpl-2.0
Quake VR mod supporting room-scale movement, hand interactions, and melee attacks.

quakevr

The timeless classic from 1996, reimagined for virtual reality.

(Visit the official landing page for videos and more information.)

Main Features

  • Smooth locomotion
  • Teleportation
  • Fully room-scale (including jumping)
  • Hand tracking (including full finger tracking)
  • Weapon models with hands and ironsights
  • VR interactions (melee, headbutts, pick up items, press buttons)
  • Rebalanced for VR (hitboxes, difficulty, projectile speed)
  • Steam VR Input API support (can rebind inputs in Steam VR settings)
  • Many customization options (e.g. melee damage/range, hand/body item pickup, and more)
  • Brand new particle system (smoke, blood, lightning effects, and more)
  • Haptic feedback (weapons, melee, damage, interactions with items)
  • Full Scourge of Armagon support (weapons, enemies, maps)
  • Full Dissolution of Eternity support (weapons, enemies, maps)
  • Two-handed weapon aiming (with virtual stock support)
  • Weapon weight simulation
  • Grappling hook (from Dissolution of Eternity)
  • Positional damage (headshots, leg shots)
  • Dual-wielding
  • Weapon holster system (hip and shoulders, fully customizable)
  • Weapon throwing & force grabbing
  • Multiplayer support (also with bots)
  • Weapon reload system
  • Sandbox map

Disclaimer

  • This is a free open-source project done for fun and to contribute to the VR community. Donations are appreciated, but making money is not a goal for quakevr.
  • The project is still in an early stage. Expect bugs and lack of polish. It was fully tested only with a Valve Index headset and controllers.
  • Tweaking the settings in-game is highly recommended before playing. The default settings might not be ideal for your hardware and body proportions.
  • The game heavily relies on modified QuakeC files. Therefore, mods or expansion packs are not compatible out of the box, but should be easy to port.
  • Feel free to open issues or contact me at [email protected] for any issue, feature request, or question about the code.
  • Join us on the official Discord for discussion, feedback, and beta testing. (Direct invite link.)

Installation

  1. Install "Visual C++ x64 Redistributable" package.

  2. Install "Quake 1". The Steam version works well.

  3. Grab the latest binary from the releases page.

  4. Extract the contents of the package directly in the Quake installation folder (e.g. C:/Program Files/Steam/steamapps/common/Quake).

  5. Run the game by launching the .exe you just extracted.

Mission Pack 1: Scourge of Armagon

Quake VR supports the "Scourge of Armagon" official mission pack. It can be installed alongside the regular Quake files, enabling you to play either the original game or SoA without having to restart Quake VR.

  1. Install "QUAKE Mission Pack 1: Scourge of Armagon". The Steam version works well.

  2. Go to the installation folder.

  3. Open the hipnotic folder.

  4. Make a copy of pak0.pak, and rename it to pak2.pak.

  5. Copy the newly created pak2.pak in your Quake VR installation folder, under Id1. Usually, this means simply copying pak2.pak to ../Id1.

  6. The contents of your Id1 folder should now contain:

    • Official Quake files: pak0.pak and pak1.pak;
    • Scourge of Armagon mission pack files: pak2.pak;
    • Quake VR files: pak10.pak, pak11.pak, pak12.pak.

    (The load order of .pak files is based on their naming. You can rename the Scourge of Armagon mission pack to anything else, as long as it is before the Quake VR specific .pak files. This allows you to also add extra .pak files, such as high-resolution models or other compatible additions.)

When Scourge of Armagon is installed, it overwrites Quake 1's start.bsp with its own starting map. In order to play Quake 1 maps, use the "Change Map" functionality under "Quake VR Settings".

Mission Pack 2: Dissolution of Eternity

Quake VR supports the "Dissolution of Eternity" official mission pack. The instructions above apply here as well. Take pak0.pak from the rogue folder, rename it to somethhing unique (e.g. pak4.pak if you installed Scourge of Armagon), and place it in your Id1 folder.

Highly Recommended Addons

HD Textures and Soundtrack

The HD Textures and Soundtrack addon is highly recommended to improve immersion.

Extra Multiplayer Maps with Bot Support

Quake VR comes with Frikbot X++, which adds AI opponents for deathmatch. As the vanilla multiplayer map pool is quite limited, the following map pack and Frikbot waypoint collection are strongly advised if you are interested in playing against bots:

Custom Maps

For supported custom maps, please see CUSTOM_MAPS.md.

Vispatching

The Quake VR engine supports transparent water, however original Quake maps need to be patched in order for it to work properly. It is therefore highly recommended that you "vispatch" your Quake (and Scourge of Armagon) maps.

Follow this guide to easily "vispatch" your maps. Alternatively, search for the term "vispatching" online, or read the README provided with the VisPatch tool.

Once your maps are patched, go through the options in the "Transparency Options" menu under "Quake VR Settings" to enable/tweak transparency levels.

First Steps

SteamVR Bindings

The first thing you should do after starting Quake VR is opening the "Controller Bindings" interface on SteamVR and ensure that in-game actions are mapped to the motion controllers. There are two action sets to bind: one for in-game actions, and one for menu control. See an example video here.

In-Game Configuration

After setting up your bindings, please go through all the options in "Quake VR Settings", and tweak the game to your liking. Do not forget to:

  • Calibrate your height;
  • Tweak the position of the "VR torso" and of the holsters ("hotspots");
  • Go through the "Immersion Settings".

There is no "best" way of playing Quake VR. Simply use the settings that you enjoy the most!

Multiplayer

Versus Bots

To play against bots, select "Multiplayer & Bots" from the main menu, then "New Game" and follow the on-screen instructions. When in-game, spawn new bots from the "Bot Control" menu under "Multiplayer & Bots".

On the Internet

Coordinate with other players on the official Quake VR Discord. The host of the game will start a server by going to "Multiplayer & Bots" from the main menu, then "New Game". The host will then share their public IPV4 address with other players, which will connect from the "Join a Game" menu. The virtual keyboard can be used to insert the IP address.

Note that the host needs to properly forward their ports and ensure that their public IP is accessible from the Internet.

At the moment there is no server browser and no dedicated server support. Also, only Windows servers are supported. Dedicated Linux servers and an easier way to play together will be the next goals for Quake VR.

Troubleshooting

  • The game seems to work fine, but there is no audio!

    • Ensure that the correct audio output device is set (HMD) and that the volume is turned up.

    • Open the Desktop view from your Steam VR dashboard, and make sure that the Quake VR window is in focus. You can bring it in focus by clicking on it.

    • Check that the in-game audio settings are correct.

  • How do I obtain the grappling hook?

    • The grapplink hook is available in the sandbox map, accessible through the "single player" menu.

    • The grappling hook is also available through cheats: it is a very fun toy but it would completely break the progression of most levels. To obtain it, go to the "Debug Utilities" sub-menu under the "Quake VR Dev Tools" menu - there will be an option to enable it there. You can then spawn it by using the "Impulse 14 (Spawn All)" command, or cycle to it if you have weapon cycling enabled.

  • My issue is not listed here!

Credits

(Please forgive me if I am forgetting someone. I will update this list as needed.)

Fan Coverage

(Thanks everyone for playing Quake VR! If you have created content related to the mod, please let me know and I'll add it to this list.)

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].