summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorFranklin Wei <git@fwei.tk>2018-03-18 19:22:42 -0400
committerFranklin Wei <git@fwei.tk>2018-03-18 19:23:57 -0400
commitd5847e8cb2cf6eb5bc6929a13c95a1c563df8bc6 (patch)
treeb1f3ff54d72dfc35f65191c05178e18b355b3cbc
parent9006e75cde6ad92fd542715ba9013e01a13bbe8d (diff)
downloadrockbox-d5847e8cb2cf6eb5bc6929a13c95a1c563df8bc6.tar.gz
rockbox-d5847e8cb2cf6eb5bc6929a13c95a1c563df8bc6.tar.bz2
rockbox-d5847e8cb2cf6eb5bc6929a13c95a1c563df8bc6.zip
duke3d: add manual entry
Oops. Apparently I neglected to add this and it's gone unnoticed until now. Change-Id: I938f14c3dfcc4336acca1517988fd096e11ab241
-rw-r--r--manual/plugins/duke3d.tex38
1 files changed, 38 insertions, 0 deletions
diff --git a/manual/plugins/duke3d.tex b/manual/plugins/duke3d.tex
new file mode 100644
index 0000000000..9214a4b717
--- /dev/null
+++ b/manual/plugins/duke3d.tex
@@ -0,0 +1,38 @@
+\subsection{Duke3D}
+
+This is a port of Duke Nukem 3D, derived from Fabien Sanglard's
+Chocolate Duke.
+
+\subsubsection{Installation}
+The \fname{.GRP} and \fname{.CON} files from an original installation of
+ the game must be placed in the \fname{/.rockbox/duke3d/} on your
+ device.
+
+\subsubsection{Music}
+In-game music will not work by default. For it to work, you must
+install a modified Timidity patchset in the
+\fname{/.rockbox/timidity/} directory on your device. There should be
+a \fname{/.rockbox/timidity/timidity.cfg} file located in this
+directory, along with the instrument files. You must edit the
+\fname{.cfg} file so that all the path names are absolute (i.e. in the
+form \fname{/.rockbox/timidity/instruments/*.cfg}).
+
+\subsubsection{Video}
+Rotation of the video output is possible by choosing the correct video
+option in the in-game menu. If your device's display is normally
+320x240, for example, choosing the 240x320 option will rotate the
+screen 90 degrees, and the keymap will be updated as well.
+
+\subsubsection{Caveats}
+Sound effects, enabled by default, could have a detrimental effect on
+playability on some devices. If you notice excessive lag, try
+disabling sound.
+
+The default button mapping may not be optimal for gameplay. Set a
+different mapping in the ``Keyboard'' section of the game setup. Note
+that not all keys are mappable on all devices.
+
+Some devices will low memory or large GRP files will prevent the game
+from completely caching the GRP file in RAM, which could lead to disk
+reads during gameplay. This might cause the game to lag slightly when
+it happens, which is normal. The game should resume in a second or so.