Mnemosyne

On WoW Forever every character has a first and a last name, and most playerspick a word play or a role-play name instead of the nickname their friends knowthem by. Mnemosyne, named after the Greek goddess of memory, puts the nicknameback: when you hover a character or read its chat line, you see who plays it.

Status: 1.0.0. Everything version 1 set out to do: registering,recognition on tooltips and in chat, sharing first-hand and second-hand, andevery language WoW Forever has. Nameplates and unit frames come later; theplan is in docs/decisions/ and the words inCONTEXT.md.

Contents

• How it works
• Installing
• Using it
• Privacy
• Reporting a problem
• More documentation

How it works

The first time you log in on a character, Mnemosyne asks who plays it, a fewseconds after you enter the world, never in combat, during a loading screen orin an instance. You can register it with your nickname, keep it anonymous, orask to be asked again at your next login on it. The nickname is filled in fromyour other registered characters, or else from what other players say about thisone, and nothing is registered until you click Register. Only a character's ownplayer can register it, and an anonymous character is never linked to yourother characters. Trial accounts are not asked: they cannot send addonmessages.

There is no server. Copies of Mnemosyne talk to each other in the backgroundwith the game's addon messages, over your guild and group channels and bywhisper. By default Mnemosyne talks only with your friends (your friend list andyour Battle.net friends' characters) and your guild: it ignores everyone elseand sends nothing on your group's channel. Turn Talk with everyone on in thesettings panel to open it to your groups and to anyone you hover or target.You learn your guildmates' nicknames when you log in, your group's whenyou join it (with Talk with everyone on), and a friend's or a stranger'swhen you hover them. Other players also pass alongwhat they learned before you, second-hand: two copies of Mnemosyne sync theirmemories privately by whisper, in the background, at login with the first fewplayers who answer, with each new group member who has Mnemosyne, and when youtype /mnemosyne sync, at most once every 6 hours with the same player. When async brings you a nickname that is new to you or newer, or an unregistration,Mnemosyne posts it to your guild once, after a few seconds, unless a guildmateposted it first, so the whole guild learns it at once.

Anyone can pass along something false, so a nickname heard from the characteritself always wins and shows plainly, Hugh Jass (Tony). One heard second-handshows in grey, Hugh Jass (~Tony), with the name of the player who passed it onin its tooltip. When players pass along different nicknames for the samecharacter, it shows none until the character says who plays it. When acharacter is deleted or renamed and another one takes its name, Mnemosynenotices the new character in chat or in your group and stops showing the oldnickname until the new character says who plays it. You keep atmost 20,000 second-hand nicknames, and take at most 1,000 changes a day (newnicknames, newer ones, removed ones and disputed ones) from any one player,plus up to 5,000 that player says it heard from the characters themselves inthe last day; a sync passes on at most as much, those first-hand changes first,the rest in later syncs.

Nicknames show on tooltips and in chat (the Show on tooltips and Show inchat switches turn each off): every chat type except emotes (channels andCommunities included), in the Communities window too, and when you hover a namein a chat line. Your own registered characters show their nickname there too.Nameplates and unit frames come later.

Installing

Mnemosyne is for WoW Forever only (client 1.60.1). Install it with:

• WoWUp: search for Mnemosyne (it comes fromWago), or add it from its GitHubURL, https://github.com/Llyth/mnemosyne.
• CurseForge app: search for Mnemosyne under WoW Forever, or open itsCurseForge page.
• By hand: download the zip from thelatest release andunzip it into World of Warcraft\_forever_\Interface\AddOns\, so that you getAddOns\Mnemosyne\Mnemosyne.toc.

Mnemosyne speaks every language WoW Forever has: English, French, German,Spanish (Spain and Latin America), Brazilian Portuguese, Russian, Korean andChinese (simplified and traditional). It follows your game client's language,using the game's own words for guilds, groups, chat and the rest, and falls backto English for anything not translated. The slash commands staythe same in every language (/mnemosyne register, /mnemosyne lookup...).

Using it

The settings panel is in Options, AddOns, Mnemosyne; the addon drawer next tothe minimap and /mnemosyne alone open it too. It has:

• This character: its registration, the nickname to register or change,Unregister and Keep anonymous, working like the commands and the first-loginquestion. A trial account sees why it cannot register.
• Options, the switches: Show on tooltips, Show in chat, Showsecond-hand, Pass on what I know, Ask strangers and Offer a reportafter an error, on until you turn them off, and Talk with everyone, offuntil you turn it on (see Privacy). Each is saved for all your characters and applies atonce.
• Status: what /mnemosyne status says, and a Report a bug button thatopens the same window as /mnemosyne report.
• Identities: the characters you know, searched by name or nickname,ignoring case and accents, each with its nickname, whether you heard itfirst-hand or from whom, and when; disputed ones are listed as disputed. Forgetdrops one (as /mnemosyne forget does) and Undo takes the forgetting back.Second-hand ones are listed only while Show second-hand is on, and thefirst 50 found show. Your own registered and anonymous characters come first,marked as yours.

Privacy

Mnemosyne keeps everything on your computer, in the game's saved variables, andsends nothing outside the game.

When you hover or target a character Mnemosyne doesn't know, it whispers thatcharacter an ask, invisible in chat, at most once a day per character: only afriend or a guildmate, unless Talk with everyone is on. Turn Askstrangers off in the settings panel to stop it.

Syncs and guild posts pass along every nickname you know, second-hand. Twoswitches of the settings panel, both on by default, change that: Pass on whatI know, off to share only your own registrations, and Show second-hand, offto see only what characters said about themselves. When a player with a newer Mnemosyne talksto yours, it tells you once a session that a newer version exists.

When you register a character, its nickname spreads to every player who hasMnemosyne, through other players too. Characters you don't register are nevershared: an anonymous character only tells other players who have Mnemosyne thatit is anonymous, so they forget any nickname they held for it. Unregisteringspreads the same way, but more slowly than the nickname did.

Forgetting a character (/mnemosyne forget) removes it from your own memoryand keeps what other players pass on about it out until you undo it, on all yourcharacters, without telling anyone. Your syncs stop passing it on too. Ifthe character itself tells you who plays it, that still counts, and is passed onlike anything you heard first-hand.

Reporting a problem

Type /mnemosyne report in the game, or click Report a bug in the settingspanel's Status. Either opens a window with a link to copy (Ctrl+C) and open inyour browser: a bug reportalready filled in with the debug report, where you only add what you did. If thelink does not open, copy the full report from the same window and paste it in theform. When Mnemosyne hits one of its own errors, it offers the same report onceper session, until you click Don't ask again (the Offer a report after anerror switch turns it back on). Nothing is sent by itself.

The report holds the Mnemosyne version, the game's build and locale, yoursettings, how many identities and characters you have, the last errors and thelast 200 messages sent, received or dropped (kept across a /reload). It neverholds a nickname or a message's text, and it replaces other players' names withshort codes. For asecurity problem, follow SECURITY.md instead.

More documentation

• CONTEXT.md: the project's words
• docs/decisions/: the design decisions and why
• CONTRIBUTING.md: development, tests, releases andrepository protection
• SECURITY.md: how to report a vulnerability
• LICENSE: all rights reserved; you may read the code and installthe addon, not reuse it