Demo

_images/demo.png

The demo module, ff.mod, shows the framework at work. It runs on a dedicated server with NWNX:EE, set up as described in Installation.

Requirements

  • The Neverwinter Nights: Enhanced Edition dedicated server.

  • NWNX:EE: the official release, or preferably its updated fork.

On Debian, both can be installed from the packages of debian.nwn.ovh: follow its README.md to add the repository and install the packages.

Server directory

The server is started from its user directory, which holds the module, and the hak:

  • modules/ff.mod, the demo module;

  • hak/ff_core.hak, the framework;

Environment variables

Set the variables below in the shell that starts the server. They load every NWNX plugin except the ones the framework does not use, start the framework with ff_x_modstart and stop it with ff_x_modstop, and run the module in debug mode. See Installation for the meaning of each variable.

export NWN_DEBUG=Y
export NWNX_CORE_LOG_LEVEL=6
export NWNX_UTIL_PRE_MODULE_START_SCRIPT=ff_x_modstart
export NWNX_CORE_SHUTDOWN_SCRIPT=ff_x_modstop

export NWNX_CORE_SKIP_ALL=n
export NWNX_DOTNET_SKIP=y
export NWNX_METRICS_INFLUXDB_SKIP=y
export NWNX_REDIS_SKIP=y
export NWNX_RUBY_SKIP=y
export NWNX_SQL_SKIP=y

export NWNX_NWSQLITEEXTENSIONS_ENABLE_2DA_VIRTUAL_TABLE_MODULE=y
export NWNX_TWEAKS_DEAD_CREATURES_TRIGGER_ON_AREA_EXIT=y
export NWNX_TWEAKS_DONT_DELAY_EQUIP_EVENT=y
export NWNX_CORE_ALLOW_NWNX_FUNCTIONS_IN_EXECUTE_SCRIPT_CHUNK=y

Starting the server

From the server user directory:

nwserver --nwnxee --userdirectory . -publicserver 0 -module ff

--nwnxee starts the server with NWNX:EE preloaded.