jkxr/README.md
2023-03-28 13:50:54 +01:00

31 lines
1.3 KiB
Markdown

![JKXR Banner](https://github.com/DrBeef/JKXR/blob/main/assets/FemaleVRJedi.png)
===
JKXR is a VR port using OpenXR (the open standard for virtual and augmented reality devices) is based on the excellent OpenJK port, originally forked from: https://github.com/JACoders/OpenJK
This is currently built solely for standalone VR HMDs and will **not** run on any other device, currently the list of supported devices is: Meta Quest (1, 2, Pro) and Pico (3 & 4).
Support for PCVR based devices will hopefully come in the future.
The easiest way to install this on your device is using SideQuest, a Desktop app designed to simplify sideloading apps and games.
Download SideQuest here:
https://github.com/the-expanse/SideQuest/releases
IMPORTANT NOTE
--------------
This is just an engine port; the apk does not contain any of the of Jedi Knight game assets. If you wish to play the full game you must purchase it yourself, steam is most straightforward: https://store.steampowered.com/app/6030/STAR_WARS_Jedi_Knight_II__Jedi_Outcast/
INSTALLATION AND SETUP
----------------------
The same APK will work on all supported devices.
Meta Quest Install Instructions
https://trello.com/c/C0YTFpvX/48-quest-quest-2-installation-instructions
Pico 3/4 Install Instructions
https://trello.com/c/Idb627uv/47-pico-4-installation-instructions