Skip to content

Latest commit

 

History

History
379 lines (233 loc) · 15.2 KB

changelog.md

File metadata and controls

379 lines (233 loc) · 15.2 KB
Raw

Changelog

v1.5: Time Skip

General

  • Upgraded to Python 3.13.

BL3 Mod Menu v1.4

  • Grouped options with no visible children no longer show their header.

Console Mod Menu v1.4

  • Improved suggestions when trying to bind a key by name, and misspelling it.
  • Swap known controller key names between UE3/UE4 versions, based on game.
  • Grouped options with no visible children no longer show their header.

Mods Base v1.5

  • Added a default rlm command, which is a helper to reload Python modules during development.
  • Deprecated the auto_enable arg in the @hook decorator, since it was misleading and in 99% of cases was not needed.
  • Reworked @hook decorator internals to better support use on methods. It essentially creates a factory, which must be bound to the specific object before use. This is done automatically on mod instances.
  • KeybindOption.from_keybind() now forwards the default_key -> default_value, so that resetting to default works consistently.

Keybinds v2.3

  • Linting fixes.

pyunrealsdk v1.4.0

  • Fixed weak pointer type hinting to allow for null pointers. This always worked at runtime.
  • Added support for Delegate and Multicast Delegate properties.
  • Added a repr to BoundFunction, as these are now returned by delegates.
  • The WrappedStruct constructor can now be used to construct function arg structs, like what's passed to a hook. This does not also apply to unrealsdk.make_struct, since function names conflict far more often.
  • Removed the suggestion to return Ellipsis in hooks when overwriting a return value but not blocking execution. This still works at runtime, but is no longer present in the type hinting, since it made Ellipsis be typed as a valid return in several places it shouldn't have been, and it's an obscure use case to begin with.

UI Utils v1.3

  • Linting fixes.

unrealsdk v1.4.0

  • Fixed that UE3 WeakPointers would always return null, due to an incorrect offset in the UObject header layout.
  • Added support for Delegate and Multicast Delegate properties.
  • Changed unrealsdk::hook_manager::log_all_calls to write to a dedicated file.
  • Fixed missing all CallFunction based hooks in TPS - notably including the say bypass.
  • Added the offline mode say crash fix for BL2+TPS as a base sdk hook.

v1.4: White Elephant

Also see the unrealsdk v1.3.0 changelog here and the pyunrealsdk v1.3.0 changelog here.

General

  • Fixed that in some cases a mod couldn't be disabled, or wouldn't enable actively, due to hooks not getting added/removed properly.

    unrealsdk@227a93d2

  • Mods now show how well they support coop. This is unknown by default, developers need to set it.

    db89e4b3

  • The mod manager now occasionally checks for updates. These will appear on the "Python SDK" mod menu entry.

    9bf295b0

General - Developer

  • Set PYUNREALSDK_PYEXEC_ROOT to the sdk mods folder by default.

    2f15c5ba

  • Fixed that pyright would always error on creating a HiddenOption (due to mismatching generics).

    9bf295b0

BL3 Mod Menu v1.3

Console Mod Menu v1.3

Mods Base v1.4

  • Added the "Coop Support" field.

    db89e4b3

  • Automatically check for mod manager updates.

    9bf295b0

UI Utils v1.2

  • Added a helper to show a tutorial dialog, show_modal_tutorial_dialog.

    51d3c872

  • Fixed an attribute error when calling show_hud_message during a load screen (from a thread).

    51d3c872

v1.3: Lethal Catch

Also see the unrealsdk v1.2.0 changelog here and the pyunrealsdk v1.2.0 changelog here.

General

  • The BL3 release zip now also includes the Console Mod Menu, as it's use proved handy when the dedicated BL3 Mod Menu broke.

    07283ae3

  • Added a warning for when Proton fails to propagate environment variables, which mods or the mod manager may have been expecting.

    An example consequence of this is that the base mod may end up as version "Unknown Version".

    9744640f

  • Added warnings when loading duplicate and/or renamed mod files.

    d6d4476b

General - Developer

  • When developing third party native modules, you can now include this repo as a submodule to automatically keep the Python version in sync. There was a bit of build system restructuring to allow our CMakeLists.txt to define this.

    6f9a8717

  • Changed the OAK_MOD_MANAGER_EXTRA_FOLDERS env var to read from MOD_MANAGER_EXTRA_FOLDERS instead, for consistency.

    9744640f

  • Python warnings are now hooked up to the logging system.

    9744640f

  • Option.on_change now fires automatically when the value is changed.

    a09f92c1

  • Updated type hinting to use 3.12 syntax.

    dfb72a92, 95cc37eb

BL3 Mod Menu v1.2

  • Fixed the crashes that occurred in the latest game update when opening a mod with slider options or keybinds.

    650fdfb5

Console Mod Menu v1.2

  • You can now press back while on the home screen to exit the menu, same as pressing quit. df12460d

  • Improved the suggestions when rebinding a key by name. Multiple suggestions may now be shown, and symbols now try to suggest their name (e.g. typing . will suggest Decimal and Period).

    a488305b

  • Changed strict keybind and ui utils dependencies to be soft dependencies. This is of no consequence to this project, but it makes the mod menu more game-agnostic for other ones.

    These dependencies were only used for the "Rebind using key press" screen, this functionality will now gracefully degrade based on what's available.

    9ab26173, c7dfc4a6, 81aeb178

Keybinds v2.2

  • Moved raw_keybinds out of mods base, into keybinds.

    c7dfc4a6

Mods Base v1.3

  • Moved raw_keybinds out of mods base, into keybinds.

    c7dfc4a6

v1.2: Hand of Glory

Also see the pyunrealsdk v1.1.1 changelog here.

General

  • Changed the shipped pluginloader again, to dsound.dll. This addresses that when running under proton, overriding xinput would break all controller input.

    bab823ff

  • Added an explicit mod manager version, separating it from Mods Base. This means future mod manager updates are not required to also update Mods Base.

    3e0b4d8a

  • Fixed that debugpy had to be placed in the base mod folder, and would break if placed in an extra one.

    4971b8c0

Keybinds v2.1

  • Fixed that rebinding a key wouldn't update the hooks until the mod was next enabled.

    05891ad4

  • Fixed that controller inputs weren't picked up while in menus - effectively meaning you couldn't bind anything to a controller without editing files.

    b0b6881c

Mods Base v1.2

  • Added KeybindType.is_enabled.

    05891ad4

  • Added a hook for keybind implementations to detect rebinds.

    05891ad4

v1.1: Rowan's Call

Also see the unrealsdk v1.1.0 changelog here and the pyunrealsdk v1.1.0 changelog here.

General

  • Added various developer experience improvements. See the Developing SDK Mods guide on the project site for more details.

  • Changed the shipped pluginloader to use xinput1_3.dll, since this won't conflict with dxvk, and since the d3d11.dll one broke the steam overlay.

    e485dcf6

  • Added a warning when the Proton exception bug is detected.

    9046f7d9

  • Added support for building using standard GCC-based MinGW. This is not tested in CI however, as it requires a newer version than that available in Github Actions.

    74f483c5

  • Various linting/type hinting improvements.

BL3 Mod Menu v1.1

  • Made the menu work from the pause menu. Also added options to suppress existing menu entries so that this doesn't mess up SQ muscle memory.

    b221614d, 1e260663, 1d30db37

  • Implemented the "option header" directly, rather than relying on Mod.iter_display_options.

    707a403b

  • Now display mod statuses in the mod list.

    921179ef

Console Mod Menu v1.1

  • Now handle nested options properly, rather than listing all at once. This significantly improves readability for mods with large amounts of options, which use nested options to group them.

    3e88d2b4, 27af0c7a

  • Implemented the "option header" directly, including adding mod statuses to it, rather than relying on Mod.iter_display_options.

    707a403b, 921179ef

  • Improved the display of a few forms of rich text when converted to plain text for console.

    370d80b3

Keybinds v2.0

  • Fixed the large hangs caused when scrolling, by completely rewriting to be registration based.

    0dfe676a, 09407718

Mods Base v1.1

  • Options improvements:

    • No longer warn on "saving" a button option. While useless, this is the only standard option type which wasn't handled, it's now just a silent no-op.

      cb99aba9

    • No longer warn when a keybind option is included in the option list. You may want to do this to get a key to use in menus, for example.

      4f2e17c9

    • NestedOption no longer inherits from ButtonOption. This was true in how the BL2/BL3 Mod Menus implemented them, but does not make much sense functionally.

      3e88d2b4

    • Removed mod from the repr.

      e28423c3

  • Addressed the fact that get_pc may very rarely return None.

    11470d75

  • Made hook default to pre-hooks.

    4ca004a8

  • Reworked keybinds and raw keybinds to support registration based keybind implementations. A polling based implementation can simply use no-op enable/disable functions.

    0dfe676a

  • Mod.iter_display_options no longer yields the "option header". Instead, mod menus directly check Mod.description, Mod.supported_games, and the new Mod.enabling_locked. This both gives mod menus more flexibility in displaying these, and makes it easier for mods to overwrite their display options while retianing the standard header.

    707a403b

  • Added Mod.get_status(), the default implementation of which returns enabled/disabled.

    921179ef

  • Improved the HTML to plain-text converter, parsing a few tags into plain text equivalents. This primarily improves descriptions viewed in the console mod menu.

    370d80b3

  • Did initial work to support willow. In a future update, this module will be shifted to another repo, and be common to both mod managers.

    aa9764ea

UI Utils v1.1

  • Handled that triggering a queued HUD message while in a loading screen would get a player controller of None.

    11470d75

v1.0: Major Kong

  • Initial Release