Skip to content

Getting Started with NKHook5

Mike edited this page Feb 7, 2023 · 1 revision

Getting Started

The best way to begin creating mods with NKHook5 is to use the DevKit.exe provided in the Releases section.

Installing DevKit

To 'install' the DevKit, simply place the exe file into a folder alone.

Setting up DevKit

Now that you have 'installed' the DevKit, open a Terminal, Command Prompt, or Powershell window at that folder location. This can be done with shift+right click on Windows 10. On Windows 11, you will need to click the additional "Show more options" button. An option to open a Command Prompt, Terminal, or Powershell at that folder location should be available. If it isn't you can always use the cd command to change the current directory.

After you have opened a Terminal, Command Prompt, or Powershell window, write DevKit.exe -h to view the help menu (NOTE: If this doesn't work, you may need to add .\ before each command you type for DevKit.exe). Use DevKit.exe -s to begin the setup process. The setup will ask a few simple questions, just fill them out and you're done.

Creating a mod

To create your first mod, use DevKit.exe -c <mod name> and replace <mod name> with the name of your mod. This can always be changed later. The creation process will automatically create a mod folder and extract all of BTD5's assets for you to use

Updating a mod

Despite BTD5 being quite an old game, Ninja Kiwi still releases some new maps and updates. To update your mod for a new version, use the DevKit.exe -u <mod name> command. This will update the mod to use the latest vanilla assets, which will help prevent mod-breaking changes.

Clone this wiki locally