Merge pull request #53 from wduda/develop

Merge for v1.0.9beta

Author: wduda

.github/workflows/release.yml

@@ -1,14 +1,8 @@
 # This workflow will create the release artifact and a release on GitHub
-name: release
+name: GitHub release
 
 on:
-  # on push of new release tag to master
-  #push:
-  #  branches:
-  #    - 'master'
-  #  tags:
-  #    - 'v*'
-  # also allows job to be run manually from actions tab
+  # allows job to be run manually from actions tab
   workflow_dispatch:
     inputs:
       tag:
@@ -20,16 +14,20 @@ jobs:
 
     steps:
       # checks out master under $GITHUB_WORKSPACE
-      - uses: actions/checkout@v2
+      - name: checkout
+        uses: actions/checkout@v2
         with:
           ref: '${{ github.event.inputs.tag }}'
 
-      - name: get the version name from tag
-        id: get_version
-        run: echo ::set-output name=VERSION::${GITHUB_REF/refs\/tags\//}
       # create a zip as a release archive
-#      - name: create release archive
-#       uses: thedoctor0/zip-release@master
-#        with:
-#          filename: 'TravelWindowII-${{ steps.get_version.outputs.version }}.zip'
-#          exclusions: '*.git* .github* *.vscode* *.gitignore*'
+      - name: create release archive
+        uses: thedoctor0/zip-release@master
+        with:
+          filename: 'TravelWindowII-${{ github.event.inputs.tag }}.zip'
+          exclusions: '*.git* .github* *.vscode* *.gitignore*'
+
+      - name: upload release archive
+        uses: actions/upload-artifact@v2
+        with:
+          name: 'Release archive ${{ github.event.inputs.tag }}'
+          path: 'TravelWindowII-${{ github.event.inputs.tag }}.zip'

CHANGELOG.md

@@ -1,7 +1,11 @@
 # Changelog
 
 ## v1.0.9beta
-- automated builds for faster releases (internal)
+- fixed bug where pressing Esc did not close the options window (bugfix)
+- fixed bug where changing options was lagging the client, especially on chamging opacity sliders (bugfix)
+- automated github builds for faster releases (internal)
+- cleaned up settings stored by plugin to remove unused data (internal)
+- cleaned up some code for better readability (internal)
 
 ## v1.0.8beta
 - made it so the plugin can attempt to import all settings from v1.06beta or earlier if new settings file is not present, so an import can be forced by deleting TravelWindowII.plugindata - see FAQ

TravelWindowII.plugin

@@ -3,7 +3,7 @@
     <Information>
         <Name>Travel Window II</Name>
         <Author>Hyoss</Author>
-        <Version>v1.0.8beta</Version>
+        <Version>v1.0.9beta</Version>
         <Description>
         This plugin creates a single window that contains all the available travel skills, including the race, class and reputation skills.
 It is a further development of Travel Window, that has been worked on by multiple authors before.

TravelWindowII.plugincompendium

@@ -2,7 +2,7 @@
 <PluginConfig xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <Id>1113</Id>
   <Name>Travel Window II</Name>
-  <Version>v1.0.8beta</Version>
+  <Version>v1.0.9beta</Version>
   <Author>Hyoss</Author>
   <InfoUrl>http://www.lotrointerface.com/downloads/info1113</InfoUrl>
   <DownloadUrl>http://www.lotrointerface.com/downloads/download1113</DownloadUrl>

doc/changelog.md

@@ -1,36 +1,42 @@
-This plugin creates a single window that contains all the available travel skills, including the race, class and reputation skills. It is a further development of Travel Window, that has been worked on by multiple authors before.
+This plugin creates a single window that contains available travel skills, including the race, class, housing and reputation skills. It is a further development of the "Travel Window" plugin, that has been worked on by multiple authors before.
 
-[B]Since this plugin is a replacement for Travel Window you should not have both enabled at the same time. You can keep them both installed though.[/B]
+[B]Since this plugin is a 100% replacement for "Travel Window" you should not have both enabled at the same time. You can keep them both installed though.[/B]
 
-Installation:
+[SIZE="3"]Installation:[/SIZE]
 This is a full plugin and can be installed standalone. Follow the general plugin installation instructions to install Travel Window II or update the install (depends on your OS).
-I recommend you install and manage your plugins with the LOTRO Plugin Compendium found here, since it will install plugins cleanly and take care of installing the Turbine utilities for you: [URL="http://www.lotrointerface.com/downloads/info663-LOTROPluginCompendium.html"]http://www.lotrointerface.com/downloads/info663-LOTROPluginCompendium.html[/URL]
+I recommend you install and manage your plugins with the LOTRO Plugin Compendium found at this URL, since it will install plugins cleanly and take care of installing the Turbine utilities for you: [URL="http://www.lotrointerface.com/downloads/info663-LOTROPluginCompendium.html"]LOTRO Plugin Compendium App[/URL]
 
 If you do not use Plugin Compendium, you need to manually install Turbine utilities that are available at:
 [URL="http://content.turbine.com/sites/lotro/lua/Beta_LuaPlugins.7z"]http://content.turbine.com/sites/lotro/lua/Beta_LuaPlugins.7z[/URL]
 This has to be extracted to your "Documents\The Lord of the Rings Online\Plugins" folder (if you are on Windows) so two folders called Turbine and TurbinePlugins show up there.
 
+[SIZE="3"]FAQ:[/SIZE]
+How to handle the settings reset introduced by v1.0.7beta?
+[LIST]
+[*] if you had v1.0.6beta or earlier and update to v1.0.8beta or newer, you will keep your settings, but enable/disable and sorting will have to be reset - this is the best case where most settings can be kept
+[*] if you updated to v.1.0.7beta but never logged that character in, an update to v1.0.8beta or newer will work as the above best case
+[*] if you updated to v.1.0.7beta and logged that character in, you lost all settings, you now have two choices
+[*]1. keep the settings you made manually after logging in with v1.0.7beta installed
+[*]2. delete the TravelWindowII.plugindata file, and your settings from before will be imported by v1.0.8beta or newer, same as the best-case scenario
+[*]The file can be found at C:\Users\%USERNAME%\Documents\The Lord of the Rings Online\PluginData\%ACCOUNTNAME%\%SERVERNAME%\%CHARACTERNAME%
+[/LIST]
+Why does my racial skill show up even though I do not have the racial trait equipped?
+[LIST]
+[*]Because once the trait is aquired, it is classified as a "learned" skill by LOTRO itself, even though it is greyed out. Travel Window II, unfortunately, has no way of knowing if you have the racial trait equipped and the skill is usable. If you are not using the skill permanently, you can use the Enable/Disable options to hide it like any other skill.
+[/LIST]
+Why does a reputation or store version of my racial skill show up even though I have not obtained or bought it?
+[LIST]
+[*]This is because the racial and those store-bought skills have identical names ingame (i.e. "Return to Bree") and the plugin obtains a list of learned skills that includes that name at least once. Based on that name alone the plugin cannot know which of the two skills you have obtained, while you can get both through Racial+Store combo. You can use the Enable/Disable options to hide the skill you do not have that is greyed out.
+[/LIST]
 
 Version history:
-v1.0.7beta
-[SIZE="1"]- changed enabled/disabled function to identify skills by ID - fixes problems with skills sharing names, like racial/rep, map home/Beorning racial (bugfix) closes #25 #17
-- changed sorting identify skills by ID - sorting will now work and save its settings properly (bugfix) closes #15 
-- fixed wrong order of milestone skills (bugfix) closes #9 
-- made it so Travel Window II has its own config file - settings will reset once! (enhancement)
-- verified all 151 skills in English client, fixed 7 broken skills, with some fixed by Drono
-- verified all 151 skills in German client, fixed 41 broken skills
-- verified all 151 skills in German client, fixed 74 (!) broken skills, with some help from Adra
-- updated English localization (enhancement)
-- updated French localization thanks to Adra (enhancment)
-- updated German localization (enhancement)
-- reduced code duplication in indexedDictionaries so future development will become easier (internal)
-[/SIZE]
-
-
-v1.0.6beta
-[SIZE="1"]- Plugin Compendium will now install Turbine libraries if they are not installed yet when you install Travel Window (enhancement)
-- changed Shire and Rivendell skill labels to be closer to user expectations (they are now Shire (Store), Shire (Racial), Rivendell (Store)) (bugfix)
-- fixed Premium house skill in German client (bugfix)
-- fixed about 30 skills in German client that were not working before (bugfix)
+v1.0.9beta
+[SIZE="1"]
+- fixed bug where pressing Esc did not close the options window (bugfix)
+- fixed bug where changing options was lagging the client, especially on chamging opacity sliders (bugfix)
+- automated github builds for faster releases (internal)
+- cleaned up settings stored by plugin to remove unused data (internal)
+- cleaned up some code for better readability (internal)
 [/SIZE]
 
+Rest of changelog found [URL="https://github.com/wduda/TravelWindowII/blob/master/CHANGELOG.md"]here[/URL].

doc/lotrointerface.md

@@ -27,9 +27,6 @@ function OptionsPanel:Constructor(parent)
     self.checks = {};
     self.mainWindow = parent;
 
-    -- store race to only add racial skill that applies
-    self.racetype = parent.racetype;
-
     -- keep track of which item is selected on the sort tab
     self.sortSelectedIndex = 1;
     self.sortMaxItem = 0;
@@ -333,8 +330,8 @@ function OptionsPanel:AddGeneralItems()
 
         -- do updates
         settings.toggleMinOpacity = self.toggleMinScrollBar:GetValue() / 100;
-        self.mainWindow:UpdateSettings();
         self.mainWindow:UpdateOpacity();
+        self.mainWindow:UpdateSettings();
     end
 
     self.toggleMaxScrollBar.ValueChanged = function(sender, args)
@@ -346,8 +343,9 @@ function OptionsPanel:AddGeneralItems()
 
         -- do updates
         settings.toggleMaxOpacity = self.toggleMaxScrollBar:GetValue() / 100;
-        self.mainWindow:UpdateSettings();
         self.mainWindow:UpdateOpacity();
+        self.mainWindow:UpdateSettings();
+
     end
 
     -- update settings when sliders change
@@ -360,8 +358,8 @@ function OptionsPanel:AddGeneralItems()
 
         -- do updates
         settings.mainMinOpacity = self.mainMinScrollBar:GetValue() / 100;
-        self.mainWindow:UpdateSettings();
         self.mainWindow:UpdateOpacity();
+        self.mainWindow:UpdateSettings();
     end
 
     self.mainMaxScrollBar.ValueChanged = function(sender, args)
@@ -373,8 +371,8 @@ function OptionsPanel:AddGeneralItems()
 
         -- do updates
         settings.mainMaxOpacity = self.mainMaxScrollBar:GetValue() / 100;
-        self.mainWindow:UpdateSettings();
         self.mainWindow:UpdateOpacity();
+        self.mainWindow:UpdateSettings();
     end
 end
 
@@ -419,10 +417,10 @@ function OptionsPanel:AddItems()
             counter = counter + 1;
         end
     end
-    
+
     -- add the race specific travel skill for the character
     if (playerAlignment == Turbine.Gameplay.Alignment.FreePeople) then
-        self:AddSkillItemForEnabling(counter, racialLocations:IdAtIndex(self.racetype), racialLocations:LabelAtIndex(self.racetype));
+        self:AddSkillItemForEnabling(counter, racialLocations:IdAtIndex(settings.playerRaceKey), racialLocations:LabelAtIndex(settings.playerRaceKey));
         counter = counter + 1;
     end
 

src/OptionsPanel.lua

@@ -34,9 +34,6 @@ function OptionsWindow:Constructor(parent)
     -- set the window to be visible
     self:SetVisible(true);
 
-    -- store race to only add racial skill that applies
-    self.racetype = parent.racetype;
-
     -- have the main window close the options
     self.VisibleChanged = function(sender, args)
         if (self:IsVisible() == false) then

src/OptionsWindow.lua

@@ -14,8 +14,6 @@ function SettingsMenu:Constructor(parentWindow)
     togglebit = TravelWindowII.togglebit;
 
     -- set the default values
-    self.race = 1;
-    self.class = 1;
     self.mode = 1;
     self.filters = 0x0F;
 
@@ -147,15 +145,13 @@ end
 
 -- get the setting from the main window
 function SettingsMenu:GetSettings()
-    return self.race, self.class, self.mode, self.filters;
+    return self.mode, self.filters;
 end
 
 -- function to change the settings of the menu programmatically
-function SettingsMenu:SetSettings(s1, s2, s3, s4)
-    self.race = s1;
-    self.class = s2;
-    self.mode = s3;
-    self.filters = s4;
+function SettingsMenu:SetSettings(s1, s2)
+    self.mode = s1;
+    self.filters = s2;
 
     self:SetSelections();
 end
@@ -200,6 +196,7 @@ function SettingsMenu:Update(string)
 
     -- update the main window settings
     self.parent:UpdateSettings();
+    self.parent:SaveSettings();
 end