diff --git a/README.md b/README.md index 9403601..32a471a 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,55 @@ # Quake2-GOG-TrackLinker -A bash script for correctly linking the games and music tracks and expansions within the GOG release of Quake II: Quad Damage. \ No newline at end of file +A bash script for correctly linking the games and music tracks and expansions +within the GOG release of _Quake II: Quad Damage_. + +## I don't get it. + +Basically, GOG or Bethesda goofed the release of _Quake 2: Quad Damage_ a +little bit. On the assumption that many of the tracks are shared between games +(_Quake II: The Reckoning_ includes some tracks from _Quake II_ alongside new +ones, and similarly _Ground Zero_ mixes tracks from the previous expansion with +its own) the GOG release just... tosses the lot into a single folder, and this +has resulted in a few problems, namely that the files are a pain to carry over +into a source port. None of them are going to know which track is which as a +result! + +## So what does this do? +This script sets up the appropriate folders within each game's folder and +creates a bunch of symbolic links to the correct OGG files within the music +folder provided by GOG. It's a great deal better than copying the actual files +themselves because that would be a waste of disk space. Yes, I know this is the +age of gods-knows-how-many-terabytes hard drives, but it's the PRINCIPLE of the +thing! >:( + +## Okay, so how do I use this? + +First thing's first, you'll need to install the following, if you haven't done +so already: +* git +* innoextract + +These are usually available in some up-to-date form on your distro's package +manage. Once that's done: + +* Since Bethesda doesn't have the basic decency to provide a Linux installer +you'll need to download the sole Windows one and save it somewhere. Preferably +its own folder so that the next few steps don't conflict with its contents. +* In a terminal `cd` to the folder you downloaded the installer to and then run +`innoextract `. This'll extract and dump everything into +a folder called `app`. +* Install your _Quake II_ source port of choice. I can't help you with this one +because they're all different! D: +* Copy the `baseq2`, `xatrix`, `rogue` and `music` folders into your source +port's folder as per the source port's instructions. +* You may need to rename the OGG files in the `music` folder to remove `Track` +from their names and make sure track numbers lower than 10 have a leading zero +(for example, `02.ogg`, not `2.ogg`) +* `cd` to that source port folder and then run `git clone +https://git.diskseven.com/TrollDecker/Quake2-GOG-TrackLinker.git` +* Now while remaining in the source port's root folder (that means don't move!) +enter `chmod +x Quake2-GOG-TrackLinker/linktracks.sh`. That'll make the script +executable. +* Finally, you can type `Quake2-GOG-TrackLinker/linktracks.sh` to run the +script. Hopefully, all should go well. And if it doesn't... that's not a bridge +that's been crossed yet. :\