== A library for Neverwinter Nights 1/2 resource files
This package provides a library for reading, changing, and writing common file formats that are found with NWN[http://nwn.bioware.com/], a Bioware game.
They should work with NWN2 just as well, since the file format specifications did not change.
=== Features of nwn-lib
==== nwn-lib reads and writes the following file formats (hopefully bug-free!), both with an API and useful command-line tools:
==== nwn-lib can handle the following representations of GFF data:
===== read & write:
===== just write, for now:
==== Also in the box:
=== Upgrade from 0.3.6 to 0.4.x
With the release of 0.4.0, the API changed significantly. Previous yaml dumps made with 0.3.x are INCOMPATIBLE, and so are all scripts. I can't help you with your API bindings, but for your YAML dumps, a converter script has been provided (see BINARIES).
=== Upgrade from 0.4.x to 0.5.x
All with version 0.4.x produced files should be compatible with 0.5.0. Your application might require some porting to ruby 1.9.
=== Upgrade from 0.5.x to 0.6.x
YAML dumps will need to be converted due to the internal parser/generator used by ruby being replaced (syck to psych). There is a converter packaged in tools/ along with the gem distribution.
=== Quickstart
To use it, simply add the following to your Gemfile:
gem 'nwn-lib'
Also, read BINARIES for the packaged executable scripts, and HOWTO.
For nwn-lib scripts, see SCRIPTING.
For using the developer API, I suggest you start reading NWN::Gff::Struct.
The latest source is available through git[https://github.com/niv/nwn-lib].