Automatic backup of turn files

[PDF]

Many thanks Lolly (can I call you that ? ) !
I've installed Python and copied the script, it works quite well as advertised. Only small problem is that if Dom3 runs in fullscreen mode it's automatically minimized when executing the script... I suppose it's a Windowze thingie and can live in windowed mode.
Would it be easy to not only backup the last turn but also make a file history, I mean having subdirs with each turn's saves ? I know the game doesn't pass the turn numbers, so the utility should assume the player uses it by turn 1..
Just an idea, but it'll be cool

[Lollipop]

PDF said:
Many thanks Lolly (can I call you that ? ) !

By way of an exception, cause you was brave enough to try my script

Only small problem is that if Dom3 runs in fullscreen mode it's automatically minimized when executing the script... I suppose it's a Windowze thingie

Yes, it is. I doubt there's a way around

Would it be easy to not only backup the last turn but also make a file history, I mean having subdirs with each turn's saves ? I know the game doesn't pass the turn numbers, so the utility should assume the player uses it by turn 1..
Just an idea, but it'll be cool

The script already does it, kind of. I was in a hurry when posting cause my boss was approaching and I wasn't supposed to work on a dom3 script.

1) create a 'archivedgames' directory in your dom3 directory.

2) modify the dom3 link to:
dom3.exe --scoredump --preexec 'python dom3backup.py -f 1'

The script parses scores.html to get the turn number (assumes turn 1, if not found) and creates a zipfile (name-Turn<turnnumber>.zip) every '-f <n>' turns (in archivedgames, optionally use the -d arg), with '-f 1' every turn.

You can limit the number of zip-files kept with '-m <n>', default is to keep all.

I hope this isn't too confusing.

Caveat: I haven't tested it under xp. The pyhton-doc says, that you need zlib (prob. not present) only, when deflating, so I used a simple store mechanism. But who knows..

Thanks for testing

Pia

Edit: Gnu zlib for XP is here. Change the line:

zipFile = ZipFile(zipName,'w')

to:
zipFile = ZipFile(zipName,'w',ZIP_DEFLATED)

Compression ratio is 1:10, not bad.

[PDF]

Wunderbar !! That's just what we needed to have a real "save" feature in Dom3
Can I kiss you Lolly ?

In fact in my previous post I had just tested the first small script that you gave in your first post and didn't notice there was a second post with attachment !! I'm distracted...

About XP I had everything working but had to "spell" the shortcut command like this :
<dom3path>\dom3.exe --scoredump --preexec "<Dom3 path>\dom3backup.py -f 1"
With <dom3path> my Dom3 directory where I've also copied the .py file. Double apostrophs are required ("), simple ones (')don't work.

This tool give me ideas but I don't charm Pythons like you do so well , could you please continue this fine work ?
- I don't like much having the .backup reps directly under Dom3 rep, I'd prefer to have them underneath each game's rep, ie Dominions3/MyGame/MyGame.backup
I suppose it's rather easy to change ? Just tell me what lines/command to edit, I'm able to do that.
- For pbems, now that we got automatic numbered zipped turn files we just lack an automatic email sending to a list of addresses (the players) ! Do you think you could handle that ? (I'm sure you can ! )
For Dom2 I had a buddy who make scripts to use a small free command-line email tool called "postie", perhaps we could use it also ?

[Lollipop]

PDF said:
Wunderbar !! That's just what we needed to have a real "save" feature in Dom3
Can I kiss you Lolly ?

I guess I have to ask my husband first.

- I don't like much having the .backup reps directly under Dom3 rep, I'd prefer to have them underneath each game's rep, ie Dominions3/MyGame/MyGame.backup
I suppose it's rather easy to change ? Just tell me what lines/command to edit, I'm able to do that.

Very well, Master, your wish is my command. I'm working on it.

- For pbems, now that we got automatic numbered zipped turn files we just lack an automatic email sending to a list of addresses (the players) ! Do you think you could handle that ? (I'm sure you can ! )

I lack any dom pbem experience, but I think, --pre/postexec only works when hosting. So this would be a stand-alone program. Like reading the addresses from <gamename>.pbem and sending the .2h file? Something like that?

However, I only used python cause it was available at work (which says something about my working morale). Python isn't my favorite language & if that thing gets bigger, I'll use ruby. No worries, it's a 1.x mb download iirc and called 'ruby-one-click-installer.exe'.

And could you do me a favor and test, if the zip file creation works under XP. TIA.

Pia

[PDF]

Lolly,
Sure I did test it and it works fine under XP !
There's even a nice log file to knwo what happened .

About my request to change the path I've found where the script should be changed, in the Backup variable definition, but ain't sure about how to type those "\" or "/" according to this language conventions and with possible OSes incompatibilities... so I let you do it !

As for pbem there are in fact two different needs :
A simple player has to send its 2h file but doesn't "host" as such, and there's no means to detect if he wants to really end the turn and send it or if he would like to send it later... Plus there's only 1 simple mail with the .2h file to send to the hosting player. Maybe a small tool can help, but not much,as anyway the player has to make an action.
I was rather thinking of something for the hoster, who has to send all .trn files (+ ftherland , some don't but it makes a backup indeed !) to all of the players.
Some even make separate emails for each player with each turn file attached !
Here a tool would be great, and it could be easily automated to follow the hosting.
Make it in Python, Ruby, or whatever snake species or gem type you want, it'll be great anyway !

And what did reply your husband for the kiss btw ? ..

[Lollipop]

Incredible, but true. I did write some documentation, completely voluntary, without someone threatening me with a shotgun.

Here's the readme of the new version:
Code:

---

*Synopsis*



	A python script to auto-backup your dom3 games



*Requirements*

	python 2.4 or better. Get it from http://www.python.org/download/. If you have Civ 4,you have it

	(I hope 



	zlib. Get it from http://gnuwin32.sourceforge.net/packages/zlib.htm. Linux has it (usually)



*Installation*



	- extract dom3backup.py to your dominions3 directory



	- Linux:

		create a shell script like:

		#!/bin/bash

		./dom3 --scoredump --preexec './dom3backup.py -q' &



		chmod +x <your name goes here> business as usual



	-Windows:

		-create a link of your dom3.exe (right drag to a location of your choice and select 		'create link here')



		-right click on your link, select 'properties' and find the line containing 'dom3.exe'



		-add ' --scoredump --preexec "<Dom3 path>\dom3backup.py -q"'

		the ' are only there to show blanks, don't enter. The " however are required.



		-enter further arguments. Explained below



	-Mac:

		sorry, no idea



*Usage*

	dom3backup always backups the game, you've last played. If you want to backup another game, use the

	-g option.

	dom3backup uses a simple substitution. Whenever you specify a directory, #name is replaced with the

	current game name (either last game played or specified with -g), #turn is replaced with the

	current turn-number.

	Relative paths are relative to <dom3>/savedgames



  -a ARCHIVE, --archive=ARCHIVE

                        create archive <name> now. Usually used from the commandline

  -b BACKUPDIR, --backupdir=BACKUPDIR

                        create backup in backupdir. Default:

                        <dom3>/savedgames/#name.backup.

		Example:

			last game you played was 'ermor1'

			no arguments:

				backup all your files to <dom3>/savedgames/ermor1.backup/

			-b ./#name/backup

				backup all your files to <dom3>/savedgames/ermor1/backup/

			-b c:/d3archive/#name

				backup all your files to c:/d3archive/ermor1/

			-b ../saved/#name.#turn

				all your files to '<dom3>/saved/ermor.1',then <dom3>/saved/ermor.2' etc.

			-b ../saved/#name/#turn

				all your files to '<dom3>/saved/ermor/1',then <dom3>/saved/ermor/2' etc.

  -d ARCHDIR, --archdir=ARCHDIR

                        create Zipfiles in archdir. archdir must exists.

                        Default: <dom3>/archivedgames. Absolute or relative paths as the -b option

  -f FREQ, --freq=FREQ  create a Zipfile every <n> turn(s). Default: 0 (no

                        zipfile)

  -g GAME, --game=GAME  backup game <name>. Otherwise backup latest game

  -m MAXFILES, --maxfiles=MAXFILES

                        keep max. <n> Zipfiles. Delete oldest. Default: 0

                        (keep all)

  -q, --quiet           output messages are written to <dom3>/dom3backup.log

  -r, --restore         restore files form backup-dir. Use only from the command line

  -t TURN, --turn=TURN  assume turn <n>. Only useful with -r. Use from

                        commandline only

  --nocopy              don't copy files to backup-dir. Default: False



*Putting it all together*

	Assuming windows...

	Ex.1) dom3.exe --scoredump --preexec "<Dom3 path>\dom3backup.py -q"

		once you hit 'e', your files are copied to <Dom3 path>\savedgames\<gamename>.backup

	Ex.2) dom3.exe --scoredump --preexec "<Dom3 path>\dom3backup.py -q -f 1"

		same as above, but every turn a zip file is created in <Dom3 path>/archivedgames

		The zip-file is named <game-name>-Turn<turnnumber>.zip

	Ex.3) dom3.exe --scoredump --preexec "<Dom3 path>\dom3backup.py -q -f 4"

		same as above, but zip files are only created on Turn1, Turn 5, Turn9 etc.

	Ex.4) dom3.exe --scoredump --preexec "<Dom3 path>\dom3backup.py -q -f 4 -m 2"

		same as above, but only 2 zip-files are kept at any time. So if <name>-Turn9.zip is created, 			<name>-Turn1.zip is deleted

	Ex.5) dom3.exe --scoredump --preexec "<Dom3 path>\dom3backup.py -q -b ../saved/#name"

		your files are copied to '<dom3>/saved/<gamename>. Of course you're free to also create

		zip files, see above

	Ex.6) dom3.exe --scoredump --preexec "<Dom3 path>\dom3backup.py -q -b ../saved/#name/#turn"

		copied to <dom3>/saved/<gamename>/1,<dom3>/saved/<gamename>/2 etc



	Restoring backups:

		If you don't used -b, the *last* turn from <Dom3 path>\savedgames\<gamename>.backup is

		restored.

		Same as above, if you used -b *and* no #turn substitution

		If you used #turn substitution, you *must* use the -t argument

		

		So start a shell and:

			Ex.1)  python dom3backup.py -r  

				= restore last turn

			Ex.5) python dom3backup.py -r -b ../saved/#name

				same as above

			Ex.6) now you must pass a turn number

				python dom3backup.py -r -b ../saved/#name/#turn --turn 1

				start from scratch

*Caveats*

	Windows: you must use -q

	Windows: use / in pathnames, not \

	All: if you mess around with the savedgames directory, the auto-detection might no longer work.

		Files containing a '.' and newlords are ignored, but if you copy the 'MyFavoritePorns' folder

		to savedgames, your pbem-partner might be up for a surprise 



	GPL applies......



Comments to ZarahNeander at t-online  dot de



04/11/06 Pia Kraft

---

[Lollipop]

PDF said:
Lolly,
Sure I did test it and it works fine under XP !
There's even a nice log file to knwo what happened .

Thanks much, good to know

About my request to change the path I've found where the script should be changed, in the Backup variable definition, but ain't sure about how to type those "\" or "/" according to this language conventions

Done. See the new attachment. The substitute mechanism is quite flexible and should satisfy even you

Regarding / and \. Internally I only used /, so it seems, that python is smart enough to convert / to \ under XP. It *might* even necessary to use / in arguments passed to the script.

I was rather thinking of something for the hoster, who has to send all .trn files (+ ftherland , some don't but it makes a backup indeed !) to all of the players.
Some even make separate emails for each player with each turn file attached !
Here a tool would be great, and it could be easily automated to follow the hosting.

I see. Thanks for elaborating. Shouldn't be too hard. The only problem, while I don't run unit tests and such, I like to test my software at least rudimentary, which means, I have to host a pbem game. And a pbem with only a host is somewhat pointless. And I don't want to incur the eternal wrath of players by using a real pbem as my testbed. So I'm looking for some kind of sacrificial lamb...

And what did reply your husband for the kiss btw ? ..

Let me put it this way: I won't give away my age, suffice to say, I'm seasoned, quite seasoned