You are viewing a potentially older version of this package. View all versions.
ATS_API_Devs-API-1.2.0 icon

API

Mod that adds helper methods for other mods and fixes/QOL changes for the game

Date uploaded 3 weeks ago
Version 1.2.0
Download link ATS_API_Devs-API-1.2.0.zip
Downloads 51
Dependency string ATS_API_Devs-API-1.2.0

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)

Help

Discord

If you require help with the mod, have ideas you want added, want to report a problem or want to contribute you can 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 Builders (Minimal)
  • New Recipes
  • Localization

Other stuff added

  • Enums that list everything in the game so you can easily see what items/orders exist and get their data without hassle.

Contributors

  • JamesGames

CHANGELOG

1.2.0 - Contains mod breaking changes.

  • Light support for custom buildings with and without a custom model
    • Houses and Workshops
  • Added RecipeBuilder and WorkshopRecipeBuilder
  • Added new enums
    • BiomeTypes
    • BuildingBehaviourTypes
    • BuildingCategoryTypes
    • BuildingTagTypes
    • BuildingTypes
    • DifficultyTypes
    • EffectTypes
    • GoalTypes
    • GoodsTypes (Enums have been changed)
    • MetaRewardTypes
    • NeedTypes
    • OreTypes
    • ProfessionTypes
    • RaceTypes
    • RelicTypes
    • ResolveEffectTypes
    • SeasonTypes
    • TagTypes
    • TraderTypes
  • Added ToName, GetAll and ToModel helper methods for all enum types
  • Added remove hook helper methods
  • Added SetShowHookedRewardsAsPerks effect helper
  • Added missing language support to hooked effect building (Code breaking)
  • Added namespace for SeasonTypes (Code breaking)
  • Added helper method to generate .cs files for all enums
  • Added Asset bundle helper methods
  • Fixed custom effects without declaring a hook throwing an exception
  • Fixed custom effects that add removal hooks not working
  • Fixed localization sometimes not working for custom mods
  • More code comments/documentation

1.1.1 - Possible mod breaking changes.

  • Added defaults to new goods and effects to avoid errors when making a new perk/cornerstone
  • Added light support for devs to specify a renaming of an effect to avoid breaking saves.
  • Added AfterSeasonChanges Hook (Thanks Shush!)
  • Added SetLabel for EffectBuilders
  • Added GoodsTypes enum for easier referencing types. Can still use string if preferred
  • Fixed missing resolve effects breaking existing save files
  • Fixed HookedEffectBuilder.AddInstantEffect changing the name of the main effect
  • Fixed error message when trying to get a Good that does not exist
  • Renamed SetMissingFields to AssignMissingFieldsToEffect
  • Renamed CanbeSoldToAllTraders to CanBeSoldToAllTraders
  • Changed a lot of namespaces to be more precise

1.1.0

  • Added Custom Trader support
  • Added BareBones support for Custom Order
  • Added GoodsProductionBuilder
  • Added lots more helper methods
  • Fixed tooltip icons showing text instead of icons
  • Fixed unable to sell custom goods at trader (1.3.3)
    • Added optional Short description goods
  • Fixed new fuels breaking existing save files

1.0.0

  • Added Custom Goods support
  • Added Custom Cornerstones support