teambeef/jkxr
0
0
Fork 0
mirror of https://github.com/DrBeef/JKXR.git synced 2024-11-24 13:01:36 +00:00
Code Issues Projects Releases Packages Wiki Activity
Jedi Knight games on OpenXR devices (Meta Quest, Pico 4, and PCVR)
266 commits 12 branches 21 tags 207 MiB
C 52.1%
C++ 45.4%
Shell 0.6%
Makefile 0.5%
CMake 0.4%
Other 0.7%
Find a file
Simon f785fdc393 update github banner 
Update README.md

Update README.md

Update README.md

Update README.md

Update README.md

Added Team Beef Patreon banner
2023-04-06 08:36:47 +01:00
assets update github banner 2023-04-06 08:36:47 +01:00
java/com/drbeef/jkxr Demo folder assets fix 2023-04-03 22:38:10 +01:00
Projects Prevent crash when throwing Saber 2023-04-04 23:03:31 +01:00
res Renaming JKQuest to JKXR 2023-03-01 22:14:44 +00:00
z_vr_assets_base Update help resources and menu 2023-04-04 21:41:04 +01:00
z_vr_assets_jka Update help resources and menu 2023-04-04 21:41:04 +01:00
z_vr_assets_jko Update help resources and menu 2023-04-04 21:41:04 +01:00
.gitignore Split vr asset packs to avoid duplicates 2023-03-28 22:43:13 +01:00
build.gradle Gradle changes to support building without dependency on the Meta OpenXR SDK Package 2023-02-05 23:13:43 +00:00
gradle.properties Gradle changes to support building without dependency on the Meta OpenXR SDK Package 2023-02-05 23:13:43 +00:00
LICENSE.txt Added simple readme and license 2023-03-28 13:50:54 +01:00
local.properties Gradle changes to support building without dependency on the Meta OpenXR SDK Package 2023-02-05 23:13:43 +00:00
make_z_vr_assets_pk3.bat Started on JKA 2023-02-01 21:11:04 +00:00
README.md update github banner 2023-04-06 08:36:47 +01:00
XrApp.gradle Gradle changes to support building without dependency on the Meta OpenXR SDK Package 2023-02-05 23:13:43 +00:00

README.md

JKXR Banner

JK XR

JK XR is a VR port of the Jedi Knight games using OpenXR (the open standard for virtual and augmented reality devices) and is based on the excellent OpenJK port, originally forked from: https://github.com/JACoders/OpenJK

This is currently built for standalone VR HMDs (see the Building section below) and will currently not run on any other device, 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. Download SideQuest here: https://github.com/the-expanse/SideQuest/releases

Jedi Knight: Jedi Outcast

The public release of JK XR currently supports the game Jedi Outcast; access to the Jedi Academy early-access build can be found on the Team Beef patreon (link below). However there are lots of mods and access to the free demo level available through the accomapnying JK XR Companion App, which is also installed alongside JK XR on SideQuest.

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/

Copying the Full Game files to your Oculus Quest

Before you are able to run the full game of Jedi Knight: Jedi Outcast in VR you will need to:

  • Install JK XR thought SideQuest (this will also install the companion app)
  • Start JK XR for the first time, it will ask for appropriate permissions (which you must allow), create the necessary folders and then close down
  • You can now run the Companion App and download the Demo level if you wish, or...
  • (optional) Copy only the assets files from your PC install of JKO (Jedi Outcast\GameData\base) into the following folder on your device:

\JKXR\JK2\base

  • You must then use the Companion App to start the game and apply any mods you wish to also use that you downloaded through the companion app

Save Games File

Save game files are stored on the internal memory of your device. This means that if you uninstall/reinstall JK XR all the saves are retained. If you change headset just make sure you copy your saves to the new device. Any update will not affect any of your save game files.

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

Controls and configuration

This control scheme and helpful short videos on how to play can be found in the Controls -> JKXR HELP in the game.

Control Scheme

Team Beef Patreon

Team Beef

The Team Beef Patreon where you can find all the in-development early-access builds for JK XR with Jedi Academy support, as well as other active projects can be found here:

https://www.patreon.com/teambeef

Building from Source

If you wish to build JK XR from source, then you need the following:

  • Android Developer Studio
  • Android SDK API level 24
  • Latest Android Native Development Kit
  • The OpenXR release archive for your headset

There is no dependency on any specific headset native libraries, as this port uses OpenXR and links against the opensource Android openxr_loader.so. If you wish to build for a specific headset, then you need to place the openxr_loader.so for the headset into the following folder and rename it to: openxr_loader_{device}.so where {device} is either meta or pico (further device support hopefully in the future):

JKXR\Projects\Android\libs\arm64-v8a