Merge pull request #14 from apple1417/master

add changelog and bump version numbers

changelog.md

@@ -0,0 +1,147 @@
+# Changelog
+
+## v1.1
+
+Also see the unrealsdk v1.1.0 changelog [here](https://github.com/bl-sdk/unrealsdk/blob/master/changelog.md#v110)
+and the pyunrealsdk v1.1.0 changelog [here](https://github.com/bl-sdk/pyunrealsdk/blob/master/changelog.md#v110).
+
+### General
+
+- Added various developer experience improvements. See the [Developing SDK Mods](https://bl-sdk.github.io/oak-mod-db/developing/)
+  guide on the project site for more details.
+
+  - Added integration with [debugpy](https://github.com/microsoft/debugpy).
+
+    [2259a225](https://github.com/bl-sdk/oak-mod-manager/commit/2259a225),
+    [5a5f5a32](https://github.com/bl-sdk/oak-mod-manager/commit/5a5f5a32)
+
+  - Added support for multiple mods folders, so your own in-development mods can be kept separate.
+
+    [0d1c76e3](https://github.com/bl-sdk/oak-mod-manager/commit/0d1c76e3),
+    [e42e89ac](https://github.com/bl-sdk/oak-mod-manager/commit/e42e89ac)
+
+- 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](https://github.com/bl-sdk/oak-mod-manager/commit/e485dcf6)
+
+- Added a warning when the Proton exception bug is detected.
+
+  [9046f7d9](https://github.com/bl-sdk/oak-mod-manager/commit/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](https://github.com/bl-sdk/oak-mod-manager/commit/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](https://github.com/bl-sdk/oak-mod-manager/commit/b221614d),
+  [1e260663](https://github.com/bl-sdk/oak-mod-manager/commit/1e260663),
+  [1d30db37](https://github.com/bl-sdk/oak-mod-manager/commit/1d30db37)
+
+- Implemented the "option header" directly, rather than relying on `Mod.iter_display_options`.
+
+  [707a403b](https://github.com/bl-sdk/oak-mod-manager/commit/707a403b)
+
+- Now display mod statuses in the mod list.
+
+  [921179ef](https://github.com/bl-sdk/oak-mod-manager/commit/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](https://github.com/bl-sdk/oak-mod-manager/commit/3e88d2b4),
+  [27af0c7a](https://github.com/bl-sdk/oak-mod-manager/commit/27af0c7a)
+
+
+- Implemented the "option header" directly, including adding mod statuses to it, rather than relying
+  on `Mod.iter_display_options`.
+
+  [707a403b](https://github.com/bl-sdk/oak-mod-manager/commit/707a403b),
+  [921179ef](https://github.com/bl-sdk/oak-mod-manager/commit/921179ef)
+
+- Improved the display of a few forms of rich text when converted to plain text for console.
+
+  [370d80b3](https://github.com/bl-sdk/oak-mod-manager/commit/370d80b3)
+
+### Keybinds v2.0
+
+- Fixed the large hangs caused when scrolling, by completely rewriting to be registration based.
+
+  [0dfe676a](https://github.com/bl-sdk/oak-mod-manager/commit/0dfe676a),
+  [09407718](https://github.com/bl-sdk/oak-mod-manager/commit/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](https://github.com/bl-sdk/oak-mod-manager/commit/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](https://github.com/bl-sdk/oak-mod-manager/commit/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](https://github.com/bl-sdk/oak-mod-manager/commit/3e88d2b4)
+
+  - Removed `mod` from the repr.
+
+    [e28423c3](https://github.com/bl-sdk/oak-mod-manager/commit/e28423c3)
+
+- Addressed the fact that `get_pc` may very rarely return `None`.
+
+  [11470d75](https://github.com/bl-sdk/oak-mod-manager/commit/11470d75)
+
+- Made `hook` default to pre-hooks.
+
+  [4ca004a8](https://github.com/bl-sdk/oak-mod-manager/commit/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](https://github.com/bl-sdk/oak-mod-manager/commit/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](https://github.com/bl-sdk/oak-mod-manager/commit/707a403b)
+
+- Added `Mod.get_status()`, the default implementation of which returns enabled/disabled.
+
+  [921179ef](https://github.com/bl-sdk/oak-mod-manager/commit/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](https://github.com/bl-sdk/oak-mod-manager/commit/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](https://github.com/bl-sdk/oak-mod-manager/commit/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](https://github.com/bl-sdk/oak-mod-manager/commit/11470d75)
+
+## v1.0
+- Initial Release

src/bl3_mod_menu/__init__.py

@@ -7,7 +7,7 @@
     "__version_info__",
 ]
 
-__version_info__: tuple[int, int] = (1, 0)
+__version_info__: tuple[int, int] = (1, 1)
 __version__: str = f"{__version_info__[0]}.{__version_info__[1]}"
 __author__: str = "bl-sdk"
 

src/console_mod_menu/__init__.py

@@ -11,7 +11,7 @@
     "__version_info__",
 )
 
-__version_info__: tuple[int, int] = (1, 0)
+__version_info__: tuple[int, int] = (1, 1)
 __version__: str = f"{__version_info__[0]}.{__version_info__[1]}"
 __author__: str = "bl-sdk"
 

src/mods_base/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "mods_base"
-version = "1.0"
+version = "1.1"
 authors = [{ name = "bl-sdk" }]
 description = "The SDK itself."
 

src/ui_utils/__init__.py

@@ -4,7 +4,7 @@
 
 __all__: tuple[str, ...] = ("__author__", "__version__", "__version_info__", "show_hud_message")
 
-__version_info__: tuple[int, int] = (1, 0)
+__version_info__: tuple[int, int] = (1, 1)
 __version__: str = f"{__version_info__[0]}.{__version_info__[1]}"
 __author__: str = "bl-sdk"