games/jfsw: Enhance script and documentation.

Signed-off-by: B. Watson <yalhcru@gmail.com>

1 files changed, 28 insertions, 12 deletions

diff --git a/games/jfsw/README b/games/jfsw/README
index e9b566f2a2..e15b0a810e 100644
--- a/games/jfsw/README
+++ b/games/jfsw/README
@@ -4,22 +4,38 @@ The aim of this port is to present Shadow Warrior as closely as possible
 to the original game while adding optional features to expand the
 possibilities of the game.
 
-To play the game, you will need the sw.grp data file from either the
-full or shareware DOS version of Shadow Warrior. If you want to play the
-shareware version, you can install jfsw_demo_data from slackbuilds.org.
-For the full version, copy sw.grp from the game directory to
-/usr/share/games/jfsw/sw.grp (the filename must be lowercase).
+To play the game, you will need at least one ".grp" game data file.
+Choices are:
 
-If you have sw.grp from the full version of the game, you may also want
-to install jfsw_hires_pack for some graphic enhancements (don't bother
-trying if all you have is the shareware sw.grp: it segfaults on startup).
+- jfsw_demo_data, the Demo/Shareware version. Only 4 levels.
+- jfsw_registered_data, the Full/Registered version. Complete game,
+  including the 4 levels from the demo.
+- jfsw_wanton_destruction, the Wanton Destruction expansion pack.
+  Includes 12 new levels, plus the 4 levels from the demo.
 
-Optional dependencies: SDL2 and/or fluidsynth. These will be autodetected
-and used if they are installed. SDL2 provides a slightly better user
-experience (YMMV), but fluidsynth doesn't actually seem to *do* anything
-for jfsw.
+Any or all of the game data packages can be installed at the same time
+without conflict.
+
+There is another expansion pack, Twin Dragon, which is not supported
+by jfsw.
+
+If you install the full version of the game, you may also want to install
+jfsw_hires_pack for some graphic enhancements. Don't bother trying if
+all you have is the shareware sw.grp: it segfaults on startup.
+
+Optional dependencies: SDL2 and/or fluidsynth. These will be autodetected.
+If you want to force building without them, you can export SDL2=no
+and/or FLUID=no in the environment. SDL2 provides a slightly better user
+experience (YMMV). See README_music.txt for details on using fluidsynth
+with jfsw.
+
+To get the in-game music to play, see README_music.txt.
 
 Note: If you run into an issue turning left or right with the mouse,
 edit the config file (~/.jfsw/sw.cfg) and change MouseAnalogAxes0 to
 "analog_turning" and MouseAnalogAxes1 to "analog_moving". The digital
 axes should have "" values.
+
+Note: I've had zero luck trying to run game mods with jfsw. If you get any
+mods working, I'd love to hear from you (email address in .info file),
+let me know how you did it.