diff --git a/NOTICE.txt b/NOTICE.txt index 1466bd3..098af6e 100644 --- a/NOTICE.txt +++ b/NOTICE.txt @@ -8,6 +8,9 @@ and is not relicensed by this project's MIT license. Game assets are not included - see res/GET_ASSETS.txt. +System Shock is a trademark of its respective owners. This is an unofficial +fan project and is not affiliated with, endorsed by or supported by them. + The Android build additionally bundles: - GL4ES (https://github.com/ptitSeb/gl4es), vendored and patched (see diff --git a/README.md b/README.md index c542397..72bda3a 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,45 @@ button, stick direction and game hotkey can be assigned to a game action. Questshock runs entirely on the headset (tested on a Meta Quest 2) as a sideloaded Android app, and needs your own copy of the game data. +> **Unofficial fan project.** Questshock is not affiliated with, endorsed by or +> supported by the rights holders of System Shock. It contains no game data: you +> need your own copy of System Shock: Enhanced Edition. + +## Screenshots + + + + + + + + + + + + + + +
Exploring the station on the virtual screen
Exploring the station on the virtual screen
Reading an email - the laser pointer clicks like a mouse
Reading an email - the laser pointer clicks like a mouse
Cyberspace
Cyberspace
The game screen, the menu and the keyboard float independently
The game screen, the menu and the keyboard float independently
The VR menu
The VR menu
Assigning controller inputs to game actions
Assigning controller inputs to game actions
+ +[A short video](res/screenshots/questshock_v0.5.3_010.mp4) shows the game in use. + +## Quick start + +You need a Meta Quest (tested on a Quest 2) and your own copy of the game data. + +1. Get **System Shock: Enhanced Edition** (for example from + [gog.com](https://www.gog.com/)); see "3. Game assets" below. +2. Download `questshock--android-arm64.apk` from the repository's + Releases page and sideload it onto the headset with + [SideQuest](https://sidequestvr.com/) or `adb install`. +3. Launch it once. It creates `/sdcard/QuestShock/`. Copy your game's `res/data/` + and `res/sound/` folders into `/sdcard/QuestShock/res/`. +4. Launch it again. The left controller's menu button opens the menu; the + default controls are in "5.1.1. Menu, controls and cheats" below. + +Section "5.1. Installing and playing" has the details. + ## 1. Design principles - **Standalone-headset-only.** The game must run entirely on the headset @@ -1015,6 +1054,10 @@ under the **GNU GPLv3** (see `engine/LICENSE`) - it is included unchanged and is *not* relicensed by this project's MIT license. Any build or distribution of the compiled engine must comply with the GPLv3. +System Shock is a trademark of its respective owners. Questshock is an +unofficial fan project and is not affiliated with, endorsed by or supported by +them. + The game assets extracted into `res/assets/ss_ee/` are proprietary, copyrighted game data owned by their respective rightsholders - they are never committed to this repository (see `.gitignore`) and must be