From db639c0288e3992c6f861b4f91041adfb5a2e2f4 Mon Sep 17 00:00:00 2001 From: Ricardo Subtil Date: Thu, 29 Jun 2023 12:53:23 +0100 Subject: [PATCH] Bump version to v2.0.0 --- DOCS.md | 18 ++++++++++++++++++ addons/controller_icons/plugin.cfg | 2 +- addons/controller_icons/settings.tres | 2 +- 3 files changed, 20 insertions(+), 2 deletions(-) diff --git a/DOCS.md b/DOCS.md index 6e3603a..df89739 100644 --- a/DOCS.md +++ b/DOCS.md @@ -11,6 +11,8 @@ - [Adding/removing controller iconss](#addingremoving-controller-icons) - [Changing controller mapper](#changing-controller-mapper) - [TTS support](#tts-support) +- [Porting addon versions](#porting-addon-versions) + - [v1.x.x to v2.0.0](#v1xx-to-v200) - [Generic path lookup](#generic-path-lookup) @@ -157,6 +159,22 @@ func _ready(): var ttx_text = ControllerIcons.parse_path_to_tts("key/z") ``` +# Porting addon versions + +This section details porting instructions between breaking changes of the addon. + +## v1.x.x to v2.0.0 + +- The `ControllerSetting.Devices` enum had some dangling values removed, which changed the order of a few existing keys. If you rely on these values, you'll need to update your code: + - The `VITA`, `WII` and `WIIU` values were removed. These were not used anywhere in the addon, so you shouldn't be affected by this. + - The preceding enum keys had their values changed by this: `XBOX360`, `XBOXONE`, `XBOXSERIES` and `STEAM_DECK` enum values have changed. If you use these values directly in your code, you'll need to update them. + - The default settings file (`settings.tres`) will need to be updated, as the `Joypad Fallback` setting depends on this. +- Some Nintendo Switch asset filenames were renamed. If you use these assets directly in your project, you'll may need to re-add them: + - `switch/lb.png` -> `switch/l.png` + - `switch/rb.png` -> `switch/r.png` + - `switch/lt.png` -> `switch/zl.png` + - `switch/rt.png` -> `switch/zr.png` + # Generic path lookup Below is a table of the existing generic joypad paths, as well as to what icons they map for each controller type shipped. diff --git a/addons/controller_icons/plugin.cfg b/addons/controller_icons/plugin.cfg index 3dc36a5..7387242 100644 --- a/addons/controller_icons/plugin.cfg +++ b/addons/controller_icons/plugin.cfg @@ -3,5 +3,5 @@ name="Controller Icons" description="Provides icons for all major controllers and keyboard, with automatic icon remapping." author="rsubtil" -version="1.1.4" +version="2.0.0" script="plugin.gd" diff --git a/addons/controller_icons/settings.tres b/addons/controller_icons/settings.tres index bb32091..591c3fd 100644 --- a/addons/controller_icons/settings.tres +++ b/addons/controller_icons/settings.tres @@ -4,7 +4,7 @@ [resource] script = ExtResource("1") -joypad_fallback = 12 +joypad_fallback = 9 joypad_deadzone = 0.5 allow_mouse_remap = true mouse_min_movement = 200