File	Date	Author	Commit
data	2013-05-31	Sean Thalken	[de5fee] modified: CHANGELOG
lib	2013-05-31	Sean Thalken	[de5fee] modified: CHANGELOG
CHANGELOG	2013-05-31	Sean Thalken	[de5fee] modified: CHANGELOG
COPYING	2013-05-04	Sean Thalken	[52af51] Initial commit
EditSourceFiles	2013-05-04	Sean Thalken	[52af51] Initial commit
Makefile	2013-05-19	Sean Thalken	[9e790c] modified: Makefile
README	2013-05-31	Sean Thalken	[de5fee] modified: CHANGELOG
main.cpp	2013-05-19	Sean Thalken	[9e790c] modified: Makefile

Read Me

Copyright (C) 2013 Sean Thalken
sthalken286@gmail.com

The license of all code in this project can be found in the file COPYING.

Unless otherwise explicitly noted, all audio and art content is licensed under
a Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported
license. Details of this license can be found at:
http://creativecommons.org/licenses/by-nc-sa/3.0/

To build the project just run make. The game engine will be compiled into a binary named main.

In order to build the project you will need the following programs and libraries:
   libGL
   liblua               >= 5.2
   libsdl               1.2
   libsdl-image         1.2
   libsdl-mixer         1.2
   libsdl-ttf           2.0
   libboost_system      >= 1.48
   libboost_timer       >= 1.48
   swig

The game client has the following controls:

   A, left  arrow - move left
   S, down  arrow - move down
   W, up    arrow - move up
   D, right arrow - move right
   Q              - close program
   F, esc         - open menu
   E, enter       - interact / action button

The map editor can be run by appending the -e flag when running the game binary
The map editor has the following controls:

   Keyboard:
      0,1,2,3              - select layer
      Ctrl + 0,1,2,3       - hide / show layer
      c                    - Toggle 'character' mode
      e                    - Toggle map interior / exterior
      f                    - Fill visible map layer
      Ctrl + f             - Fill entire map layer
      i                    - Switch to next graphical filter
      l                    - Load map file
      m                    - Load music file
      n                    - Toggle 'range' mode
      p                    - Toggle 'path' mode
      r                    - Resize map
      s                    - Save map (prompts you to enter map name)
      Ctrl + s             - Save map (saves to currently opened file)
      t                    - Load tileset
      y                    - Change transparency of sidebar
      Home                 - Move to top left corner of map
      End                  - Move to bottom right corner of map
      Ctrl + keypad (-)    - Shrink size of map by one row and column
      Ctrl + keypad (+)    - Grow size of map by one row and column. New tiles will be set to the current brush

   Mouse:
      wheel up             - Move tileset up by one page
      wheel down           - Move tileset down by one page

   Draw mode:
      left click           - Draw tile at mouse cursor
      middle click         - Follow a path if one exists at mouse cursor
      right click          - Copy tile at mouse cursor

   Path mode:
      left click           - Create new path to another map at cursor
      middle click         - Follow a path if one exists at mouse cursor
      Ctrl + middle click  - Delete existing path at cursor
      right click          - Temporarily follow path at cursor. Left clicking on a tile will close the temporary map and set the tile you clicked on to the starting location of the path.

   Range mode:
      left click           - First click will set the start of the range, second click will set the end. All tiles within the rectangle formed by the start and end will be filled in with the currently selected tile.

   Character mode:
      left click           - Create a new character at mouse cursor
      middle click         - Delete existing character at mouse cursor
      right click          - Modify the text of the character at mouse cursor (Text is stored in text_data.lua. You simply set character text to the name of the string from this file that you want to use.)