lgeneral-data - a free content package for LGeneral based on Steve McGuba's
                                k.u.k General

INSTALLATION
============

Copy the directories gfx, maps, nations, scenarios, sounds and units to your
LGeneral data directory. (e.g. /usr/share/games/lgeneral)

KNOWN ISSUES
============

Please include the name of the scenario, hex field coordinates, unit types and
similar information in your bug reports. Some icons may not be correctly
assigned to certain units and some units play the wrong sound when they are
moved. (e.g. infantry unit with airplane sound). Victory conditions are not
fine-grained enough yet.

HISTORY
=======

LGeneral is a rather old free software project and dates back to the year 2000.
Since then nobody tried to produce free content for it because the idea
always was to create a free engine and to reuse the original Panzer General
campaign.

In 2012 I found out that LGeneral had been abandoned for a long time in Debian
despite the fact that upstream still seemed to release small updates from time
to time. I decided to adopt the package and went on a journey to find free
content for LGeneral so that the engine could be moved to Debian's main
archive. Fortunately the Panzer General franchise spawned an active modding
community and thus I discovered k.u.k General which takes place in a World War
I setting and was originally based on Kaiser General, another mod by Philipp
Champarou.

After so many years it seemed like a miracle that the creator of k.u.k General,
Steve McGuba, replied to my email but he did and released his work under a
CC-BY-SA-3.0 license. And that's the reason why this project exists nowadays.

DEVELOPMENT
===========

See docs/HOWTO.convert for how you can convert the original DOS campaign to
LGeneral's native format. There is no map or scenario editor yet. Someone has
to code it first. However in the meantime it is not too hard to modify the
existing scenarios by hand. Just use your preferred text editor and change the
values to your liking. The same goes for the bitmaps. Gimp or mtPaint should be
your tools of choice. See also TODO for an incomplete list of things that
should be done.

Markus Koschany, June 2014
