
                 civreplay - generate animated freeciv maps

Contents

     * [1]Contents
     * [2]Introduction
     * [3]Prerequisites
     * [4]Download
     * [5]civreplay options
     * [6]Output
     * [7]Licensing

Introduction

   [8]civreplay is a script to generate [9]animated maps from the
   savegame files in [10]freeciv. I wrote it on New Years Eve 2001,
   because I grew impatient waiting for the author of [11]civpow to fix
   the permissions on his script. This one does pretty much the same
   thing, although I have no clue how much the internals match.

   I've tested it on Freeciv 1.12.0, and it appears to work. Your mileage
   may vary, but I'd be interested in hearing about any spectacular
   failures. The colors might be a bit off for games comprising more
   than, say, 8 people, since I haven't tested the high end of my color
   map. But it should still give a fairly decent view.

Prerequisites

   Prerequisites for running [12]civreplay are:
    1. [13]perl
    2. [14]Netpbm
    3. [15]gifsicle
    4. [16]Compress::Zlib perl module (for reading compressed gamefiles)

   You can likely find most of these in a standard Linux distribution, or
   from one of the prepackaged sites. Unix folks should already know how
   to install a tarball... Windows and other OS users are on their own
   for figuring out how to compile/use the above packages.

Download

   Once you've managed to fill all the [17]prerequisites above, the only
   thing you need to download is [18]the script (current version: 0.003).
   On a Linux or Unix system, you'll likely have to add execute
   permissions (chmod a+x civreplay) and place the script somewhere in
   your path. You'll also likely have to change the location of perl on
   the first line of the script if it isn't located at /usr/bin/perl
   (which is where it is on my system).

   Additionally, both [19]gzipped (42k) and [20]bzip2ed (45k) tarballs
   are provided, which include everything in the development tree.

   If you'd like to see what's changed from version to version, you can
   check out the [21]changelog.

civreplay options

   The best explanation of civreplay options is the option summary
   printed when civreplay is run without any command-line parameters at
   all:
Proper usage:
  civreplay [options] <savegamefiles*.sav[.gz]>

where options are:
 --delay|-d N           delay between gif frames in 100ths of a second
                          (default 5)
 --expansion|-e N       expansion factor for pixels (sets both pixelwidth
                          and pixelheight to the same value)
 --output|-o <filename> the output filename for the animated gif
                          (default civreplay.gif)
 --pixelheight|--height|-h N
                        the height in pixels of individual map squares
                          (default 2)
 --pixelwidth|--width|-w N
                        the width in pixels of individual map squares
                          (default 2)
 --quiet|-q             run quietly
 --radius|-r N          how many map squares around a city should be colored
                          a player's particular color.  A radius of 0
                          means that only cities themselves are noted.  A
                          radius of 2 roughly indicates the squares a player's
                          cities actually control.
                          (default 2)
 --units|-u             display units as well as cities. Units always have a
                          radius of 0 (default off)
 --version|-v           display the version information

Output

   The output of [22]civreplay is an animated gif. To give you some idea
   of what these gifs look like:
     * [23]4 players (2 AI), default options (11k)
     * [24]4 players (2 AI), options -e 4 -u (47k)
     * [25]4 players (2 AI), options -r 0 -e 5 (19k)
     * [26]4 players (2 AI), options -r 2 -e 5 (26k)
     * [27]5 players (2 AI), default options (24k)
     * [28]5 players (2 AI), options -e 3 -u (177k)

Licensing

   [29]civreplay is distributed under the terms of the GNU General Public
   License, available at [30]http://www.gnu.org/copyleft/gpl.html. As
   such, there is no warranty, either expressed or implied, associated
   with civreplay. If it wipes out your hard drive, or starts mailing
   spam to everyone in your addressbook, it's your fault. civreplay works
   for me.

References

   1. http://www.pobox.com/~mgurski00001/software/civreplay/index.html#contents
   2. http://www.pobox.com/~mgurski00001/software/civreplay/index.html#intro
   3. http://www.pobox.com/~mgurski00001/software/civreplay/index.html#prereqs
   4. http://www.pobox.com/~mgurski00001/software/civreplay/index.html#download
   5. http://www.pobox.com/~mgurski00001/software/civreplay/index.html#options
   6. http://www.pobox.com/~mgurski00001/software/civreplay/index.html#output
   7. http://www.pobox.com/~mgurski00001/software/civreplay/index.html#licensing
   8. http://www.pobox.com/~mgurski00001/software/civreplay/civreplay
   9. http://www.pobox.com/~mgurski00001/software/civreplay/index.html#output
  10. http://www.freeciv.org/
  11. http://www.math.ttu.edu/~kesinger/freeciv/
  12. http://www.pobox.com/~mgurski00001/software/civreplay/civreplay
  13. http://www.perl.com/
  14. http://netpbm.sourceforge.net/
  15. http://www.lcdf.org/gifsicle/
  16. http://search.cpan.org/search?dist=Compress-Zlib
  17. http://www.pobox.com/~mgurski00001/software/civreplay/index.html#prereqs
  18. http://www.pobox.com/~mgurski00001/software/civreplay/civreplay
  19. http://www.pobox.com/~mgurski00001/software/civreplay/civreplay.tar.gz
  20. http://www.pobox.com/~mgurski00001/software/civreplay/civreplay.tar.bz2
  21. http://www.pobox.com/~mgurski00001/software/civreplay/changelog
  22. http://www.pobox.com/~mgurski00001/software/civreplay/civreplay
  23. http://www.pobox.com/~mgurski00001/software/civreplay/4p2ai.gif
  24. http://www.pobox.com/~mgurski00001/software/civreplay/4p2aie4u.gif
  25. http://www.pobox.com/~mgurski00001/software/civreplay/4p2air0e5.gif
  26. http://www.pobox.com/~mgurski00001/software/civreplay/4p2air2e5.gif
  27. http://www.pobox.com/~mgurski00001/software/civreplay/5p2ai.gif
  28. http://www.pobox.com/~mgurski00001/software/civreplay/5p2aie3u.gif
  29. http://www.pobox.com/~mgurski00001/software/civreplay/civreplay
  30. http://www.gnu.org/copyleft/gpl.html
