New Api Version

.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.txt

@@ -5,7 +5,7 @@
 ## Author: |c87B7CCAsto|r, @Astarax
 ## Contact: mail@coded-with-heart.com
 
-## APIVersion: 100031
+## APIVersion: 101034
 ## 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

CHANGELOG.md

@@ -1,5 +1,11 @@
 #### 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

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)