Skip to content

Commit dff575b

Browse files
docs updates
1 parent 364f9bf commit dff575b

File tree

4 files changed

+14
-10
lines changed

4 files changed

+14
-10
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ I like to put any Quake map release into its own gamedir, even vanilla bsp-only
7070

7171
> To evangelize briefly: Keeping each release in its own gamedir lets me see at a glance what I've currently installed, makes it obvious which savegames and bits of configuration are relevant to which releases, makes "uninstallation" braindead-simple, and also makes it possible to do some automated installation and launching with a pretty lightweight script.
7272
73-
One consequence is that non-standalone Arcane Dimensions and Copper releases installed this way cannot be launched *unless* you are using a Quake engine like [FTE](http://fte.triptohell.info/), [Quakespasm-Spiked](http://triptohell.info/moodles/qss/), [vkQuake](https://github.com/Novum/vkQuake), [Ironwail](https://github.com/andrei-drexler/ironwail), or [DarkPlaces](https://icculus.org/twilight/darkplaces/) that supports specifying multiple "game" directories to use when loading a mod or maps. See the "Arcane Dimensions and Copper" section of [scripts/README.md](scripts/README.md) for more details.
73+
One consequence is that non-standalone releases that depend on Arcane Dimensions, Copper, or Alkaline cannot be installed and launched in this way *unless* you are using a Quake engine like [FTE](http://fte.triptohell.info/), [Quakespasm-Spiked](http://triptohell.info/moodles/qss/), [vkQuake](https://github.com/Novum/vkQuake), [Ironwail](https://github.com/andrei-drexler/ironwail), or [DarkPlaces](https://icculus.org/twilight/darkplaces/) that supports specifying multiple "game" directories to use when loading a mod or maps. See the "Arcane Dimensions, Copper, and Alkaline" section of [scripts/README.md](scripts/README.md) for more details.
7474

7575
## Some assembly required
7676

browser_integration/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ These are the files necessary to set up Chrome to auto-install-and-run a Quake m
44

55
Because of the limitations on Chrome extensions, we can't quite implement a feature that would do "download this file and then open it with the desired app". What we *can* do is make Chrome put a special file extension ".qz" on the downloaded file, and we can associate ".qz" with our Quake app. Then once the file is downloaded you can click to open it from the Chrome downloads shelf, or even set Chrome to auto-open all ".qz" files when downloaded. This will give you the browser-integration behavior described in the [top-level readme](../README.md).
66

7-
Keep in mind that for non-standalone Arcane Dimensions and Copper releases, this feature requires a Quake engine like [FTE](http://fte.triptohell.info/), [Quakespasm-Spiked](http://triptohell.info/moodles/qss/), [vkQuake](https://github.com/Novum/vkQuake), [Ironwail](https://github.com/andrei-drexler/ironwail) or [DarkPlaces](https://icculus.org/twilight/darkplaces/) that supports specifying multiple "game" directories to use when loading a mod or maps. (See the "Arcane Dimensions and Copper" section of the [scripts readme](../scripts/README.md) for more details.) If you don't have that capability, and you try to do "Open with Quake" on a browser link to such an AD/Copper release, then after the download you'll get a desktop notification about the error and the gamedir will not be launched.
7+
Keep in mind that for non-standalone releases that depend on Arcane Dimensions, Copper, or Alkaline, this feature requires a Quake engine like [FTE](http://fte.triptohell.info/), [Quakespasm-Spiked](http://triptohell.info/moodles/qss/), [vkQuake](https://github.com/Novum/vkQuake), [Ironwail](https://github.com/andrei-drexler/ironwail) or [DarkPlaces](https://icculus.org/twilight/darkplaces/) that supports specifying multiple "game" directories to use when loading a mod or maps. (See the "Arcane Dimensions, Copper, and Alkaline" section of the [scripts readme](../scripts/README.md) for more details.) If you don't have that capability, and you try to do "Open with Quake" on a browser link to such an AD/Copper/Alkaline release, then after the download you'll get a desktop notification about the error and the gamedir will not be launched.
88

99
# Setup
1010

scripts/README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -108,21 +108,25 @@ If the script can't figure out which map to load, just use the console as usual
108108

109109
## Quoth and missionpacks
110110

111-
If the gamedir contains a document that mentions a dependency on quoth, hipnotic, or rogue, then "quakelaunch" will honor that dependency when launching it... unless the gamedir appears to be "standalone" i.e. comes with its own progs.dat.
111+
If a gamedir does not come with its own progs.dat (game logic), then it might depend on assets that need to be loaded from some other gamedir (a "base" gamedir). "quakelaunch" will do its best to figure out whether such a dependency exists.
112+
113+
For example, if the files in the archive were originally organized so that Quake-specific folders like "maps" were inside a folder named "quoth", "hipnotic", or "rogue", then quakelaunch will assume that this release has a dependency on Quoth, missionpack 1, or missionpack 2 respectively.
114+
115+
If the folder organization didn't reveal any dependency -- or if this is a first-time launch of a gamedir that was not unpacked and installed by "quakelaunch" itself -- then "quakelaunch" will also check to see if the gamedir contains a document that mentions quoth, hipnotic, or rogue.
112116

113117
An attempt to launch a gamedir with such a dependency will stop with an error if the necessary base gamedir is not present.
114118

115-
## Arcane Dimensions and Copper
119+
## Arcane Dimensions, Copper, and Alkaline
116120

117-
"quakelaunch" will similarly look in docs for mentions of Copper (unless the gamedir is standalone). If it finds such a mention, that will be interpreted as a dependency on that mod.
121+
"quakelaunch" will similarly look for dependencies on Arcane Dimensions, Copper, and Alkaline. As with the Quoth/missionpacks stuff described above, if the "maps" etc. folders were originally contained in a folder named "ad", "copper", or "alkaline" then that will signal a dependency.
118122

119-
For Arcane Dimensions, instead of examining the docs it will look to see if there is a bsp filename that starts with the "ad_" prefix... that turns out to be a 100% reliable indicator (so far) of a dependency on AD.
123+
If necessary "quakelaunch" will also look in docs for mentions of Copper or Alkaline. For Arcane Dimensions, instead of examining the docs it will look to see if there is a bsp filename that starts with the "ad_" prefix... that turns out to be an almost completely reliable indicator (so far) of a dependency on AD.
120124

121-
Unlike the situation with Quoth and missionpack dependencies however, not all Quake engines can handle launching non-standalone AD/Copper-dependent content that is installed in its own separate gamedir. If you have a Quake engine that can do it, you can set the relevant options in your "quakelaunch.conf" file. I do know that recent releases of [FTE](http://fte.triptohell.info/), [Quakespasm-Spiked](http://triptohell.info/moodles/qss/), [vkQuake](https://github.com/Novum/vkQuake), [Ironwail](https://github.com/andrei-drexler/ironwail), and [DarkPlaces](https://icculus.org/twilight/darkplaces/) can do it, and I've included examples in the conf file that work with those engines.
125+
Unlike the situation with Quoth and missionpack dependencies however, not all Quake engines can handle launching non-standalone AD/Copper/Alkaline-dependent content that is installed in its own separate gamedir. If you have a Quake engine that can do it, you can set the relevant options in your "quakelaunch.conf" file. I do know that recent releases of [FTE](http://fte.triptohell.info/), [Quakespasm-Spiked](http://triptohell.info/moodles/qss/), [vkQuake](https://github.com/Novum/vkQuake), [Ironwail](https://github.com/andrei-drexler/ironwail), and [DarkPlaces](https://icculus.org/twilight/darkplaces/) can do it, and I've included examples in the conf file that work with those engines.
122126

123127
(BTW if you are making your own build of Quakespasm, [multigame-support.md](multigame-support.md) describes how you can add this capability to Quakespasm.)
124128

125-
If you try to launch a non-standalone gamedir that depends on AD or Copper, and you are **not** set up in quakelaunch.conf to handle AD/Copper as a base gamedir, you'll get an error message and the gamedir will not be launched. You can override this behavior if you want, by editing the per-gamedir config (see below).
129+
If you try to launch a non-standalone gamedir that depends on AD/Copper/Alkaline, and you are **not** set up in quakelaunch.conf to handle AD/Copper/Alkaline as a base gamedir, you'll get an error message and the gamedir will not be launched. You can override this behavior if you want, by editing the per-gamedir config (see below).
126130

127131
## Per-gamedir configs
128132

scripts/multigame-support.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This may be interesting to you if you are compiling your own build of Quakespasm
44

55
## What's the problem?
66

7-
As mentioned in the [readme](README.md), it's handy to have "multiple gamedir" support in Quake. That allows you to easily work with foundational mods like Arcane Dimensions and Copper which have additional map releases based on them. You can keep those "other releases" in their own separate gamedirs and just instruct Quake to use the foundational mod as a base gamedir to build on top of.
7+
As mentioned in the [readme](README.md), it's handy to have "multiple gamedir" support in Quake. That allows you to easily work with foundational mods like Arcane Dimensions, Copper, and Alkaline which can have additional map releases based on them. You can keep those "other releases" in their own separate gamedirs and just instruct Quake to use the foundational mod as a base gamedir to build on top of.
88

99
Any modern Quake engine that is meant for singleplayer will support this nice behavior for Quoth. You can just give it the "-quoth" argument to indicate that a gamedir depends on Quoth. For example if you have a gamedir named "ne_tower" that depends on your "quoth" gamedir as a foundation, you can launch Quake with the arguments "-quoth -game ne_tower".
1010

@@ -16,7 +16,7 @@ Happily a couple of other engines have also taken this feature onboard in recent
1616

1717
If you're using a Quake engine that supports this feature, you can specify the "ad_basegame_args" and "copper_basegame_args" values in quakelaunch.conf to handle automatic installation of releases that depend on Arcane Dimensions or Copper.
1818

19-
If you're using a Quake engine that does **not** support this feature, you have to manually do file-merges of AD or Copper releases into the main AD or Copper directory.
19+
If you're using a Quake engine that does **not** support this feature, you have to manually do file-merges of AD/Copper/Alkaline-based releases into the main AD/Copper/Alkaline directory.
2020

2121
## What's the solution?
2222

0 commit comments

Comments
 (0)