Bug#733750: Bug #733750: better advice for old versions of games (e.g. hexen2)

[Simon McVittie]

Control: tags 733750 + moreinfo

On Tue, 31 Dec 2013 at 15:41:56 +0000, Jonathan Dowland wrote:
> Additionally, I don't think we necessarily offer
> the clearest advice if you have an older, unpatched version of H2: we
> should at least point at how to upgrade your version (or obtain a
> patched version) if not walk through the patching itself within gdp.

I don't know how to recognise an older version of Hexen II, or how to
patch it (or whether we can patch it), because I only have the
pre-patched Steam version.

If you can tell us the exact sizes and checksums of the *bad* (unpatched)
version, then we'll be able to recognise it as a specifically bad version,
rather than just a version we don't know about. (You sent details of the
good/patched version to #733459, but as it happens, that matches the
known-good version from Steam.)

We do now have the ability to recognise old versions of files by their
checksum, and I've added a bunch of old versions' checksums to Wolf3D
and Doom. It looks like this:

% ./game-data-packager wolf3d -d . -n ~/tmp/wlf3dv10
WARNING:game-data-packager:"/home/smcv/tmp/wlf3dv10/VSWAP.WL1" matches known file "VSWAP.WL1_1.0" but cannot be used:
Wolfenstein 3D v1.4 is required, this file is from v1.0
... more files ...
WARNING:game-data-packager:"/home/smcv/tmp/wlf3dv10/AUDIOHED.WL1" matches known file "AUDIOHED.WL1_1.0" but cannot be used:
Wolfenstein 3D v1.4 is required, this file is from v1.0

It's not ideal that we log it once per file (it would be better if each
unique "bad version" was only logged once), but it's a start.

(I don't stop the packaging process immediately on recognising an
unsupported file, because if you have patched and unpatched game files
side by side - e.g. a set of all the versions of DOOM.WAD - you should
still be able to pack up the patched one by pointing to the common parent
directory.)

Also, the help text is now displayed at the end if we couldn't make any
packages at all. In the case of Hexen II, this does now say what you need:

  For hexen2-data, you must provide the version 1.11 patched versions
  of data1/pak0.pak and data1/pak1.pak, or a directory containing them.

  For the mission pack, Portal of Praevus, you must also provide
  portals/pak3.pak.

  Hexen II is available on Steam, <http://store.steampowered.com/app/9060/>.
  Steam installations would typically be found in:
  C:/Program Files/Steam/steamapps/common/Hexen 2

Is that enough to consider this bug resolved?

Regards,
    S