aboutsummaryrefslogtreecommitdiff
path: root/games/doomretro/README
diff options
context:
space:
mode:
Diffstat (limited to 'games/doomretro/README')
-rw-r--r--games/doomretro/README20
1 files changed, 20 insertions, 0 deletions
diff --git a/games/doomretro/README b/games/doomretro/README
new file mode 100644
index 0000000000000..04d2a756e7a55
--- /dev/null
+++ b/games/doomretro/README
@@ -0,0 +1,20 @@
+DOOM Retro is the classic, refined DOOM source port. It represents what DOOM
+should be today, in all its dark, gritty, unapologetically pixellated glory.
+DOOM Retro's source code is forked from Chocolate DOOM, with enhancements from
+other DOOM source ports, as well as many orignal ideas. DOOM Retro is
+deliberately minimalist by design, and does a few things differently when
+compared with other source ports.
+
+For MIDI playback, first build and install FluidSynth, then build and install
+SDL_mixer (so that it has FluidSynth support), and then build and install DOOM
+Retro. Then, before starting DOOM Retro, set the SDL_SOUNDFONTS environment
+variable to the path to a soundfont in sf2 format.
+
+i.e.
+
+ export SDL_SOUNDFONTS=/path/to/soundfonts.sf2
+
+Settings are stored in $HOME/.config/doomretro. You will find an editable
+doomretro.cfg there.
+
+There is a bonus episode, "breach", in /usr/share/doomretro/breach.