BTD Documentation

This repository is for documenting anything related to NK modding

• NK Unity - The set of Libs NK uses for BTD6/TK/BATTD
• Solidarity BTD5 Engine - The name for the BTD5/BTDB/BMC/SAS4 engine/shared code. I'm not entirely sure where the name came from, but unless somebody can verify an actual name for the engine, the wiki will be sticking with it. Nobody knows the damn name so we'll just call it what it is

Documentation Status

This page can be used to track the documentation of BTD. If your working on a page, add it to here.

BTD6

All info releating to BTD6 modding can be found here

BATTD

There is some info relating to BATTD modding here. It's the same as modding BTD6 so go to BTD6 modding for more info

Tower Keepers

Nothing Tower Keepers Specific documented yet.

NK Unity Engine

All about NK's games made using Unity

---

BTD5

Nothing BTD5 Specific documented yet.

BTDB

Nothing BTDB Specific documented yet.

BMC

Nothing BMC Specific documented yet.

SAS4

Nothing SAS4 Specific documented yet.

Solidarity

No work has been done on the solidarity engine so far.

Contributing

Editor

To edit and contribute to this documentation, Visual Studio Code is recommended.
Once installed, download the Markdown All In One extension through the "Extensions" bar on the left.
Once installed, if you open a Markdown (.md) file, and press Ctrl + Shift + V and a preview window will appear.
Finally, install the Spell Right addon.
This is just a recommended setup, it provides a markdown preview and a spellchecked as well as git integration.

Using git

Unsure how to use git with Visual Studio Code? Here's a quick overview!
First, download GitHub for desktop
Open GitHub For Desktop, in the toolbar at the top File -> Clone Repository and insert https://github.com/TDToolbox/BTD-Docs into the "Repository URL or GitHub username and repository.
The repository should now be cloned, Open the repository in Visual Studio Code. In the toolbar at the top File -> Open Folder then navigate to the repo (Probably C:\Users\YourUserName\source\repos\. )
Make your changes...
Click on the window on the left bar of Visual Studio code called "Source Control" (Alternatively press Ctrl + Shift + G)
To save a new version, click on the ellipsis (...) at the top and click Commit all. This will effectively "Save As" a copy of your changes. Click "Always" to the popup and add a commit message such as "Added brief tutorial to README.md"
To share these changes to the world & receive updates, click on the ellipsis (...) again and click Sync

Using Markdown

A comprehensive tutorial can be found at https://www.markdownguide.org/basic-syntax
A cheat sheet can be found at https://www.markdownguide.org/cheat-sheet