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 build/release; make all; ./2e ../../test-data/*.l2s
   7
   8 Building
   9         To build the binary, simply enter the desired build configuration directory
  10         in `build' (currently `release' or `debug') and execute `make all`.
  11
  12         The supplied `config.mk' includes `local-config.mk' should it exist.
  13         This can be used to adjust the build configuration to your environment
  14         without messing with files tracked by git.
  15
  16         All built files can be removed via the `clean' make target.
  17
  18         There are a number of silent includes in the makefiles should you need to
  19         override any settings.
  20          * Global build settings can be adjusted in `/build/local-config.mk'.
  21          * Settings specific to building the l2e binary should go into
  22            `/build/l2e-local.mk'.
  23          * Build confiuration specific settings should go into
  24            `/build/$config/local.mk', e.g. `/build/debug/local.mk'.
  25
  26 Dependencies
  27         Runtime
  28          * SDL
  29          * SDL_image
  30         Building with make and supplied configuration
  31          * g++
  32          * find
  33          * make
  34          * pkg-config
  35          * and a number of core utilities such as rm, mkdir, and an sh-compatible
  36            shell.
  37
  38 Launching
  39         The current version required huge amounts of symbols to be defined and does
  40         not automatically load anything.
  41         There are some data files in the `test-data' directory that provide exactly
  42         what's needed to run.
  43         Those can be passed as arguments from the command line.
  44
  45         By default, main() will launch a map scene.
  46         This can be changed to a battle scene by passing `-B'.
  47
  48 Control Mapping
  49         pad up    : W           | action A  : right
  50         pad right : D           | action B  : down
  51         pad down  : S           | action X  : up
  52         pad left  : A           | action Y  : left
  53         start     : return      | debug 1   : 1
  54         select    : space       | debug 2   : 2
  55         right     : right shift | debug 3   : 3
  56         left      : left shift  | debug 4   : 4
  57
  58 More
  59         There is a project page online with issue tracker and wiki at
  60         `http://luke.redirectme.net/redmine/projects/l2e'.
  61
  62         You may file bug reports and/or feature requests at any time.
  63         Pull-requests and patches also welcome.
  64         Contact address is `daniel.karbach@localhorst.tv'.