[ This is basically a re-release of the old version of SaveMung2;  I /think/
I fixed a couple of small problems sometime since the last release, but
I'm not sure.  Anyway, there should be a new version before too long... ]

Version 1.05 fixes a silly mistake in 1.04 that would cause compressed files
not to restore, even though there was nothing wrong with them.


!Help for SaveMung2
~~~~~~~~~~~~~~~~~~~

Upgrading from old versions
~~~~~~~~~~~~~~~~~~~~~~~~~~~
1. Move the Characters directory out of the old !SaveMung2 to a safe place.
2. Delete the old !SaveMung2.
3. Copy the new !SaveMung2 to where you want it (ie. where the old one was).
4. Move the Characters directory into the new !SaveMung2 (don't worry about
   there already being a Characters directory there).
5. I'm afraid that you have to reconfigure the new !SaveMung2.  Sorry, but
   after all, it's not *that* much work :-)


What is SaveMung2?
------------------
	Well, basically, SaveMung2 evolved from a hacky little proglette I
wrote called 'SaveMung'.  SaveMung would automatically handle taking backups
of my angband saved games (so I could restore from a backup if, for instance,
I died).  Then, I was bored one night, so here's SaveMung2.

	The best way to explain what SaveMung2 does is to give an example of
how it might be used...
	You're deep in the dungeons, and you've just got some lovely armour.
So, you hit ^S to save your game, click on SaveMung2's iconbar icon to take
a backup of the game, and continue playing.  Suddenly, from out of nowhere
comes a huge pack of Water Hounds.  Before you can despatch them they've
breathed acid at you so many times that you're down to AC -3 and very
unhappy.  Well, this is where SaveMung2 comes in... Save your current game and
exit (^X), then bring up SaveMung2's iconbar menu and select Restore. Hit the
OK button in the window that pops up, and presto, it's as if it never happened.

	What if you need to go back to an even older position? Well, SaveMung2
can store upto 77 positions for each character (you can alter the number that
will be saved), and each saved game is identified by the time that it was
'backed up' at, so you can easily choose an earlier position to restore from.

	To make matters even nicer, you can make SaveMung2 automatically run
your restored positions.


What does it do?
----------------
	When you have set SaveMung2 up correctly, simply clicking on its icon
will take a backup of your saved game.  Should you need to restore from a
backup, clicking menu & choosing 'Restore...' will pop up a window that
allows you to choose which backup to restore from (they are distinguished by
the 'timestamp' they are saved with).  This window works just like a normal
RISC OS 'Save As' window (well, mainly) so you can drag the icon, etc.
You'll probably just want to click 'OK' to restore the file to its old
name/path.  Notice the 'Auto Run' option button.  This is 'linked' to the
button in the configuration window - altering one alters both.  If auto run
is selected then the restored position will automatically be run.
*New* There's also a 'Kill Angband on Restore' option.  When selected,
after the restore has completed (but before running if Auto-Run is on), a
quit message will be sent to Angband.  This will quit Angband *without*
any chance to save your game (in effect, it's like selecting 'Quit' from
the TaskManager's Tasks window, and then clicking on Quit in Angband's
dialogue box).

Configuration
-------------
	Choosing 'Configure...' from the menu will pop up the configuration
window.  This window allows you to set the saved position path/file name (either
type the file & path names in explicitly [remember the '.' on the end of the
path!], or drag your saved game to the window to insert them automatically).
You can control whether backed up saved games are compressed.  The 'keep xx
positions' section lets you specify how many backed-up positions should be
stored.  If more than this number are stored, the earliest ones will be
deleted to bring the number down to within this limit. A good value for the
keep limit is 5.  Even with the best compression (gzip 9), a saved game may be
anywhere upto 50K or more in size, and if you don't use any compression,
don't be suprised when the saved positions eat more than 100K of disc
space each.  For all I have a large hard disc, I don't want to sacrifice
*megabytes* for saved games :-)

What's all this about compression?
----------------------------------
	The current release of SaveMung2 can use the following compression
methods:
		NAME:	Comment				bpcs	cr
		---------------------------------------------------
		RLE	Very fast but ineficient	2033	26%
		Squash	built into RO3			1050	37%
		Gzip 5	GNU zip (factor 5)		301	64%
		Gzip 9	GNU zip (factor 9)		280	65%
		Zip 5	Zip (factor 5)			270	64%
		Zip 9	Zip (factor 9)			256	65%

(Note: this release DOES NOT include Zip or GNU zip, if you don't already
have these utilities somewhere on your Run$Path, you won't be able to use
them)

The bpcs and cr figures were determined quite arbitrarily with one of my
saved games.  Bpcs is the average number bytes compressed per centisecond
[ie. the larger the faster], and cr is the compression ratio achieved.
As you can see, the golden rule of computing:
	"Cheap, fast, good - Pick any two."
applies.  RLE is very fast, but achieves a poor compression ratio.  Gzip
is very eficient, but slow.  Personally, I use RLE because I have a big
harddisc, and besides, I wrote the module that implements the compression
and I like to see it get some use :-)

If you get an error about "Not enough memory" or somesuch, you should drag the
next slot in the taskmanager up to about 200K or more and try again.  I'll fix
this for a future release, honest.


Note that the RLE file format was invented by me and is
completely arbitrary (it's actually based on the Squash file format).
The Zip, Gzip and Squash methods all produce valid files (so, for example,
you can dearchive them with the appropriate tool should you need to do so).


Whoah! I remember reading something about a bug in the Squash Module...
-----------------------------------------------------------------------
	Yep, so do I.  Anyway, call me paranoid, but I don't trust *any*
archiver further than I can comfortably spit a live (struggling) rhino. So,
if you have a little looksie in the Configure window, you'll notice a button
labelled 'Verify compressed file' (or somesuch).  If this option is on then
when any sort of compressed file is generated, it will be decompressed
appropriately and checked against the original saved game.  I've so far
never encountered a failure, but if there is a failure, you'll be notified.
This option does mean that backing up a saved game can take upto about 3
times as long, but eases those pangs of insecurity somewhat :-)


What about multiple characters?
-------------------------------
	If you have more than one character, don't worry, one of the
major enhancements SaveMung2 has over SaveMung is that it can cope with upto
77 characters (no prizes for guessing where that limit comes from).  Simply
set the name correctly in the configure window, or alternatively, if you drag
a saved game to the iconbar icon, this will count as setting the configuartion
AND clicking on the icon to start a backup.  The name under the icon is the
currently selected character.

Cleanliness is next to Godliness
--------------------------------
	Should you need to clean up after lots of characters, look inside the
Characters directory inside !SaveMung2.  There will be a directory for each
character that has used SaveMung2.  Simply delete any directories you no
longer require.


Credits
~~~~~~~
	Firstly, a big thankyou to Toby Haynes who created the wonderful
Angband sprites that formed the basis of the SaveMung2 icons.  Since all
I've done is recoloured and added wording, you should consider SaveMung2's
sprites as (c) Toby Haynes.

	Also, thanks are due to Kevin Bracey who ported Angband to Risc OS
in the first (well, second I guess...) place.  His port of 2.7.9 is *far*
superior to the 2.4.Frog-Knows I'd been playing up to now :-)  It'd be
remis of me not to mention Ben Harrison's work in maintaining Angband and
making it easier for Kevin to port, so a thankyou to Ben too.


Disclaimer
~~~~~~~~~~
Use of this software is completely at your own risk. The author can accept no
responsibility for any damage/loss arising from the use, or inability to use
this software. No warranty, express or implied, applies to this software.
This is not PD: the Copyright in this software belongs at all times to the
author. However, permission is granted for unrestricted distribution
prodividing that *no* charge is made for the distribution [a charge may be made
for handling/media] and that the whole of the software is supplied intact and
unaltered. Permission is also granted for unrestricted use and alteration of
the software [but if you fix a bug / add anything nice, let me know so I can
patch the 'master' version].

Bug reports / comments / etc to:

e-mail: mailto:musus@argonet.co.uk
   web: http://www.argonet.co.uk/users/musus/
 snail: Adny Holdsworth,
        c/o 23 Baronsway,
        Whitkirk,
        Leeds,
        LS15 7AW,
        England.

