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; ./l2e ../../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         Unit tests can be built with `make tests' and run with `make test'.
  27         If a unit test should fail for you, please file a bug at
  28         http://luke.redirectme.net/redmine/projects/l2e/issues/new and describe
  29          * your architecture and operating system,
  30          * versions of the libs,
  31          * and which test(s) failed.
  32         Patches are also welcome :)
  33
  34 Dependencies
  35         Runtime
  36          * SDL
  37          * SDL_image
  38         Building with make and supplied configuration
  39          * g++
  40          * find
  41          * make
  42          * pkg-config
  43          * and a number of core utilities such as rm, mkdir, and an sh-compatible
  44            shell.
  45         Building and running unit tests
  46          * cppunit
  47
  48 Launching
  49         The current version requires huge amounts of symbols to be defined and does
  50         not automatically load anything.
  51         There are some data files in the `test-data' directory that provide exactly
  52         what's needed to run.
  53         Those can be passed as arguments from the command line.
  54
  55         By default, main() will launch a map scene.
  56         This can be changed to a battle scene by passing `-B'.
  57
  58 Control Mapping
  59         pad up    : W           | action A  : right
  60         pad right : D           | action B  : down
  61         pad down  : S           | action X  : up
  62         pad left  : A           | action Y  : left
  63         start     : return      | debug 1   : 1
  64         select    : space       | debug 2   : 2
  65         right     : right shift | debug 3   : 3
  66         left      : left shift  | debug 4   : 4
  67
  68         This mapping is defined in `src/keys.h'.
  69
  70 More
  71         There is a project page online with issue tracker and wiki at
  72         `http://luke.redirectme.net/redmine/projects/l2e'.
  73
  74         You may file bug reports and/or feature requests at any time.
  75         Pull-requests and patches also welcome.
  76         Contact address is `daniel.karbach@localhorst.tv'.