]> git.localhorst.tv Git - l2e.git/blob - readme
added button mapping to 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 Control Mapping
23         pad up    : W           | action A  : right
24         pad right : D           | action B  : down
25         pad down  : S           | action X  : up
26         pad left  : A           | action Y  : left
27         start     : return      | debug 1   : 1
28         select    : space       | debug 2   : 2
29         right     : right shift | debug 3   : 3
30         left      : left shift  | debug 4   : 4
31
32 More
33         There is a project page online with issue tracker and wiki at
34         `http://luke.redirectme.net/redmine/projects/l2e'.
35
36         You may file bug reports and/or feature requests at any time.
37         Pull-requests and patches also welcome.
38         Contact address is `daniel.karbach@localhorst.tv'.