From 45c583b5821d12b7dd404413a9608e5ccc2832ed Mon Sep 17 00:00:00 2001 From: James Gale Date: Tue, 29 Jun 2021 13:15:25 -0700 Subject: [PATCH] Update README.md --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e7f3d8d06..7b5980c36 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,24 @@ A powerful and easy to use API for modding BTD6, BATTD, and other Ninja Kiwi games. It was created with the successes and failures of previous APIs in mind so it's significantly easier to use. ## How to use it -Like other API, download/clone it. In your mod's Visual Studio project add a reference to `BloonsTD6 Mod Helper.dll` or `BloonsAT Mod Helper.dll` depending on your game. Then at the top of each file in your project, add `using BTD_Mod_Helper.Extensions;`. Thats it. Each file that has this line at the top will have complete access to all of the features added by the API. This API is built using extension methods, which means it's created to work along side the game's own code. So just make your mods like normal and you'll see the new features pop up in Visual Studio Intellisense. As a side note, make sure the mod is in your game's Mods folder. It needs to be run like a mod + +**NEW: For the most up to date information, use our [GitHub Wiki](https://github.com/gurrenm3/BTD-Mod-Helper/wiki)** + + +Like other API, download/clone it. In your mod's Visual Studio project add a reference to `BloonsTD6 Mod Helper.dll` or `BloonsAT Mod Helper.dll` depending on your game. In your mod files, you can now use `using BTD_Mod_Helper;` and derivatives like `using BTD_Mod_Helper.Extensions;` to access the Mod Helpers contents. Thats it. Much of this API is built using extension methods, which means it's created to work along side the game's own code. So just make your mods like normal and you'll see the new features pop up in Visual Studio Intellisense. As a side note, make sure the mod is in your game's Mods folder. It needs to be run like a mod ## What can this API currently help with + +**NEW WITH VERSION 2.0** +- A fully featured custom Tower system that makes adding new Towers vastly easier + - ModTower for adding Towers + - ModUpgrade for adding Upgrades + - ModDisplay for adding Displays +- In Game configurable settings for your mods +- Automatic registering of textures that you include in your project + +**Original** + - Much of the useful game code is hidden, deeply nested, and located in obscure places. The API moves them to `Game.instance` and `InGame.instance` whenever it makes sense to make them significantly easier to access and bring awareness to their existance. - Many extension methods added to make modifying towers, upgrades, weapons, projectiles, and bloons easier. - A lot of code for towers/bloons is unconnected, meaning you have to go all over to find something. API connects them in as many ways as possible