Version 1.0.0

- added info section with contact and thanks
- fixed minor clarifications and spellings errors on help texts
master 1.0.0
Lothar Buchholz 4 years ago
parent 45099a9a3b
commit e53900d2b1

@ -3,6 +3,12 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## Version 1.0.0 - 2020-09-01 [First Release]
### Added
- info section with contact and thanks
### Fixed
- minor clarifications and spellings errors on help texts
## Version 0.9.1-rc - 2020-08-01 [Release Candidate]
### Fixed
- emote detection mixed in other channels

@ -1,9 +1,9 @@
## Interface: 11305
## Title: Grichelde
## Notes: Replaces characters from the chat box
## Notes-de: Ersetzt eingegebene Zeichen in der Chat-Zeile
## Version: 0.9.1-rc
## Notes: Replaces characters of your chat input line before sending.
## Notes-de: Ersetzt eingegebene Zeichen in der Chat-Zeile vor dem Versand.
## Version: 1.0.0
## Author: Teilzeit-Jedi
## eMail: tj@teilzeit-jedi.de

@ -39,6 +39,8 @@ Grichelde.COLOR_CODES = {
YELLOW = _G.YELLOW_FONT_COLOR_CODE or "|cffffff00",
LIGHTYELLOW = _G.LIGHTYELLOW_FONT_COLOR_CODE or "|cffffff9a",
ORANGE = _G.ORANGE_FONT_COLOR_CODE or "|cffff7f3f",
BLUE = "|cff0000ff",
HYPERLINK = "|cff4040ff",
CLOSE = _G.FONT_COLOR_CODE_CLOSE or "|r",
}
@ -373,6 +375,10 @@ local function cRed(text)
return Grichelde.F.color(Grichelde.COLOR_CODES.RED, text)
end
local function cHyperlink(text)
return Grichelde.F.color(Grichelde.COLOR_CODES.HYPERLINK, text)
end
-- faster function lookups by mapping to local refs
Grichelde.F = {
IsAddOnLoaded = _G.IsAddOnLoaded,
@ -421,6 +427,7 @@ Grichelde.F = {
cGreen = cGreen,
cOrange = cOrange,
cRed = cRed,
cHyperlink = cHyperlink,
toByte = _G.string.byte,
bytes2Char = _G.string.char,
format = _G.string.format,

@ -164,9 +164,23 @@ function Grichelde:CreateOptionsUI()
desc = self.L.Options_Help_Group_Desc,
disabled = false,
args = {
basics = {
info = {
order = 10,
type = "group",
name = self.L.Options_Help_Tab_Info_Name,
desc = self.L.Options_Help_Tab_Info_Desc,
args = {
paragraph1 = {
order = 1,
type = "description",
name = self:Format(self.L.Options_Help_Info, self.L.AddonName),
fontSize = "medium",
},
},
},
basics = {
order = 11,
type = "group",
name = self.L.Options_Help_Tab_Basics_Name,
desc = self.L.Options_Help_Tab_Basics_Desc,
args = {
@ -179,7 +193,7 @@ function Grichelde:CreateOptionsUI()
},
},
expert = {
order = 11,
order = 12,
type = "group",
name = self.L.Options_Help_Tab_Expert_Name,
desc = self.L.Options_Help_Tab_Expert_Desc,
@ -193,7 +207,7 @@ function Grichelde:CreateOptionsUI()
},
},
examples = {
order = 12,
order = 13,
type = "group",
name = self.L.Options_Help_Tab_Examples_Name,
desc = self.L.Options_Help_Tab_Examples_Desc,
@ -257,7 +271,7 @@ function Grichelde:CreateOptionsUI()
},
},
disclaimer = {
order = 20,
order = 14,
type = "description",
name = self.L.Options_Help_Disclaimer,
},

@ -1,10 +1,9 @@
# Grichelde - Text replacer
Grichelde is a WoW Classic Addon that replaces any characters or words you typed in a chatbox according to your replacement rules and text.
The replacement is done **before** the text is send to others/in the target channel. It does **not** change text others have written in the chat/channel,
but the text they will see **from you** when you sent it.
Grichelde is a WoW Classic Addon that replaces any characters or words you typed in a chat input line according to your replacement rules.
The replacement is done **before** the text is send to other players/in the target channel. It does **not** change text other players have written in the chat, but the text they will see **from you**.
Its purpose it to simulate a speaking disability of your toon and hereby strengthen immersion in roleplay.
Its purpose is to simulate a speaking disability of your toon and hereby strengthen immersion in roleplay.
Initially started as a helper addon for a roleplaying friend, Grichelde can be used for much more, like
* fixing your common spelling errors :)

@ -6,9 +6,10 @@ local Grichelde = _G.Grichelde
local L = LibStub('AceLocale-3.0'):NewLocale(AddonName, 'deDE')
if not L then return end
local cYellow = Grichelde.F.cYellow
local cGray = Grichelde.F.cGray
local cPrefix = Grichelde.F.cPrefix
local cYellow = Grichelde.F.cYellow
local cGray = Grichelde.F.cGray
local cHyperlink = Grichelde.F.cHyperlink
local cPrefix = Grichelde.F.cPrefix
-- system messages
L.AddonName = "Grichelde"
@ -137,6 +138,8 @@ L.Options_Help_Group_Desc = "Hilfstellungen zu den Suchmustern und zur Ersetzung
L.Options_Help_Disclaimer = cYellow("Haftungsausschlu\195\159:") .. " Das Addon wird im reinen Ist-Zustand zur Verf\195\188gung gestellt, ohne Garantie auf Funktion und Fehlerfreiheit (f\195\188r mehr Details siehe GPL 3 Lizenzdokument). "
.. "Ferner \195\188bernimmt der Autor keinerlei Haftung oder Gew\195\164hrleistung f\195\188r durch das Addon oder dessen Nutzung entstandene Fehler oder Sch\195\164den, "
.. "insb. den Verlust von Spielfortschritt oder Daten aufgrund von Abst\195\188rzen des WoW-Clients."
L.Options_Help_Tab_Info_Name = "Info"
L.Options_Help_Tab_Info_Desc = "\195\156ber dieses Addon."
L.Options_Help_Tab_Basics_Name = "Grundlagen"
L.Options_Help_Tab_Basics_Desc = "Erl\195\164utert die Grundlagen des Addons"
L.Options_Help_Tab_Expert_Name = "Experte"
@ -144,33 +147,42 @@ L.Options_Help_Tab_Expert_Desc = "Beleuchtet die Besonderheiten bei der Textsuch
L.Options_Help_Tab_Examples_Name = "Beispiele"
L.Options_Help_Tab_Examples_Desc = "Beispiele f\195\188r bestimmte Szenarien."
L.Options_Help_Info = cYellow("\195\156ber dieses Addon")
.. "|n%s ersetzt beliebige, selbstdefinierte Zeichenfolgen durch andere selbstdefinierte Zeichenfolgen, die ihr eingebt. Die Ersetzung findet vor dem Versenden an andere Spieler oder Kanäle statt. "
.. "Es \195\164ndert nicht den Text den andere Spieler im Chat geschrieben haben, nur eure eigenen Eingaben. Es soll den individuellen Sprachfehler eures Charakters simulieren und dadurch die Immersion erh\195\182hen."
.. "|n|nNat\195\188rlich kann man es auch f\195\188r andere Dinge zweckentfremden (Trollifizierer, Abk\195\188rzungen, Kosenamen, etc.). Eine ausf\195\188hrliche Beschreibung aller Optionen, der Funktionsweise und viele Beispiele befinden sich auf den nachfolgenden Reitern."
.. "|n|n" .. cYellow("Kontakt")
.. "|nBitte Fehler und Erfahrungsberichte direkt als Kommentar auf der Projektwebseite bei " .. cPrefix("CurseForge") .. " (" .. cHyperlink("https://www.curseforge.com/wow/addons/grichelde") .. ") einmelden. "
.. "Ihr k\195\182nnt auch gern Screenshots der Fehlermeldungen und eurer Zuweisungen anh\195\164ngen. Ein \195\156bersichtsfenster aller Mappings kann mit dem Kommando " .. cPrefix("\"/gri mappings\"") .. " aufgerufen und herauskopiert werden. "
.. "|nIch freue mich \195\188ber euere Erfahrungsberichte und Fehlerreports."
.. "|n|n" .. cYellow("Dank")
.. "|nMein Dank geht an meine lieben Beta-Tester " .. cPrefix("Chamera") .. ", " .. cPrefix("Tabenoca") .. " und " .. cPrefix("Nordraka") .. ", und besondereren Dank an " .. cPrefix("Shinue") .. " f\195\188r die Inspiration und lustigen Momente."
L.Options_Help_Basics = cYellow("Reihenfolge")
.. "|nEs sind unbegrenzt viele Textersetzung m\195\182glich, und sie werden in der Reihenfolge der definierten Zuordnungen abgearbeitet, von oben nach unten. "
.. "Ersetzungen sind transitiv, d.h. nachfolgende Zuordnungen beziehen sich nicht auf den Originaltext, sondern das Resultat der vorherigen Ersetzung. "
.. "|nMit der Zuordnung " .. cPrefix("\"a\" => \"b\"") .. " und " .. cPrefix("\"b\" => \"c\"") .. " wird bei Eingabe von " .. cPrefix("\"a\" => \"c\"") .. "."
.. "|n|n" .. cYellow("Exakte Gro\195\159- und Kleinschreibung")
.. "|nBei exakter Gro\195\159- und Kleinschreibung muss die Schreibweise genau \195\188berstimmen, sonst findet keine Textersetzug f\195\188r diese Zuordnung statt. "
.. "|nBei exakter Gro\195\159- und Kleinschreibung muss die Schreibweise genau \195\188berstimmen, sonst wird diese Zuordnung \195\188bersprungen. "
.. "Wird die Gro\195\159- und Kleinschreibung ignoriert, wird die Gro\195\159schreibung jedes Zeichens bei der Ersetzung \195\188bernommen. "
.. "|nMit der Zuordnung " .. cPrefix("\"aBcDeF\" => \"uvWXYz\"") .. " wird aus " .. cPrefix("\"abcdef\" => \"uvwxyz\"") .. ", "
.."aus " .. cPrefix("\"ABCDEF\" => \"UVWXYZ\"") .. " und aus " .. cPrefix("\"AbCdEf\" => \"UvWxYz\"") .. "."
.. "|n|n" .. cYellow("Zusammenfassen aufeinanderfolgender Treffer")
.. "|nDas Zusammenfassen aufeinanderfolgender Treffer vermeidet unsch\195\182ne Wiederholungen, die durch die Ersetzung entstehen k\195\182nnen. "
.. "Die Zusammenfassung wird erst nach der Ersetzung vorgenommen, d.h. am vollst\195\164ndig ersetzten Text f\195\188r jede Zuordnung. "
.. "Die Zusammenfassung wird erst nach der Ersetzung vorgenommen, d.h. am vollst\195\164ndig ersetzten Text f\195\188r alle Zuordnungen. "
.. "|nMit der Zuordnung " .. cPrefix("\"s\" => \"sch\"") .. " wird aus " .. cPrefix("\"Tasse\" => \"Tasche\"") .. " statt " .. cPrefix("\"Taschsche\"") .. ", "
.. "aber " .. cPrefix("\"schmeissen\" => \"schchmeichen\"") .. ". Solche Randbedingungen beseitigt in der Regel eine weitere Zuordnung wie " .. cPrefix("\"schch\" => \"sch\"") .. "."
.. "aber aus " .. cPrefix("\"schmeissen\" => \"schchmeischen\"") .. ". Solche Randbedingungen beseitigt in der Regel eine weitere Zuordnung: " .. cPrefix("\"schch\" => \"sch\"") .. "."
.. "|n|n" .. cYellow("Anhalten nach Treffer")
.. "|nEs werden keine weiteren Ersetzungen mehr vorgenommen, wenn die aktuelle Zuordnung zutreffend ist. Alle nachfolgenden Zuordnungen werden dann \195\188bersprungen. "
.. "Wenn kein Treffer vorliegt, werden die restlichen Zuordnung ganz normal weiter abgearbeitet."
.. "|nAlle nachfolgenden Ersetzungen mehr \195\188bersprungen, wenn die aktuelle Zuordnung zutreffend ist. Wenn bei der aktuelle Zuordnung kein Treffer vorliegt, werden die restlichen Zuordnung ganz normal weiter abgearbeitet."
L.Options_Help_Expert = cYellow("verk\195\188rzende/verl\195\163ngernde Ersetzungen")
.. "|nIst der Ersetzungstext k\195\188rzer als der eigentliche Suchtext, werden die \195\188bersch\195\188\195\159igen Zeichen des Suchtreffers entfernt. "
.. "Ist der Ersetzungstext l\195\163nger, werden die \195\188brigen Zeichen nach dem Treffer hinten drangehangen. Dabei wird die Gro\195\159- und Kleinschreibung des letzten Zeichens ber\195\188cksichtigt, "
.. "ebenso wie die Gro\195\159- und Kleinschreibung des nachfolgenden Zeichens. Gro\195\159geschriebene Abk\195\188rzungen und Ausdr\195\188cke bleiben so einheitlich. "
.. "|nMit der Zuordnung " .. cPrefix("\"Kr\195\164uter\" => \"Gr\195\188nzeugs\"") .. " wird aus " .. cPrefix("\"KR\195\132UTER\" => \"GR\195\156NZEUGS\"") .. " statt " .. cPrefix("\"GR\195\156NZEUgs\"") .. " "
.. "unter Beibehaltung von absichtlicher Gro\195\159schreibung wie " .. cPrefix("\"Kr\195\132utERGarten\" => \"Gr195\156nzEUGSgarten\"") .. " statt " .. cPrefix("\"Gr\195\188nzeugsGarten\"") .. "."
.. "unter Beibehaltung von absichtlicher Gro\195\159schreibung wie " .. cPrefix("\"Kr\195\132utERGarten\" => \"Gr\195\156nzEUGSgarten\"") .. " statt " .. cPrefix("\"Gr\195\188nzeugsGarten\"") .. "."
.. "|n|n" .. cYellow("Standby")
.. "|nErsetzungen k\195\182nnen auch nur bei Bedarf durchgef\195\188hrt werden, selbst wenn das Addon oder ein Kanal deaktivert wurde. "
.. "Vor der Eingabe in der Chatbox schreibt man " .. cPrefix("/gri").. " oder " .. cPrefix("/grichelde").. " und optional noch den Zielkanal "
.. "z.B. " .. cPrefix("\"/gri /g hallo leute\"") .. " und alle aktiven Zuordnungen werden ersetzt, selbst wenn der Gildenkanal oder das Addon nicht aktiv sind."
.. "z.B. " .. cPrefix("\"/gri /g Hallo Leute\"") .. " und alle aktiven Zuordnungen werden ersetzt, selbst wenn der Gildenkanal oder das Addon nicht aktiv sind."
.. "|n|n" .. cYellow("Regul\195\164re Ausdr\195\188cke")
.. "|nRegEx sind sehr m\195\163chtige Such- und Ersetzunsgmuster die h\195\163ufig in der Programmierung verwendet werden. Generell werden RegEx in den Suchtexten \195\188bernommen, "
.. "aber Lua unterst\195\188tzt nicht den vollst\195\163ndigen Umfang von PCRE. Trotzdem funktionieren viele Muster wie Anker bei Zeilenanfang " .. cPrefix("\"^\"") .. " oder Zeilenende " .. cPrefix("\"$\"")

@ -6,9 +6,10 @@ local Grichelde = _G.Grichelde
local L = LibStub('AceLocale-3.0'):NewLocale(AddonName, 'enUS', true)
if not L then return end
local cYellow = Grichelde.F.cYellow
local cGray = Grichelde.F.cGray
local cPrefix = Grichelde.F.cPrefix
local cYellow = Grichelde.F.cYellow
local cGray = Grichelde.F.cGray
local cHyperlink = Grichelde.F.cHyperlink
local cPrefix = Grichelde.F.cPrefix
-- system messages
L.AddonName = "Grichelde"
@ -137,6 +138,8 @@ L.Options_Help_Group_Desc = "Guideance to search patterns and replacement logic.
L.Options_Help_Disclaimer = cYellow("Disclaimer of warranty:") .. " The addon is provided \"AS IS\" and comes without warranty of any kind of function or correctness (for more details, consult the GPL 3 license). "
.."Also the author is not held responsible for any risk or damage the addon or its use might cause, especially lost of progress or data due to crashes of the WoW client."
L.Options_Help_Tab_Info_Name = "Info"
L.Options_Help_Tab_Info_Desc = "About this addon."
L.Options_Help_Tab_Basics_Name = "Basics"
L.Options_Help_Tab_Basics_Desc = "Some explanatory notes the the basic behaviour."
L.Options_Help_Tab_Expert_Name = "Expert"
@ -144,6 +147,16 @@ L.Options_Help_Tab_Expert_Desc = "More details on special search options."
L.Options_Help_Tab_Examples_Name = "Examples"
L.Options_Help_Tab_Examples_Desc = "Templates for particular scenarios."
L.Options_Help_Info = cYellow("About this addon")
.. "|n%s replaces any characters or words you typed in a chatbox according to your replacement rules and text. The replacement is done before the text is send to other players/in the target channel. "
.. "It does not change text other players have written in the chat, but the text they will see from you. Its purpose is to simulate a speaking disability of your toon and to strengthen immersion in roleplay."
.. "|n|nOf course it can be used for many other things, too (trollifier, abbreviations, nick names, etc.). A extensive description of all options, the general replacement workflow and a lot of examples can be found on the next tabs."
.. "|n|n" .. cYellow("Contact")
.. "|nPlease report errors and your experiences directly as a comment on the project website at " .. cPrefix("CurseForge") .. " (" .. cHyperlink("https://www.curseforge.com/wow/addons/grichelde") .. "). "
.. "You are encouraged to attach screenshots of error messages and your mappings. An overview of all your mappings is shnown by using the command " .. cPrefix("\"/gri mappings\"") .. " and copy it out. "
.. "|nI'm looking forward for your feedback and reports."
.. "|n|n" .. cYellow("Thanks")
.. "|Many thanks to my beta testers " .. cPrefix("Chamera") .. ", " .. cPrefix("Tabenoca") .. " and " .. cPrefix("Nordraka") .. ", and very special thanks to " .. cPrefix("Shinue") .. " for the inspiration and hilarious moments."
L.Options_Help_Basics = cYellow("Ordering")
.. "|nYou can have an unlimited number of replacements. All mappings will be processed in same order as defined, from top down. "
.. "Replacements are also transitive, so consecutive mappings do not work on the original input but the resulting text from the previous replacements. "
@ -159,7 +172,7 @@ L.Options_Help_Basics = cYellow("Ordering")
.. "|nWith mapping " .. cPrefix("\"s\" => \"sh\"") .. " text becomes " .. cPrefix("\"tossing\" => \"toshing\"") .. " instead of " .. cPrefix("\"toshshing\"") .. ", yet still " .. cPrefix("\"paths\" => \"pathsh\"") .. ". "
.. "Such edge cases can usually be mitigated with an additional mapping at the end: " .. cPrefix("\"thsh\" => \"thz\"") .. "."
.. "|n|n" .. cYellow("stop on match")
.. "|nNo other replacements are done, when the current mapping matched. This will skip any other consecutive mappings when hit. When no match ocurred, the remaining mappings are processed as usual."
.. "|nAll other consecutive replacements are skipped, when the current mapping matched. When the current mapping does not match, the remaining mappings are processed as usual."
L.Options_Help_Expert = cYellow("shortening/lengthening replacements")
.. "|nIf the replacement is shorter than the actual match, all remaining characters will be skipped. If the replacement is longer, all remaining characters will be appended. "
.. "The case of the replaced character is considered as well as the case of the next character in the original text. That way capital case abbreviations and expressions will not be distorted. "

@ -0,0 +1,17 @@
https://wow.gamepedia.com/Localizing_an_addon
https://wow.gamepedia.com/Pattern_matching
https://wow.gamepedia.com/Lua_functions#String_Functions
https://wow.gamepedia.com/API_SetRaidTarget
https://www.wowace.com/projects/ace3/pages/ace-db-3-0-tutorial
https://www.wowace.com/projects/ace3/pages/api/ace-db-3-0
https://wowwiki.fandom.com/wiki/Events_A-Z_(full_list)
Liebe RP-Gemeinde, ich benötige eure Mithilfe beim Test meines ersten WoW-Addons. :handshake:
Es heißt "Grichelde" und ersetzt beliebige, selbstdefinierte Zeichenfolgen durch andere selbstdefinierte Zeichenfolgen, die ihr eingebt. Es ändert nicht den Text den andere im Chat geschrieben haben, nur eure eigenen Eingaben. Die Idee wurde nach mehreren lustigen RP-Sitzungen mit einer Untoten ohne Unterkiefer geboren, deren Spielerin den Sprachfehler immer mühsam per Hand eintippen musste. Es soll den individuellen Sprachfehler eures Charakters simulieren und dadurch die Immersion erhöhen. Auf der Webseite findet ihr ein paar Screenshots, die euch die Funktion einfach verbildlichen sollten: https://www.curseforge.com/wow/addons/grichelde/screenshots
Natürlich kann man es auch für andere Dinge zweckentfremden (Trollifizierer :dragon_face: , Abkürzungen, Kosenamen, etc.). Es gibt ein nettes UI zum Konfigurieren der Ersetzungen und der aktiven Kanäle und auch eine großzügige Hilfesektion mit vielen Beispielen. Die Suchtreffer können auf ganze Wörter oder am Anfang, der Mitte und/oder am Ende eines Wortes eingeschränkt werden. Für die Profis gibt es sogar Unterstützung für reguläre Ausdrücke :sunglasses:, das ermöglicht auch schwierigere Ersetzungen mit Wiederholungen, wie Stottern. Für Rollenspieler gibts auch eine eigene Emote- und OOC-Erkennung.
Installieren kann man es über Twitch, dort muss aktuell noch die Suche und Installation von Beta-Versionen aktiviert sein, oder manuell über diesen Link runterladen und in den WoW\Interface\Addons Ordner kopieren: https://www.curseforge.com/wow/addons/grichelde
Bitte Fehler auf der Projektwebseite bei CurseForge einmelden, damit wir den Discord nicht zweckentfremden. Ich freue mich über euere Erfahrungsberichte und Fehlerreports.
Loading…
Cancel
Save