New Api Version

Reviewed-on: #6

.drone.yml

@@ -28,6 +28,7 @@ steps:
     - apk update && apk add --no-cache zip
     # Delete unneeded files/dirs
     - rm -rf sources/.git
+    - rm -rf sources/screenshots
     - rm -f sources/.drone.status
     - rm -f sources/.drone.yml
     - rm -f sources/.luacheckrc

.luacheckrc

@@ -19,5 +19,6 @@ read_globals = {
     "EVENT_MANAGER",
     "LINK_STYLE_BRACKET",
     "zo_callLater",
+    "zo_strformat",
     "ZO_SavedVars",
 }

AchievementInfo.lua

@@ -15,6 +15,7 @@ function AchievementInfo.initialize(_, addOnName)
         AchievementInfo.hijackedFirstLoad = true
 
         -- Load Saved Variables
+        AchievementInfo.useAccountWideSettings = AchievementInfo.loadUseAccountWideSettings()
         AchievementInfo.savedVars = AchievementInfo.loadSavedVars()
 
         -- Load Language Data

AchievementInfo.txt

@@ -5,8 +5,8 @@
 ## Author: |c87B7CCAsto|r, @Astarax
 ## Contact: mail@coded-with-heart.com
 
-## APIVersion: 100031
-## SavedVariables: ACHIEVEMENT_INFO_DB
+## APIVersion: 101039
+## SavedVariables: ACHIEVEMENT_INFO_DB ACHIEVEMENT_INFO_DB_USE_AW
 
 ## DependsOn: LibAddonMenu-2.0
 

AchievementInfoApplication.lua

@@ -67,13 +67,18 @@ function AchievementInfo.onAchievementUpdated(_, achId)
             tmpOutput = tmpOutput .. ", "
         end
 
-        tmpOutput = tmpOutput .. description .. " "
+        tmpOutput = tmpOutput .. zo_strformat("<<1>>", description) .. " "
         tmpOutput = tmpOutput .. AchievementInfo.calcCriteriaColor(numCompleted, numRequired) .. numCompleted .. "|r"
         tmpOutput = tmpOutput .. AchievementInfo.clrDefault .. "/" .. "|r"
         tmpOutput = tmpOutput .. AchievementInfo.clrCriteriaComplete .. numRequired .. "|r"
         tmpOutput = tmpOutput .. AchievementInfo.clrDefault
 
-        if AchievementInfo.settingGet("genShowOpenDetailsOnly") == true and numCompleted ~= numRequired then
+        if AchievementInfo.settingGet("genShowOpenDetailsOnly") == true then
+            if numCompleted ~= numRequired then
+                detailOutput[detailOutputCount] = tmpOutput
+                detailOutputCount = detailOutputCount + 1
+            end
+        else
             detailOutput[detailOutputCount] = tmpOutput
             detailOutputCount = detailOutputCount + 1
         end

AchievementInfoLangStore.lua

@@ -35,6 +35,9 @@ LANG_STORE.EN.SettingsOption.AddOnEnabled = "AddOn enabled"
 LANG_STORE.EN.SettingsOption.AddOnEnabledTooltip = "Enable or disable this AddOn"
 LANG_STORE.EN.SettingsOption.AddOnEnabledWarning = "Only the output messages can be disabled here"
 
+LANG_STORE.EN.SettingsOption.AccountWideEnabled = "Use account-wide Settings"
+LANG_STORE.EN.SettingsOption.AccountWideEnabledTooltip = "Use and edit the same settings for all characters"
+
 LANG_STORE.EN.SettingsOption.ShowEveryUpdate = "Show every update"
 LANG_STORE.EN.SettingsOption.ShowEveryUpdateTooltip = "Shows a message on every status update of an achievement. Otherwise the messages appear only in steps of x%"
 
@@ -86,6 +89,9 @@ LANG_STORE.DE.SettingsOption.AddOnEnabled = "AddOn aktiviert"
 LANG_STORE.DE.SettingsOption.AddOnEnabledTooltip = "Aktiviere oder deaktiviere dieses AddOn"
 LANG_STORE.DE.SettingsOption.AddOnEnabledWarning = "An dieser Stelle können nur die Ausgaben deaktiviert werden."
 
+LANG_STORE.DE.SettingsOption.AccountWideEnabled = "Accountübergreifende Einstellungen"
+LANG_STORE.DE.SettingsOption.AccountWideEnabledTooltip = "Benutze und speichere die Einstellungen für alle Charaktere"
+
 LANG_STORE.DE.SettingsOption.ShowEveryUpdate = "Zeige alle Fortschritte"
 LANG_STORE.DE.SettingsOption.ShowEveryUpdateTooltip = "Zeigt bei jeder Aktualisierung eines Erfolgs einen Hinweis. Alternativ wird nur in x% Schritten ein Status ausgegeben"
 
@@ -138,6 +144,9 @@ LANG_STORE.FR.SettingsOption.AddOnEnabled = "Extension activée"
 LANG_STORE.FR.SettingsOption.AddOnEnabledTooltip = "Active ou désactive cette extension"
 LANG_STORE.FR.SettingsOption.AddOnEnabledWarning = "Seul les messages sortants peuvent être désactivés"
 
+LANG_STORE.FR.SettingsOption.AccountWideEnabled = LANG_STORE.EN.SettingsOption.AccountWideEnabled
+LANG_STORE.FR.SettingsOption.AccountWideEnabledTooltip = LANG_STORE.EN.SettingsOption.AccountWideEnabledTooltip
+
 LANG_STORE.FR.SettingsOption.ShowEveryUpdate = "Affichage de chaque mise à jour"
 LANG_STORE.FR.SettingsOption.ShowEveryUpdateTooltip = "Affiche un message pour chaque mise à jour d'un succès. Le reste du temps les messages n'apparaissent que sous forme de plage de x%"
 

AchievementInfoSettings.lua

@@ -5,6 +5,15 @@
 
 
 
+-- Function to determine if Account Wide Settings should be used
+function AchievementInfo.loadUseAccountWideSettings()
+    return ZO_SavedVars:New("ACHIEVEMENT_INFO_DB_USE_AW", 1, nil, {
+        enabled = false
+    })
+end
+
+
+
 -- Function to set and load the Saved Variables
 function AchievementInfo.loadSavedVars()
     local defaults = {
@@ -36,9 +45,14 @@ function AchievementInfo.loadSavedVars()
         cat20 = true,
         cat21 = true,
         cat22 = true,
+        -- ... new one default to true
         devDebug                = false
     }
 
+    if AchievementInfo.useAccountWideSettings["enabled"] == true then
+        return ZO_SavedVars:NewAccountWide("ACHIEVEMENT_INFO_DB", 1, nil, defaults)
+    end
+
     return ZO_SavedVars:New("ACHIEVEMENT_INFO_DB", 1, nil, defaults)
 end
 
@@ -49,16 +63,16 @@ function AchievementInfo.createSettingsPanel()
     local panelData = {
         type = "panel",
         name = AchievementInfo.name,
-        displayName = AchievementInfo.clrDefault..AchievementInfo.name,
+        displayName = AchievementInfo.clrDefault .. AchievementInfo.name,
         author = AchievementInfo.author,
-        version = string.format("%.1f", AchievementInfo.version),
+        version = string.format("%.2f", AchievementInfo.version),
         slashCommand = "/achievementInfo"
     }
 
     local optionsTable = {
         [1] = {
             type = "header",
-            name = AchievementInfo.clrSettingsHeader..LANG.SettingsHeader.General
+            name = AchievementInfo.clrSettingsHeader .. LANG.SettingsHeader.General
         },
         [2] = {
             type = "checkbox",
@@ -69,13 +83,21 @@ function AchievementInfo.createSettingsPanel()
             warning = LANG.SettingsOption.AddOnEnabledWarning
         },
         [3] = {
+            type = "checkbox",
+            name = LANG.SettingsOption.AccountWideEnabled,
+            tooltip = LANG.SettingsOption.AccountWideEnabledTooltip,
+            getFunc = function() return AchievementInfo.useAccountWideSettings["enabled"] end,
+            setFunc = function() AchievementInfo.toggleAccountWideSettings() end,
+            requiresReload = true
+        },
+        [4] = {
             type = "checkbox",
             name = LANG.SettingsOption.ShowEveryUpdate,
             tooltip = LANG.SettingsOption.ShowEveryUpdateTooltip,
             getFunc = function() return AchievementInfo.settingGet("genShowEveryUpdate") end,
             setFunc = function() AchievementInfo.settingToogle("genShowEveryUpdate") end
         },
-        [4] = {
+        [5] = {
             type = "slider",
             name = LANG.SettingsOption.ShowUpdateSteps,
             tooltip = LANG.SettingsOption.ShowUpdateStepsTooltip,
@@ -86,21 +108,21 @@ function AchievementInfo.createSettingsPanel()
             setFunc = function(value) AchievementInfo.settingSet("genShowUpdateSteps", value) end,
             default = 25
         },
-        [5] = {
+        [6] = {
             type = "checkbox",
             name = LANG.SettingsOption.ShowDetails,
             tooltip = LANG.SettingsOption.ShowDetailsTooltip,
             getFunc = function() return AchievementInfo.settingGet("genShowDetails") end,
             setFunc = function() AchievementInfo.settingToogle("genShowDetails") end
         },
-        [6] = {
+        [7] = {
             type = "checkbox",
             name = LANG.SettingsOption.ShowOpenDetailsOnly,
             tooltip = LANG.SettingsOption.ShowOpenDetailsOnlyTooltip,
             getFunc = function() return AchievementInfo.settingGet("genShowOpenDetailsOnly") end,
             setFunc = function() AchievementInfo.settingToogle("genShowOpenDetailsOnly") end
         },
-        [7] = {
+        [8] = {
             type = "checkbox",
             name = LANG.SettingsOption.OneElementPerLine,
             tooltip = LANG.SettingsOption.OneElementPerLineTooltip,
@@ -108,11 +130,11 @@ function AchievementInfo.createSettingsPanel()
             setFunc = function() AchievementInfo.settingToogle("genOnePerLine") end,
             warning = LANG.SettingsOption.OneElementPerLineWarning
         },
-        [8] = {
+        [9] = {
             type = "header",
             name = AchievementInfo.clrSettingsHeader .. LANG.SettingsHeader.Categories
         },
-        [9] = {
+        [10] = {
             type = "description",
             text = LANG.SettingsHeader.CategoriesDescription .. ":"
         }
@@ -128,8 +150,8 @@ function AchievementInfo.createSettingsPanel()
             type = "checkbox",
             name = catName,
             tooltip = LANG.SettingsOption.CategoryTooltip .. " '" .. catName .. "'",
-            getFunc = function() return AchievementInfo.settingGet("cat"..i) end,
-            setFunc = function() AchievementInfo.settingToogle("cat"..i) end
+            getFunc = function() return AchievementInfo.settingGetForCategory("cat" .. i) end,
+            setFunc = function() AchievementInfo.settingToogle("cat" .. i) end
         })
     end
 
@@ -149,8 +171,8 @@ function AchievementInfo.createSettingsPanel()
     })
 
     -- Register
-    LibAddonMenu2:RegisterAddonPanel(AchievementInfo.name.."SettingsPanel", panelData)
-    LibAddonMenu2:RegisterOptionControls(AchievementInfo.name.."SettingsPanel", optionsTable)
+    LibAddonMenu2:RegisterAddonPanel(AchievementInfo.name .. "SettingsPanel", panelData)
+    LibAddonMenu2:RegisterOptionControls(AchievementInfo.name .. "SettingsPanel", optionsTable)
 end
 
 
@@ -167,6 +189,18 @@ end
 
 
 
+-- Function to retrieve settings for categories (default true)
+function AchievementInfo.settingGetForCategory(id)
+    if AchievementInfo.savedVars[id] == nil then
+        AchievementInfo.savedVars[id] = true
+        return true
+    else
+        return AchievementInfo.savedVars[id]
+    end
+end
+
+
+
 -- Function to toggle Checkbox values
 function AchievementInfo.settingToogle(id)
     if AchievementInfo.savedVars[id] == false then
@@ -178,6 +212,17 @@ end
 
 
 
+-- Function to toggle Checkbox value for accountWideSettings
+function AchievementInfo.toggleAccountWideSettings()
+    if AchievementInfo.useAccountWideSettings["enabled"] == false then
+        AchievementInfo.useAccountWideSettings["enabled"] = true
+    else
+        AchievementInfo.useAccountWideSettings["enabled"] = false
+    end
+end
+
+
+
 -- Function to set settings
 function AchievementInfo.settingSet(id, value)
     AchievementInfo.savedVars[id] = value

CHANGELOG.md

@@ -1,5 +1,15 @@
 #### Notable Changes
 
+##### Release 4.5
+* Fixed "ShowDetails" option working only in combination with "ShowOpenDetailsOnly"
+
+##### Release 4.3
+* Fixed an error with gendered achievement descriptions
+
+##### Release 4.0
+* Added accountwide settings
+* Added an "use accountwide settings" option to the settings of each character
+
 ##### Release 3.0
 * Removed the bundled Dependency LibAddonMenu-2.0: You have to download it on your own now
 

README.md

@@ -2,11 +2,30 @@
 
 [![Build Status](https://drone.f-brinker.de/api/badges/fbrinker/elderscrolls-addon-achievementInfo/status.svg)](https://drone.f-brinker.de/fbrinker/elderscrolls-addon-achievementInfo)
 [![Latest Releases](https://badgen.net/badge/releases/latest)](https://git.f-brinker.de/fbrinker/elderscrolls-addon-achievementInfo/releases)
+[![Downloads](https://badgen.net/https/scripts.f-brinker.de/esoui-stats/badge-total.php?cache=1800)](https://www.esoui.com/downloads/info350-AchievementInfo.html)
+[![Favorites](https://badgen.net/https/scripts.f-brinker.de/esoui-stats/badge-fav.php?cache=1800)](https://www.esoui.com/downloads/info350-AchievementInfo.html)
 
-This is an **The Elderscrolls Online** addon. [See all details and the download @ESOUI](http://www.esoui.com/downloads/info350-AchievementInfo.html#info).
+This is a **The Elderscrolls Online** addon. [See all details and the download @ESOUI](http://www.esoui.com/downloads/info350-AchievementInfo.html#info).
 
 [Issue-Tracker](https://git.f-brinker.de/fbrinker/elderscrolls-addon-achievementInfo/issues)
 
+## Description
+
+### What is this AddOn about?
+
+I like achievements, and I like to know what to do to complete them and what type of achievements exist without browsing through the entire achievement catalog: This AddOn displays lightweight chat notifications if you make progress in an achievement (please see the screenshots).
+
+### Features
+
+* Shows chat notifications if you do something that is needed for an achievement
+* Triggers on each action or just in x% steps of the achievement's requirements (configurable)
+* Can show some details in the chat notification like (kill 250/1000 Humanoids)
+* You can toggle the notifications for each category
+* Lightweight: It is not always present and shows up only when necessary
+* You can enable account-wide settings
+
+![preview screenshot](screenshots/chat-1.jpg)
+
 ## Why is this a public project?
 
 In case I quit or pause playing TESO and cannot maintain this addon, feel free to contribute to keep this up to date and running.
@@ -14,9 +33,9 @@ I'll still be available here and be able to update the ESOUI page.
 
 ## How to contribute?
 
-**IMPORTANT: Github is a mirror.** Please contribute at [git.f-brinker.de/elderscrolls-addon-achievementInfo](https://git.f-brinker.de/fbrinker/elderscrolls-addon-achievementInfo) - You can login with your Github or Gitlab account (OAuth2).
+**IMPORTANT: Github is a mirror.** Please contribute at [git.f-brinker.de/elderscrolls-addon-achievementInfo](https://git.f-brinker.de/fbrinker/elderscrolls-addon-achievementInfo) - You can log in with your Github or Gitlab account (OAuth2).
 
-Then, create a fork of the repository, do what you have to do and create a pull-request afterwards. Feel free to contact me any time.
+Then, create a fork of the repository, do what you have to do, and create a pull-request afterward. Feel free to contact me any time.
 
 #### Linting
 Luacheck is used to check the LUA code. [Documentation](https://luacheck.readthedocs.io/en/stable/index.html)