Skip to content

Building the Module

b5635 edited this page Jun 20, 2023 · 44 revisions

Please note that I developed this using Windows 10, so the instructions and batch file will be for that.

Note that the screenshots may show "and the Wailing Death", but this has been re-named to TFN.

Building

IMPORTANT: Do not run this before committing any changes you have made, as you may lose them!

Building the module is relatively simple - just run win_run_nasher_install.bat. This will be located in the root of your repository. You can access it in GitHub Desktop by going to Repository > Show in Explorer, or pressing Control + Shift + F (Command + Shift + F on a Mac)

Running the nasher_install.bat will create the mod file which is located at modules/TFN.mod in the root of the repo that was cloned, as well as it's associated mod folder.

IMPORTANT: Do not run this before committing any changes you have made, as you may lose them!

Running the Toolset

We need to run the toolset with a special argument that points to the files in the repository. There are two choices:

a) Provided .bat file for Steam, GoG and default Beamdog Client installs (recommended).

b) Creating your own shortcut.

a) Provided .bat file for Steam, GoG and default Beamdog Client installs

This will work if you have Steam installed to C:\Program Files (x86)\Steam and if you have elected to not change the install location for NWN:EE, if you have GoG, NWN:EE installed to C:\Program Files (x86)\GOG Galaxy\Games\Neverwinter Nights Enhanced Edition, or if you have Beamdog and it is installed to C:\Users\%USERNAME%\Beamdog Library\00785\. If it doesn't find it, it will attempt to search for it through the registry for Steam and GoG installs.

Simply run toolset.bat and it should start the toolset.

b) Creating your own shortcut

You will need to navigate to where your nwtoolset.exe resides and create a shortcut.

Next, right click on the shortcut and click on "Properties". We will need to modify the "Target" field.

Currently, it is just the path to the toolset. Make sure it is pointing to your NWN folder where "nwtoolset.exe" is located.

"C:\Program Files (x86)\Steam\steamapps\common\Neverwinter Nights\bin\win32\nwtoolset.exe".

We will need to add an argument that points it to the GitHub repository, like so:

"C:\Program Files (x86)\Steam\steamapps\common\Neverwinter Nights\bin\win32\nwtoolset.exe" -userdirectory "C:\Users\b11\Documents\GitHub\the-frozen-north"

Always use the shortcut you have created to start the toolset when editing this project, otherwise it won't see it.

Next, setup your nasher environment variable:

Running the Toolset

You should be able to see "TFN" when you run the toolset.

If you do not see it, then try building the module by running win_run_nasher_install.bat and/or checking if your -userdirectory argument is pointing to your GitHub repository.

Make sure you always select the option "YES - open directory"

Next up is either running the server or adding your first contribution.

If you run into any issues, please hop into Discord and I will help.