teambeef/jkxr
0
0
Fork 0
mirror of https://github.com/DrBeef/JKXR.git synced 2024-11-21 19:51:33 +00:00
Code Issues Projects Releases Packages Wiki Activity

Update README.md

Browse source
This commit is contained in:
Grant Bagwell 2023-04-06 17:23:36 +02:00 committed by GitHub
parent a5f3adf725
commit e9af8e87c2
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 50 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

71
README.md
View file

@ -3,6 +3,10 @@
# JK XR
[SideQuest Latest Version (Meta Headsets)](https://sidequestvr.com/app/15472)
[SideQuest Latest Version (Pico Headsets)](https://sidequestvr.com/app/)
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).
@ -18,35 +22,63 @@ https://github.com/the-expanse/SideQuest/releases
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.
## Team Beef Patreon
[![Team Beef Patreon](https://github.com/DrBeef/JKXR/blob/main/assets/PatreonBanner.jpg)](https://www.patreon.com/teambeef)
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.
## Gameplay and VR Features
### VR Features
* New Fully Modelled VR Weapons
* Full Motion Controlled Light Saber
* Real Collision based Laser Deflections
* Weapon / Force wheels
* Gesture Based Use / Interact
* Gesture based Force Actions (Push, Pull and Grab)
* Weapon Scopes
* Gesture Based Saber Throw
* Companion App
### Gameplay Modes (accessible via Setup -> Difficulty in the Menu)
**Team Beef Directors Cut (TBDC) - On (Default is On)**
This version uses faithful enemy speeds and aggression from the original game, which are fast and challenging by modern standards. To balance this projectile speeds and gun power are raised to feel more canon to the Star Wars movies and prevent Stormtroopers and other enemies from being able to avoid gunfire by strafing. There are also exaggerated knockback effects. This mode is more arcade-y fast paced affair whilst feeling similar to the difficulty level of the twitch-based gameplay of the original game.
**Team Beef Directors Cut (TBDC) - Off**
Projectile speeds are faithful to the original game, but enemy movement and aggression are toned back, where stormtroopers don't have an easy time to flank you. You may need to still "lead" shots slightly ahead of enemies when they are on the move. Recommended for a slower paced tactical encounter
To switch between modes change the option and if already in-game, restart the level you are on.
## 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
You can find the latest version, which also includes the Companion App hosted on Sidequest. Use the links at the top of the page (separated by headset). Before installing via SideQuest you must have enabled "Developer Mode" on your headset. You can find the details on how to do that below:
### Copying the Full Game files to your Oculus Quest
Pico 3/4 Instructions
https://trello.com/c/Idb627uv/47-pico-4-installation-instructions
Meta Quest Install Instructions
https://trello.com/c/C0YTFpvX/48-quest-quest-2-installation-instructions
## 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:
- You can now run the Companion App. This will check that it has the files for the full game.
- (optional) Copy only the assets files (assets0.pk3, assets1.pk3, assets2.pk3, assets5.pk3) 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
- You must then use the Companion App to download any mods and start the game. It is possible to play the JK Demo without having copied across the full game assets. All other mods require the full game.
### Save Games File
@ -55,22 +87,15 @@ Save game files are stored on the internal memory of your device. This means tha
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.
### Tutorials
You can find tutorial videos on how to use the special VR features in the in-game Controls -> JKXR HELP menu.
TUTORIAL PIC
This control scheme on how to play can also be found in the Controls -> JKXR HELP in the game.
![Control Scheme](https://github.com/DrBeef/JKXR/blob/main/z_vr_assets_base/gfx/menus/control_scheme.jpg)
@ -87,3 +112,7 @@ If you wish to build JK XR from source, then you need the following:
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
## Credits
TODO