[game-data-packager] 01/12: Redo README.foo-data
Simon McVittie
smcv at debian.org
Mon Jul 3 22:42:13 UTC 2017
This is an automated email from the git hooks/post-receive script.
smcv pushed a commit to branch master
in repository game-data-packager.
commit ca6b0991e9ac414dd6492005e486d38b6874c582
Author: Simon McVittie <smcv at debian.org>
Date: Mon Jul 3 10:48:44 2017 +0100
Redo README.foo-data
- move from runtime/ to doc/
- write more game-specific text
- install via *.docs, not *.install
- fix broken symlinks (Closes: #866875)
---
debian/etqw-server.docs | 2 ++
debian/etqw-server.install | 1 -
debian/etqw.docs | 2 ++
debian/etqw.links | 1 -
debian/quake-server.docs | 1 +
debian/quake.docs | 1 +
debian/quake2-server.docs | 1 +
debian/quake2.docs | 1 +
debian/quake3-server.docs | 1 +
debian/quake3-server.install | 1 -
debian/quake3.docs | 1 +
debian/quake3.links | 1 -
debian/quake4-server.docs | 2 ++
debian/quake4-server.install | 1 -
debian/quake4.docs | 2 ++
debian/quake4.links | 1 -
doc/README.etqw-data | 28 ++++++++++++++++++
doc/README.quake-data | 56 ++++++++++++++++++++++++++++++++++++
doc/README.quake2-data | 57 +++++++++++++++++++++++++++++++++++++
doc/README.quake3-data | 46 ++++++++++++++++++++++++++++++
{runtime => doc}/README.quake4-data | 14 +++++++++
runtime/README.etqw-data | 5 ----
runtime/README.quake3-data | 8 ------
23 files changed, 215 insertions(+), 19 deletions(-)
diff --git a/debian/etqw-server.docs b/debian/etqw-server.docs
new file mode 100644
index 0000000..c7de171
--- /dev/null
+++ b/debian/etqw-server.docs
@@ -0,0 +1,2 @@
+doc/README.etqw-data
+
diff --git a/debian/etqw-server.install b/debian/etqw-server.install
index e5897ce..addf521 100644
--- a/debian/etqw-server.install
+++ b/debian/etqw-server.install
@@ -1,4 +1,3 @@
-runtime/README.etqw-data usr/share/doc/etqw-server
usr/games/etqw-dedicated
usr/lib/etqw/etqw-dedicated
usr/lib/etqw/gdp_launcher_version.py
diff --git a/debian/etqw.docs b/debian/etqw.docs
new file mode 100644
index 0000000..c7de171
--- /dev/null
+++ b/debian/etqw.docs
@@ -0,0 +1,2 @@
+doc/README.etqw-data
+
diff --git a/debian/etqw.links b/debian/etqw.links
deleted file mode 100644
index e2edf72..0000000
--- a/debian/etqw.links
+++ /dev/null
@@ -1 +0,0 @@
-usr/lib/etqw/README.etqw-data usr/share/doc/etqw/README.etqw-data
diff --git a/debian/quake-server.docs b/debian/quake-server.docs
new file mode 100644
index 0000000..2a1f9b7
--- /dev/null
+++ b/debian/quake-server.docs
@@ -0,0 +1 @@
+doc/README.quake-data
diff --git a/debian/quake.docs b/debian/quake.docs
index 034e8f9..92ec64b 100644
--- a/debian/quake.docs
+++ b/debian/quake.docs
@@ -1 +1,2 @@
debian/q1/policy.txt
+doc/README.quake-data
diff --git a/debian/quake2-server.docs b/debian/quake2-server.docs
new file mode 100644
index 0000000..82674cf
--- /dev/null
+++ b/debian/quake2-server.docs
@@ -0,0 +1 @@
+doc/README.quake2-data
diff --git a/debian/quake2.docs b/debian/quake2.docs
index 034e8f9..b379621 100644
--- a/debian/quake2.docs
+++ b/debian/quake2.docs
@@ -1 +1,2 @@
debian/q1/policy.txt
+doc/README.quake2-data
diff --git a/debian/quake3-server.docs b/debian/quake3-server.docs
new file mode 100644
index 0000000..e9a0892
--- /dev/null
+++ b/debian/quake3-server.docs
@@ -0,0 +1 @@
+doc/README.quake3-data
diff --git a/debian/quake3-server.install b/debian/quake3-server.install
index 0539a71..843eb8d 100644
--- a/debian/quake3-server.install
+++ b/debian/quake3-server.install
@@ -1,6 +1,5 @@
debian/q3/server.cfg etc/quake3-server
debian/quake3-server at .service lib/systemd/system
-runtime/README.quake3-data usr/share/doc/quake3-server
usr/games/quake3-server
usr/share/games/game-data-packager-runtime/launch-quake3-server.json
usr/share/games/quake3/gdp_launcher_version.py
diff --git a/debian/quake3.docs b/debian/quake3.docs
new file mode 100644
index 0000000..e9a0892
--- /dev/null
+++ b/debian/quake3.docs
@@ -0,0 +1 @@
+doc/README.quake3-data
diff --git a/debian/quake3.links b/debian/quake3.links
index 2d16fb9..fe641d8 100644
--- a/debian/quake3.links
+++ b/debian/quake3.links
@@ -1,2 +1 @@
-usr/share/games/quake3/README.quake3-data usr/share/doc/quake3/README.quake3-data
usr/share/icons/hicolor/256x256/apps/quake3.png usr/share/pixmaps/quake3.png
diff --git a/debian/quake4-server.docs b/debian/quake4-server.docs
new file mode 100644
index 0000000..f9e0e78
--- /dev/null
+++ b/debian/quake4-server.docs
@@ -0,0 +1,2 @@
+doc/README.quake4-data
+
diff --git a/debian/quake4-server.install b/debian/quake4-server.install
index bb6a147..6d5f3fc 100644
--- a/debian/quake4-server.install
+++ b/debian/quake4-server.install
@@ -1,6 +1,5 @@
debian/apparmor.d/usr.lib.quake4.q4ded.x86 etc/apparmor.d
debian/q4/server.cfg etc/quake4-server
-runtime/README.quake4-data usr/share/doc/quake4-server
usr/games/quake4-dedicated
usr/share/games/game-data-packager-runtime/launch-quake4-dedicated.json
usr/share/games/quake4/gdp_launcher_version.py
diff --git a/debian/quake4.docs b/debian/quake4.docs
new file mode 100644
index 0000000..f9e0e78
--- /dev/null
+++ b/debian/quake4.docs
@@ -0,0 +1,2 @@
+doc/README.quake4-data
+
diff --git a/debian/quake4.links b/debian/quake4.links
deleted file mode 100644
index 1aa37a2..0000000
--- a/debian/quake4.links
+++ /dev/null
@@ -1 +0,0 @@
-usr/lib/quake4/README.quake4-data usr/share/doc/quake4/README.quake4-data
diff --git a/doc/README.etqw-data b/doc/README.etqw-data
new file mode 100644
index 0000000..e70e16f
--- /dev/null
+++ b/doc/README.etqw-data
@@ -0,0 +1,28 @@
+Installing Enemy Territory: Quake Wars game data
+================================================
+
+Please use game-data-packager to build and install the etqw-data and
+etqw-bin packages.
+
+These packages require the commercial game data files from Enemy
+Territory: Quake Wars. The official patch for version 1.5
+is also required, but can be downloaded automatically.
+
+Typical uses:
+
+ game-data-packager -d ~/Downloads etqw /path/to/search
+ Save the generated package to ~/Downloads to install later
+
+ game-data-packager --install etqw /path/to/search
+ Install the generated package, do not save it for later
+
+game-data-packager will automatically search various common installation
+paths. If you are installing from a CD-ROM or a non-standard location,
+add the installation path or CD-ROM mount point to the command line.
+
+Add the path to ETQW-client-1.5-full.x86.run, ETQW-client-1.0-1.5-update.exe
+or ETQW-client-1.4-1.5-update.x86.run to the game-data-packager command line
+if you already have them available locally, to avoid re-downloading them.
+
+For more details please see the output of "game-data-packager etqw --help"
+or the game-data-packager(6) man page.
diff --git a/doc/README.quake-data b/doc/README.quake-data
new file mode 100644
index 0000000..4e44b6e
--- /dev/null
+++ b/doc/README.quake-data
@@ -0,0 +1,56 @@
+Installing Quake data
+=====================
+
+Please use game-data-packager to build and install the quake-registered
+or quake-shareware package. Only one version at a time can be installed.
+
+For quake-registered you will need a Quake CD-ROM, or at least id1/pak1.pak
+from a Quake installation. game-data-packager can download all other
+necessary files. Typical uses:
+
+ game-data-packager -d ~/Downloads quake /path/to/search
+ Save the generated package to ~/Downloads to install later
+
+ game-data-packager --install quake /path/to/search
+ Install the generated package, do not save it for later
+
+game-data-packager will automatically search various common installation
+paths. If you are installing from a CD-ROM or a non-standard location,
+add the installation path or CD-ROM mount point to the command line.
+
+If you have other game files available locally, you can reduce downloading
+by adding the path to id1/pak0.pak version 1.06, quake106.zip,
+setup_quake_the_offering_2.0.0.6.exe or resource.1 to the command line.
+
+For more details please see the output of "game-data-packager quake3 --help"
+or the game-data-packager(6) man page.
+
+Shareware version
+=================
+
+For the shareware version, run something like this:
+
+ game-data-packager -d ~/Downloads quake --demo
+
+and add the path to quake106.zip to the command line if you already have it.
+
+Music
+=====
+
+For the music, either provide a directory containing pre-ripped
+audio named like id1/music/track02.ogg, hipnotic/music/track02.ogg or
+rogue/music/track02.ogg, or use syntax like
+
+ game-data-packager -d ~/Downloads quake --package=quake-music /dev/cdrom
+
+to rip and encode CD audio tracks.
+
+You might be able to download suitable audio files here:
+https://steamcommunity.com/sharedfiles/filedetails/?id=119489135
+
+Expansions
+==========
+
+If you have the expansions Scourge of Armagon (hipnotic), Dissolution
+of Eternity (rogue) or Dimensions of the Past (dopa), add their
+installation directories or CD-ROM mount points to the command line.
diff --git a/doc/README.quake2-data b/doc/README.quake2-data
new file mode 100644
index 0000000..55f0182
--- /dev/null
+++ b/doc/README.quake2-data
@@ -0,0 +1,57 @@
+Installing Quake II data
+========================
+
+Please use game-data-packager to build and install the quake2-full-data
+or quake2-demo-data package.
+
+For quake2-demo-data you will need a Quake II CD-ROM, or at least
+baseq2/pak0.pak and the baseq2/video directory from a Quake II
+installation. game-data-packager can download all other
+necessary files. Typical uses:
+
+ game-data-packager -d ~/Downloads quake2 /path/to/search
+ Save the generated package to ~/Downloads to install later
+
+ game-data-packager --install quake2 /path/to/search
+ Install the generated package, do not save it for later
+
+game-data-packager will automatically search various common installation
+paths. If you are installing from a CD-ROM or a non-standard location,
+add the installation path or CD-ROM mount point to the command line.
+
+If you have other game files available locally, you can reduce downloading
+by adding the path to q2-3.20-x86-full-ctf.exe, or a fully patched version
+3.20 such as the one distributed by Steam, to the command line.
+
+For more details please see the output of "game-data-packager quake3 --help"
+or the game-data-packager(6) man page.
+
+Demo version
+============
+
+For the demo version, run something like this:
+
+ game-data-packager -d ~/Downloads quake2 --demo
+
+and add the path to q2-314-demo-x86.exe to the command line if you
+already have it.
+
+Music
+=====
+
+For the music, either provide a directory containing pre-ripped
+audio named like baseq2/music/02.ogg, xatrix/music/02.ogg or
+rogue/music/02.ogg, or use syntax like
+
+ game-data-packager -d ~/Downloads quake2 --package=quake2-music /dev/cdrom
+
+to rip and encode CD audio tracks.
+
+You might be able to download suitable audio files here:
+https://steamcommunity.com/app/2320/discussions/0/864974467511619676/
+
+Expansions
+==========
+
+If you have the expansions The Reckoning (xatrix) or Ground Zero (rogue),
+add their installation directories or CD-ROM mount points to the command line.
diff --git a/doc/README.quake3-data b/doc/README.quake3-data
new file mode 100644
index 0000000..012dfc1
--- /dev/null
+++ b/doc/README.quake3-data
@@ -0,0 +1,46 @@
+Installing Quake III Arena data
+===============================
+
+Please use game-data-packager to build and install the quake3-data
+or quake3-demo-data package.
+
+For quake3-data you will need at least baseq3/pak0.pk3 (479493658 bytes)
+from a Quake III Arena CD-ROM or installation.
+game-data-packager can download all other necessary files. Typical uses:
+
+ game-data-packager -d ~/Downloads quake3 /path/to/search
+ Save the generated package to ~/Downloads to install later
+
+ game-data-packager --install quake3 /path/to/search
+ Install the generated package, do not save it for later
+
+game-data-packager will automatically search various common installation
+paths. If you are installing from a CD-ROM or a non-standard location,
+add the installation path or CD-ROM mount point to the command line.
+
+Add the path to linuxq3apoint-1.32b-3.x86.run to the game-data-packager
+command line if you already have it available locally, to avoid
+re-downloading it.
+
+For more details please see the output of "game-data-packager quake3 --help"
+or the game-data-packager(6) man page.
+
+Quake III Team Arena expansion
+==============================
+
+Add a directory containing missionpack/pak0.pk3 to the game-data-packager
+command line if you have Quake III Team Arena available.
+
+Quake III Arena demo
+====================
+
+For quake3-demo-data (experimental) only downloadable files are required.
+Typical use:
+
+ game-data-packager --install quake3 --demo
+
+Add the paths to linuxq3ademo-1.11-6.x86.gz.sh and
+linuxq3apoint-1.32b-3.x86.run to the game-data-packager command line if
+you already have them available locally. Both of those files are needed:
+the retail patch is needed to modify the demo data to be compatible with
+the ioquake3 engine.
diff --git a/runtime/README.quake4-data b/doc/README.quake4-data
similarity index 52%
rename from runtime/README.quake4-data
rename to doc/README.quake4-data
index a8be9e4..96d8865 100644
--- a/runtime/README.quake4-data
+++ b/doc/README.quake4-data
@@ -1,3 +1,6 @@
+Installing Quake 4 game data
+============================
+
Use game-data-packager to build and install the quake4-data
or quake4-de-data package.
@@ -11,3 +14,14 @@ other versions.
Both packages depend on quake4-common-data and quake4-bin, which can
also be built using game-data-packager.
+
+Typical uses:
+
+ game-data-packager -d ~/Downloads quake4 /path/to/search
+ Save the generated package to ~/Downloads to install later
+
+ game-data-packager --install quake4 /path/to/search
+ Install the generated package, do not save it for later
+
+For more details please see the output of "game-data-packager quake4 --help"
+or the game-data-packager(6) man page.
diff --git a/runtime/README.etqw-data b/runtime/README.etqw-data
deleted file mode 100644
index 23b1fa0..0000000
--- a/runtime/README.etqw-data
+++ /dev/null
@@ -1,5 +0,0 @@
-Please use game-data-packager to build and install the etqw-data and
-etqw-bin packages.
-
-These packages require the commercial game data files from Enemy
-Territory: Quake Wars.
diff --git a/runtime/README.quake3-data b/runtime/README.quake3-data
deleted file mode 100644
index 68299d5..0000000
--- a/runtime/README.quake3-data
+++ /dev/null
@@ -1,8 +0,0 @@
-Use game-data-packager to build and install the quake3-data
-or quake3-demo-data package.
-
-For quake3-data you will need at least baseq3/pak0.pk3 (479493658 bytes)
-from a Quake III Arena CD or installation.
-game-data-packager can download all other necessary files.
-
-For quake3-demo-data (experimental) only downloadable files are required.
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-games/game-data-packager.git
More information about the Pkg-games-commits
mailing list