Update tyrquake.md

- Sync TyrQuake with latest core template. - Noticed a user on the libretro discord was confused with the expansion pak section so I updated it to make it more clear. - Completed the Geometry and Timing section. - Added a soundtrack files section. - Added description to Colored lightning core option.
2025-02-24 02:51:10 +00:00 · 2018-03-30 12:49:48 -04:00 · 2018-03-30 12:49:48 -04:00 · 94b665e80f
commit 94b665e80f
parent fc224e7e17
1 changed files with 62 additions and 23 deletions
--- a/docs/library/tyrquake.md
+++ b/docs/library/tyrquake.md
@ -12,8 +12,6 @@ Features
 - Chasecam / thirdperson view mode
 - Interpolated animation applied on the keyframe animation for smooth animation

-### Author/License
-
 The TyrQuake core has been authored by

 - Kevin Shanahan (Tyrann)
@ -30,8 +28,6 @@ Content that can be loaded by the TyrQuake core have the following file extensio

 - .pak

-## Databases
-
 RetroArch database(s) that are associated with the TyrQuake core:

 - [Quake1](https://github.com/libretro/libretro-database/blob/master/rdb/Quake1.rdb)
@ -82,17 +78,17 @@ The TyrQuake core saves/loads to/from these directories.

 ### Geometry and timing

- The TyrQuake core's core provided FPS is (FPS)
+- The TyrQuake core's core provided FPS is 60
 - The TyrQuake core's core provided sample rate is 44100 Hz
- The TyrQuake core's base width is (Base width)
- The TyrQuake core's base height is (Base height)
- The TyrQuake core's max width is (Max width)
- The TyrQuake core's max height is (Max height)
+- The TyrQuake core's base width is dependent on the Resolution core option.
+- The TyrQuake core's base height is dependent on the Resolution core option.
+- The TyrQuake core's max width is dependent on the Resolution core option.
+- The TyrQuake core's max height is dependent on the Resolution core option.
 - The TyrQuake core's core provided aspect ratio is 4/3

 ## Loading Quake and Expansion Paks

-Make those folders in the same directory:
+Follow this directory structure

 - id1 for the main game
 - hipnotic for the 1st mission pack
@ -100,6 +96,47 @@ Make those folders in the same directory:
 - quoth for Quoth addon
 - Put BGM into a subfolder named music in each of them.

+```
+id1/
+├── pak0.pak ## shareware data
+├── pak1.pak ## registered data
+├── s0.sav
+├── s1.sav
+├── music/
+│   ├── track02.ogg
+│   ├── ...
+│   └── track11.ogg
+│
+hipnotic/
+├── pak0.pak
+├── s0.sav
+├── s1.sav
+├── music/
+│   ├── track02.ogg
+│   ├── ...
+│   └── track09.ogg
+│
+rogue/
+├── pak0.pak
+├── s0.sav
+├── s1.sav
+├── music/
+│   ├── track02.ogg
+│   ├── ...
+│   └── track09.ogg
+│
+dopa/
+├── pak0.pak
+├── s0.sav
+└── s1.sav
+```
+
+## Soundtrack files
+
+TyrQuake supports playback of the original soundtrack from the base game and official mission packs' CDs.
+
+CD audio should be ripped into OGG format files, and placed into a subfolder named music of the appropriate folder (id1, hipnotic or rogue). The ripped CD tracks must be named trackXX.ogg, corresponding to the original CD track index for each audio track. Considering that the first CD track in all cases is the data track, the first audio track will always begin with track 02, which should be reflected in the filename of the ripped audio files.
+
 ## Username

 The TyrQuake core uses RetroArch's username setting for the in-game player name.
@ -116,7 +153,7 @@ Settings with (Restart) means that core has to be closed for the new setting to

 - **Colored lighting (restart)** [tyrquake_colored_lighting] (**disabled**|enabled)

-	Awaiting description.
+	Enables colored lightning when the loaded content supports it.
 	
 - **Resolution (restart)** [tyrquake_resolution] (**320x200**|640x400|960x600|1280x800|1600x1000|1920x1200|320x240|320x480|360x200|360x240|360x400|360x480|400x224|480x272|512x224|512x240|512x384|512x512|640x224|640x240|640x448|640x480|720x576|800x480|800x600|960x720|1024x768|1280x720|1600x900|1920x1080)

@ -136,18 +173,16 @@ Settings with (Restart) means that core has to be closed for the new setting to

 	Invert RetroPad Right Analog Y Axis.
 	
-## Controllers
+## User 1 device types

 The TyrQuake core supports the following device type(s) in the controls menu, bolded device types are the default for the specified user(s):

-### User 1 device types
-
 - None - Input disabled.
- **Gamepad Classic** - Joypad - Optional description.
- **Gamepad Modern** - Joypad - Optional description.
+- **Gamepad Classic** - Joypad
+- **Gamepad Modern** - Joypad
 - **Keyboard + Mouse** - Keyboard and Mouse - Switch to this for keyboard and mouse input. Has keymapper support.

-### Rumble support
+## Rumble support

 Rumble only works in the TyrQuake core when

@ -156,9 +191,7 @@ Rumble only works in the TyrQuake core when
 - The joypad device being used has rumble support.
 - The ['Rumble' core option](https://docs.libretro.com/library/tyrquake/#core-options) is set to enabled.

-### Controller tables
-
-#### Joypad
+## Joypad

 | User 1 Remap descriptors for 'Gamepad Classic' device type | RetroPad Inputs                                | TyrQuake inputs   |
 |------------------------------------------------------------|------------------------------------------------|-------------------|
@ -206,6 +239,14 @@ Rumble only works in the TyrQuake core when
 |                                                           | ![](../image/retropad/retro_right_stick.png) X | Look Left/Right   |
 |                                                           | ![](../image/retropad/retro_right_stick.png) Y | Look Up/Down      |

+## Keyboard
+
+- Keyboard binds are in config.cfg
+
+## Mouse
+
+- Mouse binds are in config.cfg
+
 ## External Links

 - [Official TyrQuake Website](http://disenchant.net/tyrquake/)
@ -214,8 +255,6 @@ Rumble only works in the TyrQuake core when
 - [Libretro TyrQuake Github Repository](https://github.com/libretro/tyrquake)
 - [Report Libretro TyrQuake Core Issues Here](https://github.com/libretro/tyrquake/issues)

-### See also
-
-#### id Software
+## id Software

 - [Doom (PrBoom)](https://docs.libretro.com/library/prboom/)