This project is a framework for managing a Neverwinter
Nights module. At the most basic, it is a set of
scripts to hook all events in a module. Scripts can then subscribe to the hooks
and be run when the event is triggered. This allows the module builder to
modularize script systems instead of combining scripts.
This system is in alpha. Things will change and will break. You have been
warned.
git clone https://github.com/squattingmonk/nwn-core-framework.git
cd nwn-core-framework
git submodule update --init
Run the build script:
nasher install demo erf
This will create the following files in your Neverwinter Nights user directory:
modules/core_framework.mod: a demo module showing the framework in action
(currently a barebones testing ground).
erf/core_framework.erf: an installable erf for use in new or existing
modules.
Note: sm-utils relies on script extensions added by
nwnsc. This prevents error messages when
compiling with nwnsc, but prevents compilation in the Toolset. If you want to
compile the scripts in the toolset instead, you can comment out the lines
beginning with #pragma near the bottom of the script util_i_library.nss.
Note that util_i_library.nss will still not compile on its own, since it's
meant to be included in other scripts that implement its functions.
Usage
Import core_framework.erf into your module.
Read and customize core_c_config.nss. If you make changes, be sure to
recompile all scripts.
Set the module's OnModuleLoad event script to hook_nwn.nss. If you set
AUTO_HOOK_MODULE_EVENTS in core_c_config.nss to FALSE, you will need to
set all other module events to hook_nwn.nss as well.
Set other event scripts to hook_nwn.nss as you wish. You can do this
manually in the toolset or by script using HookObjectEvents() from
core_i_framework.nss.
Note: some events may be triggered before the module loads. An example is the
OnAreaEnter event being triggered by NPCs placed in the toolset. If you want to
capture these, you will either have to set those event scripts to hook_nwn.nss
manually or somehow call InitializeCoreFramework() from core_i_framework.nss
before they are run (e.g., using NWNX).
mhekel
commented
6 months ago
Core Framework
This project is a framework for managing a Neverwinter Nights module. At the most basic, it is a set of scripts to hook all events in a module. Scripts can then subscribe to the hooks and be run when the event is triggered. This allows the module builder to modularize script systems instead of combining scripts.
This system is in alpha. Things will change and will break. You have been warned.
Prerequisites
Installation
Get the code:
Run the build script:
This will create the following files in your Neverwinter Nights user directory:
modules/core_framework.mod: a demo module showing the framework in action (currently a barebones testing ground).erf/core_framework.erf: an installable erf for use in new or existing modules.Note:
sm-utilsrelies on script extensions added by nwnsc. This prevents error messages when compiling withnwnsc, but prevents compilation in the Toolset. If you want to compile the scripts in the toolset instead, you can comment out the lines beginning with#pragmanear the bottom of the scriptutil_i_library.nss. Note thatutil_i_library.nsswill still not compile on its own, since it's meant to be included in other scripts that implement its functions.Usage
core_framework.erfinto your module.core_c_config.nss. If you make changes, be sure to recompile all scripts.OnModuleLoadevent script tohook_nwn.nss. If you setAUTO_HOOK_MODULE_EVENTSincore_c_config.nsstoFALSE, you will need to set all other module events tohook_nwn.nssas well.hook_nwn.nssas you wish. You can do this manually in the toolset or by script usingHookObjectEvents()fromcore_i_framework.nss.Note: some events may be triggered before the module loads. An example is the OnAreaEnter event being triggered by NPCs placed in the toolset. If you want to capture these, you will either have to set those event scripts to
hook_nwn.nssmanually or somehow callInitializeCoreFramework()fromcore_i_framework.nssbefore they are run (e.g., using NWNX).Acknowledgements
This system was heavily influenced by HCR2 and EPOlson's Common Scripting Framework.
Huge thanks to @tinygiant98 for his continued testing and contributions.