ATS_API_Devs-API icon

API

Simplifies adding/changing ATS and adds fixes/QOL changes.

Last updated 2 weeks ago
Total downloads 1525
Total rating 3 
Categories Tools Libraries
Dependency string ATS_API_Devs-API-2.3.0
Dependants 7 other packages depend on this package

This mod requires the following mods to function

BepInEx-BepInExPack-5.4.2100 icon
BepInEx-BepInExPack

BepInEx pack for Mono Unity games. Preconfigured and ready to use.

Preferred version: 5.4.2100

README

Against The Storm API

This mod is designed to be used in conjunction with other mods that wish to add new content to the game. It provides a number of useful functions for adding new things to the game in a way that takes away the struggles of understanding the code base and more.

Against the Storm is a deeply complex game with tricky to navigate code for the average person. Also with the game being regular updated it's impossible to know what the devs will change in code which can result in your mod breaking and requiring you to manually fix and reupload it.

The API works as an in-between of your mod and the game by supplying helper methods that create new content and insert it into the game accordingly. This means that if the game updates and breaks your mod, the API will be updated to fix it and require little to no support from your end. (fingers crossed)

alt text alt text

How to install

Installation with Thunderstore (Recommended)

  1. Download and install the Thunderstore app for free from here
  2. Install API mod using the Thunderstore App
    • Be sure BepInEx is installed too!
  3. Run the game using Thunderstore

Manual Installation

  1. Install v5.4.21 of BepInEx
  2. Install API mod
    • Download content using the Manual Download button
    • Extract the contents of the zip into the Against the Storm/BepInEx/plugins folder
  3. Run the game

Help

Example Mod

The API is worked on alongside the Example Mod mod which contains at least 1 of every new feature in the API to ensure everything is working as we expect.

You're encouraged to view all the code and copy+paste anything you require into your own mod.

If anything does not work please reach out on the discord!

Github: https://github.com/JamesVeug/AgainstTheStormAPI/tree/master/ExampleMod

Thunderstore: https://thunderstore.io/c/against-the-storm/p/ATS_API_Devs/ExampleMod/

Discord

If you require help with the mod, have ideas you want added, want to report a problem or just want to chat join our discord.

https://discord.com/invite/ZfVWG86gsJ

Wiki

If you need help with how to use the API here is the wiki to provide examples and explanations.

https://github.com/JamesVeug/AgainstTheStormAPI/blob/master/ATS_API/WIKI/WIKI.md

Support added for

  • New Goods (items that can be traded/sold, food & fuel)
  • New Perks/Cornerstones
  • New Traders
  • New Orders (Minimal)
  • New Buildings (Minimal)
  • New Recipes
  • New Races (Experimental)
  • New Difficulties
  • New MetaRewards (Goods and Effects when embarking)
  • Localization for all of the above
  • Custom Hotkeys (Saving and rebinding included)
  • Custom Save/Load system

Other stuff added

  • Any options/configs that mods add can be modified in the options menu of the game.
  • Enums that list everything in the game, so you can easily see what items/orders exist and get their data without hassle.

Contributors

  • JamesGames