Watch Quake Save

18.11.2022

Watch_Quake is a Quake 1 port specifically designed for Apple Watch, incorporating software rendering and functional audio playback capabilities. This game port supports both the shareware and registered versions of Quake. Providing a gaming experience that can be enjoyed while on the move complete with optional music tracks.

https://www.youtube.com/watch?v=ptKAh8RgzJM Benchmark (Series 5)
https://www.youtube.com/watch?v=89TAt72eYt4 Gameplay (Series 5)

This port started from the original Quake Watch port by Tomas "MyOwnClone" Vymazal.

Contents

About
Changes by ByteOverlord
Features
Changelog
Game Size
Battery Usage
Benchmark
Known Issues
Building Requirements
Building the Watch_Quake
Adding music to Watch_Quake (Optional)
Credits
License

About

Our team became highly interested in MyOwnClone's quake_watch port and immediately recognized the immense potential that the Apple Watch had for gaming. Upon closer examination, we realized that a few adjustments were required in terms of controls and optimizing the game to run in fullscreen mode. Our vision was to create a port that not only captured the essence of the original 1996 Quake release but also provided a gaming experience akin to a polished commercial product. This initial idea sparked the beginning of the project, and ByteOverlord enthusiastically began refining the different elements of this game port, ensuring every aspect received meticulous attention.

The primary objective of this project was to demonstrate the remarkable capabilities of the Apple Watch, even when operating in software rendering mode. It served as a glimpse into the untapped potential that could be unlocked if we were granted access to the device's GPU. Just envision the possibilities that could be achieved with such resources at our disposal.

Later port:

Quake 2 for Apple Watch https://github.com/ByteOverlord/Watch_Quake2 03.09.2023

Changes by ByteOverlord

• Swift for UI drawing, audio callback and input processing
• Sound Mixer separated to a second thread from the drawing pipeline to give the Mixer more time for processing
• Music playback support added. Audio file format “Mono, 22050 Hz, WAV, IMA ADPCM” preferred for lower processing and minimal space required
• Timer changed from “ns_timer” to “dispatch_source” (Possibly more accurate)
• Main menu custom texts are drawn on the fly from the original texture so no extra textures needed (Maps, Cheats)
• Maps menu added with custom level screenshots and selectable difficulty
• Cheats menu added with toggles that stay active in level changes
• Saves game config (Options) and save games (.sav) in “Application Support” folder. Game config saves automatically when the app goes to background
• Resolution setting is automatic with hud, menu and console notification placements affected by resolution
• "Run Benchmark" mode with selectable Demo1, Demo2 and Demo3 added in the options menu
• DefragAllocator and DefragCache. Replaces sound cache
• Game pausing through Swift UI when application enters background state and saves settings. Mutes audio when inactive state
• Initial game loading fixed so that game and audio loops start after the Swift UI tells the app is active (≥ WatchOS 9.2). When content view updates the game starts (< WatchOS 9.2)
• Touch input handling through Swift UI. Customized touch control layout for movement, camera, interaction and menu controls
• Touch and crown inputs can be handled at the same time. Workaround uses separate views for touch and crown inputs to enable them to register at the same time (works with watchOS 9 and 10)
• Benchmark mode that logs average, low and high frame times. Uses the Quake’s DEMO1, DEMO2 and DEMO3 playbacks

Features

• PAK0 and PAK1 loading
• Menu screen
• Save and load game
• Autosaving of options
• Map quick select screen
• Cheat activation screen
• Tweaked controls for watch interface
• Underwater audio effect
• Position and animation interpolation
• Music playback
• Benchmark mode
• Automatic native resolution (Series 4 40mm -> Ultra2)

Changelog

10.10.2023

• Touch and crown inputs now enabled at the same time (workaround found that works with watchOS 9 and 10)
• Framework files removed from the project (remnants from WatchKit)

08.10.2023

• Game view position fixed for watchOS 10

03.09.2023

• Initial game loading fixed

04.07.2023

• Controls updated for more simple layout

04.12.2022

• Cameralook fix (Better input handling)
• Sound fix (Stabilized performance on newer watches (tested on SE 2nd Gen))

27.11.2022

• Benchmark section added
• Series 4 updated as supported in requirements
• DefragAllocator added in the project
• Sound fixes
• "Run Benchmark" added in the options menu
• Menu controls tweaked

19.11.2022

• Sound fix (Fixed possible crash with audio cache)

Game size

Complete game with optional music takes ~ 99,4 MB on the watch.

PAK0.PAK is 18,7 MB
PAK1.PAK is 34,3 MB
Music Tracks are 39,3 MB (converted with Audacity (Mono, 22050 Hz, WAV, IMA ADPCM))

Battery Usage

Usage listed as % the charge dropped during the test.

Model	Battery Health	30 min	60 min
S4 40mm	-	-	-
S4 44mm	-	-	-
S5 40mm	-	-	-
S5 44mm	95%	11%	28%
SE (1st Gen) 40mm	-	-	-
SE (1st Gen) 44mm	-	-	-
S6 40mm	-	-	-
S6 44mm	-	-	-
S7 41mm	-	-	-
S7 45mm	-	-	-
SE (2nd Gen) 40mm	-	-	-
SE (2nd Gen) 44mm	-	-	-
S8 41mm	-	-	-
S8 45mm	-	-	-
Ultra	-	-	-
S9 41mm	-	-	-
S9 45mm	-	-	-
Ultra 2	-	-	-

Results are only indicative.

Benchmark

Reference table:

Good	Moderate	Bad
≤ 5 ms	6-12 ms	> 16 ms

Results:

DEMO1	Avg	Low	High
S4 40mm	5.94	2.63	13.41
S4 44mm	6.14	2.99	13.54
S5 40mm	5.32	2.44	13.84
S5 44mm	6.13	2.71	13.96
SE (1st Gen) 40mm	-	-	-
SE (1st Gen) 44mm	-	-	-
S6 40mm	-	-	-
S6 44mm	-	-	-
S7 41mm	-	-	-
S7 45mm	-	-	-
SE (2nd Gen) 40mm	-	-	-
SE (2nd Gen) 44mm	7.35	2.61	14.98
S8 41mm	-	-	-
S8 45mm	-	-	-
Ultra	-	-	-
S9 41mm	-	-	-
S9 45mm	-	-	-
Ultra 2	-	-	-

DEMO2	Avg	Low	High
S4 40mm	5.50	1.95	14.79
S4 44mm	5.85	2.59	13.79
S5 40mm	5.19	2.12	13.43
S5 44mm	5.94	2.51	15.36
SE (1st Gen) 40mm	-	-	-
SE (1st Gen) 44mm	-	-	-
S6 40mm	-	-	-
S6 44mm	-	-	-
S7 41mm	-	-	-
S7 45mm	-	-	-
SE (2nd Gen) 40mm	-	-	-
SE (2nd Gen) 44mm	6.77	2.12	15.20
S8 41mm	-	-	-
S8 45mm	-	-	-
Ultra	-	-	-
S9 41mm	-	-	-
S9 45mm	-	-	-
Ultra 2	-	-	-

DEMO3	Avg	Low	High
S4 40mm	6.21	1.99	14.21
S4 44mm	6.45	2.43	15.70
S5 40mm	5.38	2.07	13.75
S5 44mm	6.41	2.78	14.01
SE (1st Gen) 40mm	-	-	-
SE (1st Gen) 44mm	-	-	-
S6 40mm	-	-	-
S6 44mm	-	-	-
S7 41mm	-	-	-
S7 45mm	-	-	-
SE (2nd Gen) 40mm	-	-	-
SE (2nd Gen) 44mm	7.47	2.06	14.59
S8 41mm	-	-	-
S8 45mm	-	-	-
Ultra	-	-	-
S9 41mm	-	-	-
S9 45mm	-	-	-
Ultra 2	-	-	-

Benchmarks are only indicative.

Known Issues

• Mods are not supported
• Player camera jumps after saving
• Audio will not transmit through Bluetooth
• Shareware version (using only PAK0) softlocks when going through episode 2-4 portals
• Smooth animation on, torches flicker on the edges of the view
• R_AliasDrawModel trivial_accept disabled (Incorrect bounding box?)
• Sound does not playback on app start (Put the game to the dock and open it from there again.)
• App does not start anymore (Build the app to the watch from Xcode). There is a 7 day testing period on a 'Free Provisioning' profile.

Building Requirements

• Apple Watch Series 4 or later with watchOS 9.1 or later
• iPhone 8 or later with iOS 16 or later
• Mac with macOS 12.5 or later
• Xcode 14.1 or later with command-line tools
• Homebrew
• Innoextract
• bchunk (only for music)
• Audacity (only for music)

Building the Watch_Quake

1. Install Xcode through Apple AppStore and install command-line tools when Xcode asks for it.

2. Download the Watch Quake from GitHub. (https://github.com/ByteOverlord/Watch_Quake)

3. Get Quake through gog.com (if you just want to use the shareware jump to step “8. Copy PAK...” and only use the shareware’s PAK0.PAK)

4. Download the quake installer from your gog.com profile:
   "gog.com Profile" -> Games -> Quake -> View Downloads -> Download Offline Backup Game Installers -> Quake

5. Install Homebrew from terminal:
   ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/homebrew/go/install)"

6. Install innoextract from Homebrew:

brew update
brew install innoextract

7. In terminal extract the Quake game files with innoextract:
   innoextract “downloaded setup_quake_the_offering_2.0.0.6.exe file location”

(innoextract will extract an “app” and "tmp" folders in current working directory.) "app" folder has the needed PAK files and optional audio.

8. Copy PAK0.PAK and PAK1.PAK files to WatchQuake project (PAK names have to be uppercase (case sensitive)):
   /WatchQuake Watch App/Resources/id1/

9. Open the GitHub WatchQuake Xcode project.

10. In WatchQuake project file go to:
    WatchQuake -> Targets -> WatchQuake -> Signing & Capabilities

11. Select your "Team" and write a unique “Bundle Identifier”.

12. Then in WatchQuake project file go to:
    WatchQuake -> Targets -> WatchQuake Watch App -> Signing & Capabilities

13. Select your "Team" and use the same “Bundle Identifier” as previously but with “.watchkitapp” added at the end.

14. Check that the project is on release setting.

15. Test the build first with a simulator (Series 4 Simulator or newer (watchOS Simulator))

After building, the game will start and playback demo1.

Click the game view to go to main menu.

16. After testing connect iPhone to the Mac with a cable and make sure Apple Watch has a connection to iPhone.

17. Set the iPhone and Apple Watch in to "Developer" mode.

On iPhone:
Settings -> Privacy & Security -> Developer Mode (SECURITY) -> Developer Mode

On Apple Watch:
Settings -> Privacy & Security -> Developer Mode (SECURITY) -> Developer Mode

After the devices have restarted.

18. Select the Apple Watch as target.

19. From Xcode build the Watch_Quake to the watch.

Transfer times:
1 min (iPhone X & S4 40mm)
5-20 min (iPhone X & S5 44mm)
1 min (iPhone 12 mini & S5 40mm)
1 min (iPhone 12 mini & SE 2nd Gen 44mm)

Adding music to Watch_Quake (Optional)

1. Install bchunk from terminal:
   brew install bchunk

2. Extract game music from the gog game files:
   bchunk -w “game.gog file location” “game.cue file location” track

3. (Music tracks will extract in to current working directory (track02 - track11.wav).)

4. Open Audacity and drag the tracks to it. Edit the tracks to Mono.
   Select -> All
Tracks -> Mix -> Mix Stereo Down to Mono

5. Set the “Project Rate (Hz)” to 22050.

6. Export tracks with “Export Multiple” in “WAV” format with “IMA ADPCM” encoding.

7. Place the exported audio files (track02 - track11.wav) inside the WatchQuake project:
   “WatchQuake Watch App/Resources/id1/music/”

8. From Xcode build the Watch_Quake to the watch.

Transfer times:
1 min (iPhone X & S4 40mm)
5-20 min (iPhone X & S5 44mm)
1 min (iPhone 12 mini & S5 40mm)
1 min (iPhone 12 mini & SE 2nd Gen 44mm)

Credits

quake_watch https://github.com/MyOwnClone/quake_watch
vkquake (Underwater sound filter, snd_dma init) https://github.com/Novum/vkQuake
Quakespasm (Position and animation interpolation) https://github.com/sezero/quakespasm
Quake_For_OSX https://github.com/Izhido/Quake_For_OSX
Quake-iOS https://github.com/tomkidd/Quake-iOS
Quake source code by Id Software. https://github.com/id-Software/Quake
App icon, images, documentation and videos by IdeaVoid

License

This software is released under the terms of the GNU General Public License v2.