Add screenshots, a quick start and a trademark notice to the README
build / build (push) Successful in 3m8s

This commit is contained in:
ml
2026-09-25 20:25:17 +02:00
parent 135e474a14
commit 790b4ffd21
2 changed files with 46 additions and 0 deletions
+3
View File
@@ -8,6 +8,9 @@ and is not relicensed by this project's MIT license.
Game assets are not included - see res/GET_ASSETS.txt. 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: The Android build additionally bundles:
- GL4ES (https://github.com/ptitSeb/gl4es), vendored and patched (see - GL4ES (https://github.com/ptitSeb/gl4es), vendored and patched (see
+43
View File
@@ -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 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. 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
<table>
<tr>
<td width="50%"><img src="res/screenshots/questshock_v0.5.3_001.jpg" alt="Exploring the station on the virtual screen"><br><sub>Exploring the station on the virtual screen</sub></td>
<td width="50%"><img src="res/screenshots/questshock_v0.5.3_003.jpg" alt="Reading an email - the laser pointer clicks like a mouse"><br><sub>Reading an email - the laser pointer clicks like a mouse</sub></td>
</tr>
<tr>
<td width="50%"><img src="res/screenshots/questshock_v0.5.3_005.jpg" alt="Cyberspace"><br><sub>Cyberspace</sub></td>
<td width="50%"><img src="res/screenshots/questshock_v0.5.3_006.jpg" alt="The game screen, the menu and the keyboard float independently"><br><sub>The game screen, the menu and the keyboard float independently</sub></td>
</tr>
<tr>
<td width="50%"><img src="res/screenshots/questshock_v0.5.3_007.jpg" alt="The VR menu"><br><sub>The VR menu</sub></td>
<td width="50%"><img src="res/screenshots/questshock_v0.5.3_008.jpg" alt="Assigning controller inputs to game actions"><br><sub>Assigning controller inputs to game actions</sub></td>
</tr>
</table>
[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-<version>-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 ## 1. Design principles
- **Standalone-headset-only.** The game must run entirely on the headset - **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 and is *not* relicensed by this project's MIT license. Any build or
distribution of the compiled engine must comply with the GPLv3. 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, The game assets extracted into `res/assets/ss_ee/` are proprietary,
copyrighted game data owned by their respective rightsholders - they are copyrighted game data owned by their respective rightsholders - they are
never committed to this repository (see `.gitignore`) and must be never committed to this repository (see `.gitignore`) and must be