adrianocastro189 / memory

A World of Warcraft addon to register memories while players do stuff around the world.
GNU General Public License v3.0
2 stars 0 forks source link

Memory

A World of Warcraft addon to register memories while players do stuff around the world.

Installation

No setup is required! Just install the addon and play the game! While you play, it will record memories about players you party with, items you loot, zones and subzones you visit and NPCs you fight, talk, turn quests, buy, sell and repair.

Feel free to increase the print chance rate using a slash command described below or just have fun with the game and let the addon decide when it's the best time to bring a memory to you!

❤️ Support this project

If you like this addon and want to support its development, you can buy the author a coffee.

Every contribution or subscription is deeply appreciated and also supports the Stormwind Library project, which is the framework used to build this addon.

Slash commands

The following slash commands let you customize the addon experience.

Associating memories with moments

Moments can be anything happening while you play. They can refer to a moment in real life you're having while you play or even related to your current gameplay story. The current moment will be shared accross all your characters in this first version of this feature. In other words, you can't set a current moment for each character (yet).

Example: Let's say you're moving to another city in real life and you want to associate all of your player memories with this moment, then all you have to do is:

/memoryaddon addm "playing in a motel while my apartment is ready for us to move"

That way, after you add another moment, all the memories collected in the last moments will be appended to the chat frame like: The first time I looted a Linen Cloth was 41 days ago \~playing in a motel while my apartment is ready for us to move\~.

Make sure to wrap the moment in "" or '' so it can be recognized as a single phrase instead of multiple words.

To print the current moment, simply run:

/memoryaddon getm

Setting the memory print chance

Every time a memory is stored, it has a chance to be printed to the chat window. In other words, this is the chance your character will remember something!

The following command changes the print chance to 50% (0.5). Replace this number with any decimal between 0 - to turn off memory printing - and 1 (inclusive) to print every memory.

/memoryaddon set memory.printChance 0.5

Setting up the memory screenshot chance

Memory screenshots are disable by default and are part of the addon's 1.2.0 release. You can enable the screenshot chance with a setting called memory.screenshotChance which accepts any decimal between 0 - to turn off memory screenshots - and 1 (inclusive) to take screenshots for every memory.

It's advised to use a small chance like 0.025 to avoid taking multiple screenshots in a row and also to save some space given that every screenshot is stored as a new file under your World of Warcraft installation folder.

/memoryaddon set memory.screenshotChance 0.025

Disabling memories in tooltips

The memory.showInTooltips setting is responsible for enabling or disabling the display of memories in unit and item tooltips. By default, it is enabled, but you can disable it by running the following command:

/memoryaddon set memory.showInTooltips 0

To enable it again, run the same command, but with 1 instead of 0.

Disabling screenshots when earning achievements

Version 1.6.0 introduced a new feature that takes a screenshot when players earn achievements which is enabled by default. You can disable it by running the following command:

/memoryaddon set memory.screenshotOnAchievement 0

To enable it again, run the same command, but with 1 instead of 0.

Disabling screenshots when leveling up

Version 1.4.0 introduced a new feature that takes a screenshot when players level up which is enabled by default. You can disable it by running the following command:

/memoryaddon set memory.screenshotOnLevelUp 0

To enable it again, run the same command, but with 1 instead of 0.

What's on the roadmap for the next versions

Known issues

Changelog

2024.08.23 - version 1.6.0

2024.08.01 - version 1.5.0

2024.07.24 - version 1.4.2

2024.07.11 - version 1.4.1

2024.06.14 - version 1.4.0

2024.05.07 - version 1.3.1

2024.05.04 - version 1.3.0

2024.04.03 - version 1.2.4

2024.02.24 - version 1.2.3

2024.02.04 - version 1.2.2

2024.02.04 - version 1.2.1

2021.06.13 - version 1.2.0

2021.05.16 - version 1.1.1

2021.03.20 - version 1.1.0

2021.01.10 - version 1.0.0

2020.12.12 - version 0.6.0-beta

2020.11.25 - version 0.5.0-beta

2020.11.20 - version 0.4.0-alpha

2020.10.23 - version 0.3.0-alpha

2020.10.18 - version 0.2.0-alpha

2020.10.15 - version 0.1.0-alpha

Known issues