README

liblcf
======

liblcf is a library to handle RPG Maker 2000 and 2003 game data.
It can read and write LCF and XML files.

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

  https://easyrpg.org/


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

Documentation is available at the documentation wiki:

  https://wiki.easyrpg.org/


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

Expat for XML reading support.
ICU for character encoding detection and conversion.


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

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

  https://github.com/EasyRPG/liblcf


Building
--------

* Makefile method:

  Building requirements:

    pkg-config
    make

  1. Unpack the tarball with:

    tar xf liblcf-0.5.0.tar.xz

  2. Enter in the package directory with:

    cd liblcf-0.5.0

  3. Compile and install with:

    ./configure --prefix /usr
    make
    sudo make install


  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://wiki.easyrpg.org/development/compiling/liblcf/autotools
  https://wiki.easyrpg.org/development/compiling/liblcf/cmake


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

Available options:

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

* Open a thread at https://community.easyrpg.org/

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


License
-------

liblcf is free software. See the file COPYING for copying conditions.

liblcf code includes a copy of Boost Preprocessor Cat and Stringize
(Boost Software License 1.0) and a copy of inih (New BSD license).
See the source code comment headers for license details.