SMLHelper 2.14

Changes in this release #255

• #258

  • Added experimental support for Nitrox compatibility to SMLHelper.

• #260

  • Custom Sounds now Deinitialize after world exit.

• #265

  • Removed extra EventHandler for options menu buttons.

• #267

  • Fixed a bug where stopping custom sounds, stops the entire bus.

• #268

  • Allow mod option menus to provide tooltip language IDs instead of only string literals.

• #269

  • Fixed a bug where if a language line was modified at runtime, the LanguagePatcher wouldn't repatch.

• #270 & #275

  • Added EatableHandler to modify existing eatable item values.

• #274

  • Converted ExampleMod & SMLHelper to .NET SDK. Developers and contributors are now required to have .NET 6 installed.

SMLHelper 2.12.1

Changes in this release #245

• #243

  • Updated FMOD references for experimental branches

• #244

  • Fixed a bug where all of the Save Events weren't getting called when someone patches IngameMenu.SaveGame()

• #246

  • Fixed TechCategoryHandler not showing the correct names for custom TechCategories in the blueprints tab

SMLHelper 2.12

Changes in this release #241

• #237

  • Added many more JsonConverters for Unity data types that are likely to break Newtonsoft's (de)serialization.

  • Added JsonConverters in this PR are for:

    • Vector2
    • Vector4
    • Vector2Int
    • Vector3Int

• #238

  • Added UnityEngine.AudioModule.dll to SMLHelper dependencies
  • Added a function to AudioUtils to convert an AudioClip to FMOD.Sound.
  • Added functions to CustomSoundHandler to register an AudioClip as an FMOD.Sound

• #240

  • Fixed Global Coordinated Spawns NREs.
  • Fixed an error for the FishPrefab class in the SN1 experimental branch.

• #242

  • Moved Quit/Save event invokes to their Async functions.

SMLHelper 2.11.1

Changes in this release #239

This is a hotfix release.

• 5c84fef
  • Hotfix: Resolved an issue introduced in #232, which caused toggle events to no longer be invoked appropriately due to a missing case in the event router.

SMLHelper 2.11

Changes in this release #235

This is a backwards-compatible feature release.

• #233
  • New feature: Added the public abstract class JsonFile to the SMLHelper.V2.Json namespace. This is a very basic implementation of IJsonFile, intended for use for saving and loading simple json files, and can be extended as needed for custom purposes.
  • New feature: Added the public abstract class SaveDataCache to the SMLHelper.V2.Json namespace, which extends from the new JsonFile class. This abstract class is intended to be used in a similar manner as ConfigFile, but for the purpose of per-mod-per-save data. See the linked PR for more details and example usages.
  • New feature: Adds a SaveDataHandler for registering a SaveDataCache with SMLHelper to be automatically saved/loaded to/from disk when appropriate.
  • New feature: Added methods to the InGameMenuHandler that provide the ability to register callbacks with SMLHelper to be invoked whenever a game is loaded, similar to the methods it already provides that invoke a callback when the user saves or quits the game.
  • Maintenance: Example Mod project updated to include examples of how to use the SaveDataCache and SaveDataHandler features.
• #236
  • Enhancement: Adds Vector3Converter and QuaternionConverter to the AlwaysIncludedConverters of ConfigFile implementations.
• #231
  • Bugfix: Resolved an issue where passing custom string names for enum-based Choice was incorrectly displaying the choice as if the first option was selected when the menu is first built, regardless of what option is actually selected.
• #234
  • Bugfix: Resolved an issue where backing out to the main menu and loading into the game again would result in CoordinatedSpawnsInitialized.smlhelper not being correctly saved when the player saves the game.
• #232
  • Maintenance: Invocation of ConfigFile attribute-based events are now deferred until the OptionsPanelHandler has finished registering the ConfigFile to the options menu to ensure consistency across all ConfigFile events.

SMLHelper 2.10.1

Changes made in this release #230

This is a backwards-compatible patch release.

• Hotfix: Identified and resolved bugs in the CoordinatedSpawnsHandler implementation. If you were previously consuming the SpawnInfo API, pay close attention to this PR. #229

SMLHelper 2.10

Changes in this release #223

This is a backwards-compatible feature release.

• New feature: Sound Handler Initial implementation. #220
• Enhancement: Add optional Rotation to Coordinated spawns when using the assets system. #221
• Enhancement: ModPrefab's ProcessPrefab method is now marked protected virtual rather than private. This is intended for the purpose of advanced modders to be able to customise how the prefab is processed via overriding. #225
• Maintenance: Updated to using C# 9.0 and some of its features. #222
• Maintenance: To accommodate #225, CustomFabricator.ProcessPrefab is now renamed CustomFabricator.PreProcessPrefab. #227
• Bugfix: Fixed a bug where non-global coordinated spawns objects were getting despawned after save/reload. #226

SMLHelper 2.9.7

#218
SMLHelper_BZ.EXP.zip
SMLHelper_BZ.STABLE.zip
SMLHelper_SN.EXP.zip
SMLHelper_SN.STABLE.zip

SMLHelper v2.9.0.1

Changes in this version

• Hotfix for an issue introduced in v2.9 affecting some mods using sliders #192

SMLHelper v2.9

Changes made in this version #190

• #189 (new feature) Custom console commands API
  • Added a new API for registering custom console commands that handles basic type-checking and user-error reporting
• #186 (bug fix) BZ Stable Custom Crafter Null SkyApplier Fix
  • Fixed a bug that would throw a NullReferenceException if a prefab does not have a SkyApplier
• #185 (maintenance) Update README to reflect QMM4, BepInEx and HarmonyX
  • Updated REAME.md documentation for QMM4, BepInEx and HarmonyX
• #184 (performance) Asynchronous loading for ModPrefab
  • Added a GetGameObjectAsync method to ModPrefab, so it could work after upcoming async update for SN.
• #173 (new feature) Attribute-based config and mod options
  • Added a new, super-simple way of creating menu items for Mod Options, linked directly to a config file on disk
• #191 Pda Entry Data Overwriting
  • Pda Data overwriting is now allowed. Use with CAUTION