Update documentation

This commit is contained in:
Adrian 2016-02-22 17:11:48 +01:00
parent 9cc13f0e8d
commit d1593f38c5
2 changed files with 16 additions and 4 deletions

View file

@ -10,25 +10,37 @@ This includes the *Age of Empires* series and *Star Wars: Galactic Battlegrounds
## Features
* Create maps from bitmaps
* Convert AOE1 Scenario to AOE2 Scenario
* Convert a Scenario file to JSON and vice-versa
* Decompress and recompress compressed Scenario part for hex editing
* Dump unit information to easily gather Unit IDs
* Extract Scenario files from Campaign file
* Full Campaign file editing
## Planned Features
* Create maps from bitmaps
* Trigger implementation
* Full conversion between all Scenario versions
(mapping of Unit IDs are needed for this, see Section Contributing)
## Examples
### Map Generation
![Generated Map](doc/GeneratedMap.jpg)
The above map is generated using:
$ GenieEdit.exe bmp2map files/examples/aoe2x-Empty.scx Europe.scx /tmp/terrain.png /tmp/elevation.png
The images are taken from [NASA's Blue Marble](http://visibleearth.nasa.gov/) imagery.
### Scenario Conversion
[OpeningMoves-AOE2.scx](files/OpeningMoves-AOE2.scx)
is a fully automated conversion of a Scenario file from the AOE1 demo version:
$ GenieEdit.exe convert files/examples/aoe2x-Empty.scx "files/examples/aoe1demo-Reigno_1-Opening Moves.scn" files/OpeningMoves-AOE2.scx
$ GenieEdit.exe convert "files/examples/aoe1demo-Reigno_1-Opening Moves.scn" files/OpeningMoves-AOE2.scx files/examples/aoe2x-Empty.scx
(Stone are set to 100 to be able to build a town center from the beginning.)
@ -47,7 +59,7 @@ A unit dump looks like the following:
# Library
The namespace `AdrianKousz.GenieEngine` contains classes
to read, write, and manipulate Scenario files.
to read, write, and manipulate Scenario and Campaign files.
`Scenario` contains all data structures related to a Scenario file.
They are easily understandable.

BIN
doc/GeneratedMap.jpg Normal file

Binary file not shown.

After

(image error) Size: 80 KiB