Skip to content

6.0.0 - Major New Features & Breaking Reworks
Compare
Choose a tag to compare
@ithinkandicode ithinkandicode released this 19 Jun 16:16
· 35 commits to main since this release
v6.0.0
1683759
This commit was created on github.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.

Major New Features

Most notable features of this release:

Steam Workshop Support

  • ModLoader now has native support for Steam Workshop!
    • Special thanks to Blobfish, the developer of Brotato, for layout the groundwork for workshop support.
    • Game developers might also like to try Blobfish's mod uploader, Godot Workshop Utility, which was recently updated to support tags.
  • More info: #148

New Config System

  • Every mod now has its own config JSON file, with a robust system behind the scenes that allows for precise data validation.
  • There are lots of new methods for interacting with a mod's configs, enabling modders to create powerful GUIs to alter and save them.
  • More info: #237

User Mod Profiles

  • User profiles let you decide which mods you want active, letting you swap between different sets of mods as needed.
  • More info: #214

Runtime Mod Disabling

  • You can now enable or disable mods while running a game!
  • This was one of the most requested features, and we're delighted to now support it!
  • More info: #203

Inheritance Checks for Script Extensions

  • Installing a script extension now follows the parent/child hierarchy correctly, which fixes a roadblock many mods have faced.
  • You might never notice this, but it's a much-needed improvement that allows modders to edit a lot more scripts.
  • More info: #124, #277

ModLoader Options

  • A new panel in the editor lets you tweak lots of settings, to help you develop mods faster and easier. Notable options include:
    • Enable/disable all mods.
    • Disable certain mods (this lets you keep all your mods in a single project, without them interfering with each other).
    • Change the log level to be more or less verbose.
    • Override the paths to your mods.
  • To edit them, open res://addons/mod_loader/options. From here, you can open options.tres in the Inspector, then click the resource name in the "Current Options" setting to expand it and edit the options.
  • These options also support multiple profiles, by dragging and dropping a profile resource file into the Current Options. Some examples are provided in the profiles directory.
  • More info: #145, #160

Logging Changes

  • Logs are now stored in memory, and have lots of new API methods via the new ModLoaderLog class.
  • This grants support for modders and developers to do things like creating terminals that display logged messages in-game, with the option to filter by log type (debug, success, info, warning, error).
  • More info: #205

Known Issues

  • When switching from a profile where a mod is inactive to a profile where the same mod is active, the active state of all other profiles is automatically set to active as well.

Breaking Changes

We've refactored the code to be easier to use, more robust, and give better indications of what's available for public use (everything in the api directory) vs. what parts are strictly internal (everything else, plus any classes or methods that start with an underscore (_).

In v6 we've also added new methods for deprecation (#156). This keeps existing mods working, but also provides a warnings if you're using an outdated method, with the warning telling you exactly which method to use instead.

View the Breaking Changes page on the wiki for more details on the changes needed in your mods.

Pull Requests

New Features

Bug Fixes

  • #134 - (3c19fddf) 🐛 Validation: Don't allow mods to include themselves as dependencies or incompatibilities
  • #168 - (6f9068b8) ✏️ Fix typo hypen -> hyphen
  • #176 - (8f669f09) ✏️ Fix typo: improt -> import
  • #183 - (40ae4f18) 🐛 Circular dependency check
  • #184 - (93e6cab4) 🐛 Continue check if circular dep is detected
  • #201 - (41b1801c) 🐛 Self setup chicken and egg problem
  • #202 - (80fea721) 🐛 Check for min length 3 in namespace and name
  • #215 - (34bcb833) 🐛 Check if a mod is_loadable
  • #234 - (a8b22394) 🐛 Wrong UNPACKED_DIR reference
  • #235 - (97eda11f) 🐛 Fix wrong function call
  • #276 - (8f030b2) 🐛 Always use warnings for deprecations in standalone builds
  • #276 - (286f296) 🐛 Transitive Comparator for script sorting
  • #278 - (90334fc) 🐛 log stack only saved for logged_messages.all

Refactors

  • #130 - (8b2ed7b7) ♻️ Added is_silent parameter to validation functions
  • #155 - (08270f14) ♻️ Move class_name to be before extends
  • #157 - (dd92e428) ♻️ API: Move Config to a dedicated class
  • #158 - (046f434b) ♻️ API: Move Steam to a dedicated class
  • #159 - (03ddc46a) ♻️ Move options classes + Rename options_current
  • #163 - (02d128bd) ♻️ ModManifest added type checks
  • #164 - (e4020182) ♻️ Added compatible_mod_loader_version to manifest data
  • #170 - (547c437c) ♻️ Split off dep and inc validation function
  • #171 - (dcdbbeff) ♻️ Added is_semver_version_array_valid()
  • #174 - (bf5f7058) ♻️ ModID in dependencies and incompatibilities
  • #182 - (2776655f) ♻️ Move utility funcs out of mod_manifest.gd
  • #191 - (4cbdbca4) ♻️ Split validation functions
  • #193 - (7f9afed5) ♻️ validate_distinct_mod_ids_in_arrays()
  • #196 - (b4cf01c3) ♻️ Check for valid mod_ids in load_before
  • #197 - (0bbf74be) ♻️ Add mod_id in all validation error messages
  • #199 - (429f8c52) ♻️ Changed mod config dir path to user://configs
  • #205 - (a14a6325) ♻️ Logging rework
  • #208 - (187e5f51) ♻️ Move main mod API funcs to ModLoaderMod, from ModLoader
  • #211 - (5cff4506) ♻️ Created setup_log.gd and setup_utils.gd
  • #218 - (bec0f522) ♻️ Move mod_data ModLoader -> ModLoaderStore
  • #220 - (1d5588b1) ♻️ Move mod_load_order to ModLoaderStore
  • #222 - (36472bb2) ♻️ Added ModLoaderDependency Class
  • #224 - (13672ae2) ♻️ Move remaining vars to ModLoaderStore
  • #225 - (4576b8ba) ♻️ Added ModLoaderScriptExtension Class
  • #226 - (9f4b902f) ♻️ Split up ModLoaderUtils
  • #230 - (5fc7268e) 🚚 Moved and renamed ModLoaderSteam
  • #233 - (60d4f3a7) ♻️ Move consts from ModLoader to ModLoaderStore
  • #283 - (f5eb5a5) 🚚 Moved methods handling mod state

Chores

Code Style Changes

Other Changes

Contributors

In addition to changes from our core team, we also had contributions from these lovely people:

Contributors

Blade67, GDami, and 2 other contributors
Assets 2
Loading