|
| 1 | +# liblcf |
| 2 | + |
| 3 | +liblcf is a library to handle RPG Maker 2000 and 2003 game data. |
| 4 | +It can read and write LCF and XML files. |
| 5 | + |
| 6 | +liblcf is part of the EasyRPG Project. More information is available |
| 7 | +at the project website: https://easyrpg.org/ |
| 8 | + |
| 9 | + |
| 10 | +## Documentation |
| 11 | + |
| 12 | +Documentation is available at the documentation wiki: https://wiki.easyrpg.org |
| 13 | + |
| 14 | + |
| 15 | +## Requirements |
| 16 | + |
| 17 | +Expat for XML reading support. |
| 18 | +ICU for character encoding detection and conversion. |
| 19 | + |
| 20 | + |
| 21 | +## Source code |
| 22 | + |
| 23 | +liblcf development is hosted by GitHub, project files are available |
| 24 | +in this git repository: |
| 25 | + |
| 26 | +https://github.com/EasyRPG/liblcf |
| 27 | + |
| 28 | +Released versions are also available at our Download Archive: |
| 29 | + |
| 30 | +https://easyrpg.org/downloads/ |
| 31 | + |
| 32 | + |
| 33 | +## Building |
| 34 | + |
| 35 | +### Autotools Makefile method: |
| 36 | + |
| 37 | +Building requirements: |
| 38 | + |
| 39 | +- pkg-config |
| 40 | +- GNU make |
| 41 | + |
| 42 | +Step-by-step instructions: |
| 43 | + |
| 44 | + tar xf liblcf-0.5.1.tar.xz # unpack the tarball |
| 45 | + cd liblcf-0.5.1 # enter in the package directory |
| 46 | + ./configure --prefix /usr # find libraries, set options |
| 47 | + make # compile the library |
| 48 | + sudo make install # install system-wide |
| 49 | + |
| 50 | +Additional building requirements when using the source tree (git): |
| 51 | + |
| 52 | +- autoconf >= 2.69 |
| 53 | +- automake >= 1.11.4 |
| 54 | +- libtool |
| 55 | + |
| 56 | +To generate the "configure" script, run before following the above section: |
| 57 | + |
| 58 | + autoreconf -i |
| 59 | + |
| 60 | +Read more detailed instructions at: |
| 61 | + |
| 62 | +* https://wiki.easyrpg.org/development/compiling/liblcf/autotools |
| 63 | +* https://wiki.easyrpg.org/development/compiling/liblcf/cmake |
| 64 | + |
| 65 | + |
| 66 | +## Bug reporting |
| 67 | + |
| 68 | +Available options: |
| 69 | + |
| 70 | +* File an issue at https://github.com/EasyRPG/liblcf/issues |
| 71 | +* Open a thread at https://community.easyrpg.org/ |
| 72 | +* Chat with us via IRC: #easyrpg at irc.freenode.net |
| 73 | + |
| 74 | + |
| 75 | +## License |
| 76 | + |
| 77 | +liblcf is Free/Libre Open Source Software, released under the MIT License. |
| 78 | +See the file COPYING for copying conditions. |
| 79 | + |
| 80 | +### 3rd party software |
| 81 | + |
| 82 | +liblcf code includes a copy of Boost Preprocessor Cat and Stringize |
| 83 | +(Boost Software License 1.0) and a copy of inih (New BSD license). |
| 84 | +See the source code comment headers for license details. |
0 commit comments