]> git.localhorst.tv Git - l2e.git/blob - readme
added readme file
[l2e.git] / readme
1 About
2         l2e is a 2D tiling RPG engine with turn-based gameplay in maps and battles.
3         Its long-term goal is feature-completeness with Lufia 2.
4
5 Quickstart
6         cd Release; make all; cd ..; ./Release/l2e test-data/*.l2s
7
8 Building
9         To build the binary, simply enter the desired build configuration directory
10         (currently `Release' or `Debug') and execute `make all`.
11
12 Launching
13         The current version required huge amounts of symbols to be defined and does
14         not automatically load anything.
15         There are some data files in the `test-data' directory that provide exactly
16         what's needed to run.
17         Those can be passed as arguments from the command line.
18
19         By default, main() will launch a map scene.
20         This can be changed to a battle scene by passing `-B'.
21
22 More
23         There is a project page online with issue tracker and wiki at
24         `http://luke.redirectme.net/redmine/projects/l2e'.
25
26         You may file bug reports and/or feature requests at any time.
27         Pull-requests and patches also welcome.
28         Contact address is `daniel.karbach@localhorst.tv'.