NWNSC - NWN Enhanced Edition Script Compiler

Neverwinter Nights Enhanced Edition Script compiler - Based on Skywing Parser enhancements

>>> For newer releases see this github page: https://github.com/nwneetools/nwnsc <<<

*** UPDATED VERSION 1.0.0 ***

Since the game has gone gold and the compiler has been stable this is the 1.0.0 release.  It fixes a few small bugs and adds some compatibility updates with the latest Toolset compiler.

This is a nwscript compiler based on the Skywing Compiler engine NWNScriptCompiler that was adapted from Edward T. Smith's nwnnsscomp now updated to work with NWN EE.

Changes - 1.0.0

    Added the ability to parse and compile escaped double quotes (\") in strings based on the latest nwscript changes. This will default to on and may cause compilation issues with older scripts until they are updated.  The compiler switch -Q was added to disable this feature and revert to the previous behavior.  The parsing of double quotes is also disabled when compiling for 1.69.
    Updated the Makefile compatible dependency files to only insert includes that are in the file system and ignore the entries in packed .bif files.
    Fixed a Linux / Mac crash when illegal characters were detected in a file
    Fixed a crash when freeing memory when parsing arrays

Changes - 0.9.7

    Added -l command for compiler to automatically locate the game install folder (see help for details)

    Fixed file handle leak on Linux / MacOS - (reported by BhaalIM)

    Eliminated the logs folder creation

    Clean up of output and -w flag to suppress warning display

    Control-C on Linux / Mac will no longer abort and dump a stacktrace

    Fixed error when compiling for NWN Diamond - version 1.69

Changes - 0.9.6

    Fixed several null pointers and segmentation faults

    Improved speed with compile optimizations

    Redundant -l command line option not required when passing -n

    When building for NWN EE the installdir ovr folder (override) will be processed for includes before the .bif files

    Added -M to create Makefile compatible dependency files


This has been tested to work with both NWN EE (1.74) and NWN 1.69.

Source Code and Issue Tracker: https://gitlab.com/glorwinger/nwnsc

SS(link is external)
Installation

    Unpack the binaries from the zip file and place them somewhere in your path.
    Check the following requirements
        Windows - This has been tested on Windows 7 and Windows 10. Please report issues.
        MacOs - This has been tested on MacOs 10.10 and 10.13. Please report any issues.
        Linux - This has been statically linked and should run on the following
            Debian >= 6
            Ubuntu >= 10.04
            Red Hat Enterprise Linux >= 5
            CentOS >= 5

Using nwnsc
Usage message

Usage: version 0.9.7 - built Mar 18 2018 14:32:17

nwnsc [-degjklorsqvwyM] [-b batchoutdir] [-h homedir] [-i pathspec] [-n installdir]
      [-m mode] [-x errprefix] [-r outfile] infile [infile...]

  -b batchoutdir - Supplies the location where batch mode places output files
  -h homedir     - Per-user NWN home directory (i.e. Documents\Neverwinter Nights)
  -i pathspec    - Semicolon separated list of folders to search for additional includes
  -n installdir  - Neverwinter Nights install folder. Use to load base game includes
  -m mode        - Compiler mode 1.69 or 1.74 - (default 1.74)
  -x errprefix   - Prefix string to prepend to compiler errors (default "Error")

  -d - Disassemble the script (overrides default compile
  -e - Enable non-BioWare extensions
  -g - Enable generation of .ndb debug symbols file
  -j - Show where include file are being sourced from
  -k - Show preprocessed source text to console output
  -l - Load base game resources - not required with -n
  -o - Optimize the compiled script
  -p - Dump internal PCode for compiled script contributions
  -q - Silence most messages
  -r - Filename for output file
  -s - Enable Strict mode. This enables stock compiler compatibility that allows
       some potentially unsafe conditions (default: off)
  -v - Version and detailed usage message
  -w - Suppress compile warnings (default: false)
  -y - Continue processing input files even on error
  -M - Create makefile dependency (.d) files
    - Q - Disable the parsing of \" (added in NWN EE build 8176)

  The Compiler requires the nwscript.nss from the game resources. The following order
      will be followed to find the file. The search stops on the first match.
    1. -i pathspec  The pathspec will be searched as the game scipts may
            be unpacked into a flat folder structure
    2. -n installdir will be searched.  The search starts with <installdir>/ovr
            and continues with <installdir>/data/*.bif files
    3. -l If the -l flag is passed The following sources are searched:
            Check the environment variable NWN_ROOT
            NWN EE Digital Deluxe Beta (Head Start)
            NWN EE Beta (Head Start)
            NWN EE Digital Deluxe
            NWN EE
            NWN Steam


Optional debug flags
  -D - Set Debug Log level
  -I - Set Info Log level
  -W - Set Warning Log level
  -T - Set Trace Log level


  Portions Copyright (C) 2008-2015 Skywing
  Portions copyright (C) 2002-2003, Edward T. Smith
  Portions copyright (C) 2003, The Open Knights Consortium
  Adapted for Neverwinter Nights Enhanced Edition and cross platform use by: Glorwinger and Jakkn

Examples


    Compile a folder of scripts for NWN EE without extracting game files - Compiler will find Game folder as above
    nwnsc -l *.nss
    Compile a folder of scripts for NWN EE without extracting game files
    nwnsc -n /Applications/Beamdog/00829 *.nss
    Compile a folder of scripts for NWN EE using extracted game files in a flat foldernwnsc -i ../../tmp/bif/base_scripts.bif *.nss