EasyRPG Player
==============

EasyRPG Player is a game interpreter to play RPG Maker 2000, 2003 and
EasyRPG games. It uses liblcf to read RPG Maker game data.

EasyRPG Player is part of the EasyRPG Project. More information is
available at the project website:

  https://easy-rpg.org/


Documentation
-------------

Documentation is available at the documentation wiki:

  https://easy-rpg.org/wiki/


Requirements
------------

liblcf for RPG Maker data reading. https://github.com/EasyRPG/liblcf
SDL2 for screen backend support.
SDL2_mixer for audio mixing.
FreeType for font support.
Pixman for low level pixel manipulation.
libpng for PNG image support.
zlib for XYZ image support.

SDL and SDL_mixer 1.2 are still supported but deprecated.


Daily builds
------------

Up to date binaries for assorted platforms are available at:

  https://easy-rpg.org/jenkins/view/Player/


Source code
-----------

EasyRPG Player development is hosted by GitHub.
Project files are available in Git repositories.

  https://github.com/EasyRPG/Player


Building
--------

* Makefile method:

  Building requirements:

    pkg-config
    make

  1. Unpack the tarball with:

    tar xf easyrpg-player-0.4.1.tar.xz

  2. Enter in the package directory with:

    cd easyrpg-player-0.4.1

  3. Compile with:

    ./configure
    make


  Specific building requirements from source tree (Git):

    autoconf >= 2.69
    automake >= 1.11.4
    libtool

  To generate the "configure" script, run:

    autoreconf -i

  Then follow the "3. Compile with:" section.


  Read more detailed instructions at:

  https://easy-rpg.org/wiki/development/compiling/player/autotools
  https://easy-rpg.org/wiki/development/compiling/player/cmake


* Visual Studio method:

  Read detailed instructions at:

  https://easy-rpg.org/wiki/development/compiling/player/windows/visual-studio


Running EasyRPG Player
----------------------

Run the easyrpg-player executable from a RPG Maker 2000 or 2003 game
project folder (same place as RPG_RT.exe).


Bug reporting
-------------

Available options:

* File an issue at https://github.com/EasyRPG/Player/issues

* Open a thread at https://easy-rpg.org/forums/

* Chat with us via IRC: #easyrpg at irc.freenode.net


License
-------

EasyRPG Player is free software. See the file COPYING for copying
conditions.