SpeakinSpell
Funny and/or Useful, SpeakinSpell will use random speeches in chat to announce when you use spells and other abilities, as well as items, procced effects, other events, and user-defined macros. Works with all classes. Configurable for many different situations.
Possible Uses
- Entertain yourself, your guild, and your PuGs
- Roleplay
- Tell your raid that you got an important debuff
- Tell your arena team that you're CC'd
- Whisper your target about a short term buff
- Congratulate your guild members on achievements
- Randomize your battle cries
- More
Main Features
- Can detect over 5000 "Events" and automatically announce them in the chat using a random selection from a list of user-defined speeches, including:
- Spells you cast
- All other abilities for any class (a warrior's Heroic Strike is also technically considered a "spell")
- Anything you can equip in your action bar
- Items
- Procced effects (buffs that you receive from yourself)
- Combat events (enter/exit combat, scored a crit, killing blow, etc)
- Talking to NPCs and other game objects like mailboxes
- Achievements
- Other events (Login, Changed Zone, etc)
- whenever you type "/ss macro something" (create your own event)
- Records more event hooks as it discovers more spells, buffs, and debuffs, etc the longer you use it.
- Each spells' random speeches can be directed to any chat channel you choose
- Supports different channel options (or silent) in different scenarios: solo, party, party leader, raid, raid leader, raid officer, BG, arena, and Wintergrasp.
- Also supports built-in emotes and most other slash commands (/cheer, /script, etc)
- Fully configurable through the interface options panel. (type "/ss" to get started)
- Includes some default example speeches for at least a few spells for all classes.
- These are only meant to serve as examples. In general, very few default speeches are available for most classes, so you may not see it do anything for you right away. You should look at the list of possible event hooks under "/ss create" and write your own speeches.
F.A.Q.
How do I make a backup copy of my SpeakinSpell data?
I recommend making a backup of your SpeakinSpell data frequently. All of your speeches for all characters are stored here: C:\Users\Public\Games\World of Warcraft\WTF\Account\<your name>\SavedVariables\SpeakinSpell.lua
How do I erase all the defaults and start from a clean slate?
Type "/ss eraseall" to erase all your data. This includes any defaults as well as any custom speeches you've written.
How do I find the spell or other event that I want to change in this huge list?
Cast the spell, or trigger the event, then type "/ss recent" then use the click-able links in your chat frame to [Edit Speeches] or [Setup New Event].
How do I stop it from announcing this spell or other event?
Cast the spell, or trigger the event, then type "/ss recent" then use the click-able links in your chat frame to [Edit Speeches] for that event... then click the button that says "Delete this event"
OMG this is so complicated!
Hey! That's not a question! It's a common complaint though, and I'm open to specific suggestions about what you find is too complicated, or confusing, or could be made easier, more intuitive, or more user-friendly. With great power comes great complexity. Everything is labeled with detailed tooltips, and there's a detailed user manual built-in (/ss help) and online to help you out. I also usually answer questions within 24 hours.
Aetharan has also written some nice guides here: http://tinyurl.com/a64sst4
Usage Instructions
How to setup SpeakinSpell in a few easy steps:
- Login and play your toon for a few minutes.
- Activate any abilities, trigger any procced effects, and encounter any other detectable events that you would like SpeakinSpell to announce.
- Type "/ss" to access the interface options panel
- Click on "Create New..." or type "/ss create" to create settings for a new spell or other event
- Select the desired spell or event from the list and click the Create button. You will be taken to the settings page for that spell or event.
- Change the settings to your tastes and write as many speeches as you want. Now whenever you cast that spell or encounter that event, SpeakinSpell will say one of your random messages for that event, using the channels and other rules that you defined.
- Repeat until you run out of ideas for new announcements to write.
Spammy Setup Guides Method
- Type "/ss guides" to enable Setup Guides (there's also a checkbox for it under "/ss options")
- Do stuff with your toon
- Observe that the spammy Setup Guides are reporting all 5k+ of every event that SpeakinSpell detects and could possibly announce
- Click on the clickable links in your chat frame to [Setup New Event] announcements (equivalent to using "/ss create") or [Edit Speeches] for event hooks you already configured (equivalent to using "/ss messages")
- Type "/ss guides" again to turn the Setup Guides back off
- At any time you wish you had the Setup Guides enabled to catch a special proc effect or something, type "/ss recent" to see Setup Guides for the last 5 events detected, and last 5 events announced.
Type "/ss help" for the in-game user's manual for complete, thorough instructions for how to make the most of every feature SpeakinSpell has to offer. It's designed for maximum flexibility.
Additional Features
- Supports over 50 substitutions in your speeches, such as <caster>, <target>, <zone>, <spellname>, <party2pettarget> and many more.
- <spelllink> will create a clickable link to the spell or achievement (for applicable events)
- All of these substitutions also support first person pronoun forms (to say "me" instead of my own name), gender forms, and possessive forms, to make your automated macros sound less like macros and more like natural speech
- Also includes random substitutions like <randomfaction> (like Mad Libs™) and you can create your own random substitution word lists.
- Up to 100 speeches can be entered per spell.
- Never says the same message for a given spell twice in a row (unless you only have 1 message defined for that spell)
- Can be configured to limit your chat spam in several ways
- based on a cooldown between automated speeches in chat
- based on a random chance to speak or not
- optionally limited to once per combat
- optionally limited to once per target name
- based on a global cooldown
- Can whisper messages to the target of your spell (This can be useful for resurrect style spells, innervate, power infusion, etc.)
- When you get compliments on your "macros" use "/ss ad" to tell your friends about SpeakinSpell. Some of the random ads are funny. Yes, it's an addon that spams random text in chat, and it has a feature to spam random text to advertise it's ability to spam random text. "/ss help" in game for more advanced options for using /ss ad.
- Detection of "other events" such as Login, entering combat, changed zone, and more. Type "/ss help" in game for the complete list.
- Custom Defined User Macros. Type "/ss macro something" to make SpeakinSpell detect a pseudo spell event called "When I type: /ss macro something" which you can setup to be announced with random speeches like a spell. This can be used for randomized battlecries (/ss macro battlecry), greetings (/ss macro hi), farewells (/ss macro bye), or anything you want to define (/ss macro _blank_).
- Share your speeches with your friends through the Data Sharing system
- type "/ss import" to browse the shared content you collected from others and add it to your settings (works for copying from your alts too)
- type "/ss network" for options
- type "/ss help" for help.
- Easter Egg ... there's a mildly amusing little story hidden away somewhere in an obvious place where you will never look for it ... yes, I do actually have a lot of time on my hands ...
More Information
SpeakinSpell has many more features than those listed above.
Click here for the Complete User's Manual, or type "/ss help" in-game for the same info. NOTE: If "/ss help" doesn't work, you may have an installation error, or you may have too many addons installed. Try right-clicking the minimap button, or hitting: Escape > Interface > Addons > SpeakinSpell.
Please submit a ticket for any problems, bug reports, or feature requests, or feel free to post in the comments below (but tickets are easier for me to remember to fix).
Submissions Welcome. To submit content including the witty random speeches you wrote, please read this. If you are a translator with better translations, please use this localization tool.
More Technical Information: If you're a programmer interested in understanding more about how SpeakinSpell works, read the SDD.doc in the SpeakinSpell addon folder. It's a software design document in the (compatible) MS Word 97 file format with details about the system architecture.
Aetharan's Tutorials for advanced tips and tricks: http://tinyurl.com/4ptc2xg
Petit tutoriel en Français http://abz.progp.net/wow/Tutoriel_SpeakinSpell.pdf
en Français a Youtube http://www.youtube.com/watch?v=f62eE6rzAFA
The official SpeakinSpell Forum http://www.rismisner.com/forum/viewforum.php?f=3 - Unfortunately, the SpeakinSpell forum is currently disabled because it received an excessive amount of spam advertisements (about 80 per day and only about 1 real post per month for 2 months). I will need help or time to learn how to adequately block advertisers before re-opening it.
Credits
SpeakinSpell was created by...
- Stonarius of Antonidas
Additional coding by...
- Duerma
Primary Beta Testing, Arena Team Pwnage, Key Grip...
- Meneldill
Translators...
- German: leXin (inactive)
- Korean: troth75 (inactive)
- French: contrebasse, An_Braz
Many of the default speeches were blatantly stolen from...
- Cryolysis2
- Necrosis
- LunarSphere
- Ultimate Warcraft Battlecry Generator
- RPHelper2
Thanks for the open license guys! I hope you like what I did with it.
Additional Content Packs Written by...
- Stonarius
- Meneldill
- leXin
- troth75
- Folji
- Dire Lemming
- Duerma
Special thanks to the authors of these addons that I used for copy-paste... *Ahem* I mean example code...
- Titan
- Omen
- Recount
- Healbot
- Mountiful
- WinterTime
- the WowAce libs
- RPHelper2
Additional thanks to...
- Blizzard Entertainment for this great game! ... hire me??
- The community on the wowace forums
- curse.com
- Microsoft Visual Studio, SubVersioN, and TortoiseSVN
- Texas Instruments for enabling E.T. to phone home
- The Order of the Stick
- Mom and Dad
- YOU!!
SpeakinSpell is made from 83% Recycled Materials.
No animals were harmed in the making of this addon.
... Well, the hunter popped a sheep with his aoe, but I resheeped with my /cast [target=focus] macro, and automatically said "Baaah! sheeped again <target>?!" and it was all good...
OK, I'm still getting an error on loading the mod, but at least now I can open the window for it. Preliminary testing has shown no other issues thus far.
Date: 2014-12-10 20:12:38
ID: 1
Error occured in: Global
Count: 1
Message: ..\AddOns\SpeakinSpell\utils.lua line 167:
attempt to concatenate local 'realm' (a nil value)
Debug:
(tail call): ?
SpeakinSpell\utils.lua:167: NameIsMe()
SpeakinSpell\wowevents.lua:143: SPELL_AURA_APPLIED()
SpeakinSpell\wowevents.lua:372: func()
SpeakinSpell\wowevents.lua:410: ?()
...Ons\Ace3\CallbackHandler-1.0\CallbackHandler-1.0.lua:147:
...Ons\Ace3\CallbackHandler-1.0\CallbackHandler-1.0.lua:147
[string "safecall Dispatcher[16]"]:4:
[string "safecall Dispatcher[16]"]:4
[C]: ?
[string "safecall Dispatcher[16]"]:13: ?()
...Ons\Ace3\CallbackHandler-1.0\CallbackHandler-1.0.lua:92: Fire()
Ace3\AceEvent-3.0\AceEvent-3.0.lua:120:
Ace3\AceEvent-3.0\AceEvent-3.0.lua:119
Locals:
None
AddOns:
Swatter, v5.0.0 (<%codename%>)
WowheadLooter, v60005
Ace3, v
AckisRecipeList, v3.0.8
Auctionator, v3.2.0
ClassTimer, v2.3
DBMCore, v
DBMDefaultSkin, v
DBMStatusBarTimers, v
Decursive, v2.7.3.6
Dominos, v6.0.11
DominosCast, v
DominosEncounter, v
DominosRoll, v
DominosXP, v
GatherMate2, v1.33.3
Grid, v6.0.3.1710
LibSharedMedia30, v3.0-89
Mapster, v1.6.2
Paste, v1.4.1
PetBattleTeams, v3.2.8
PetTracker, v6.0.12
PetTrackerBreeds, v
PetTrackerConfig, v
PetTrackerSwitcher, v
PetTrackerUpgrades, v
Postal, v3.5.1
Skada, v1.4-23
SlideBar, v5.0.0 (<%codename%>)
SpeakinSpell, v6.0.3.03
TomTom, vv60000-1.0.1
BlizRuntimeLib_enUS v6.0.3.60000 <none>
(ck=2c3)
Hopefully getting a little better...
--------------
6.0.3.03 - beta
--------------
Updated WoW version for "/ss ad" messages,
and the ads will not be forced into the /i chat channel if you specify another channel like "/ss ad /g"
Fixed a syntax error in "Name" vs "Name-Realm" logic
Thanks for the quick response! Oops - that was a noob mistake. Try it now...
--------------
6.0.3.02 - beta
--------------
Fixed syntax errors so it will load
Unfortunately, attempting to load the mod completely failed...while the mod shows as able to be used, I get two errors and the mod doesn't do anything at all. It does not show up on the Addons menu and the /ss commands do nothing.
Here are the errors:
-------------
Date: 2014-12-09 20:50:21
ID: 1
Error occured in: Global
Count: 1
Message: ..\AddOns\SpeakinSpell\utils.lua line 149:
'then' expected near 'return'
Debug:
[C]: ?
Locals:
AddOns:
Swatter, v5.0.0 (<%codename%>)
WowheadLooter, v60005
Ace3, v
AckisRecipeList, v3.0.8
Auctionator, v3.1.9
ClassTimer, v2.3
DBMCore, v
DBMDefaultSkin, v
DBMStatusBarTimers, v
Decursive, v2.7.3.6
Dominos, v6.0.11
DominosCast, v
DominosEncounter, v
DominosRoll, v
DominosXP, v
GatherMate2, v1.33.3
Grid, v6.0.3.1710
LibSharedMedia30, v3.0-89
Mapster, v1.6.2
Paste, v1.4.1
PetBattleTeams, v3.2.8
PetTracker, v6.0.12
PetTrackerBreeds, v
PetTrackerSwitcher, v
PetTrackerUpgrades, v
Postal, v3.5.1
Skada, v1.4-23
SlideBar, v5.0.0 (<%codename%>)
SpeakinSpell, v6.0.3.01
TomTom, vv60000-1.0.1
BlizRuntimeLib_enUS v6.0.3.60000 <none>
(ck=2ad)
---------------------------------
Date: 2014-12-09 20:50:21
ID: 2
Error occured in: Global
Count: 1
Message: ..\AddOns\SpeakinSpell\data.lua line 113:
attempt to call method 'CopyTable' (a nil value)
Debug:
[C]: CopyTable()
SpeakinSpell\data.lua:113: InitRuntimeData()
SpeakinSpell\SpeakinSpell.lua:82: OnLoad()
SpeakinSpell\SpeakinSpell.lua:433: in main chunk
Locals:
AddOns:
Swatter, v5.0.0 (<%codename%>)
WowheadLooter, v60005
Ace3, v
AckisRecipeList, v3.0.8
Auctionator, v3.1.9
ClassTimer, v2.3
DBMCore, v
DBMDefaultSkin, v
DBMStatusBarTimers, v
Decursive, v2.7.3.6
Dominos, v6.0.11
DominosCast, v
DominosEncounter, v
DominosRoll, v
DominosXP, v
GatherMate2, v1.33.3
Grid, v6.0.3.1710
LibSharedMedia30, v3.0-89
Mapster, v1.6.2
Paste, v1.4.1
PetBattleTeams, v3.2.8
PetTracker, v6.0.12
PetTrackerBreeds, v
PetTrackerSwitcher, v
PetTrackerUpgrades, v
Postal, v3.5.1
Skada, v1.4-23
SlideBar, v5.0.0 (<%codename%>)
SpeakinSpell, v6.0.3.01
TomTom, vv60000-1.0.1
BlizRuntimeLib_enUS v6.0.3.60000 <none>
(ck=2ad)
This is a totally untested shot in the dark because I don't have an active WoW account anymore to login and test it, but I took a shot at updating some minimal issue for WoW 6.x. Does this work?
I'm reminded of a scene from the Weird Al movie UHF with a blind man trying to solve a rubicks cube, repeatedly showing it to the guy next to him and asking "Is this it?"
--------------
6.0.3.01 - beta
--------------
Updated TOC file for WoW 6.x
Fixed issues related to "Name" vs "Name-Realm"
Updated supporting libraries
So all we have to do is update the version number of Speakinspell? Thanks!
If you want to create a small-scale lighter-weight addon that _intentionally_ does less than SpeakinSpell, then I have no objection. But if what you really want is for SpeakinSpell to be up to date, you are welcome to join in and participate on the maintenance of the original SpeakinSpell here.
The beauty of open source is that you are welcome to hop in and join this project to fix SpeakinSpell instead of dupicating it. I would greatly appreciate your support if you're willing to help!
The matching development site for SpeakinSpell over on wowace.com has a lot of good info and I'd be glad to answer any questions you have about the code if you send me a PM here on Curse.
If I understand correctly from recent comments, SpeakinSpell does currently work with WoW 6.x, but you have to update the TOC file to make it appear to be up to date (because Blizzard removed the checkbox to load out of date addons???)
Otherwise, the only new problem seems to be that Blizzard keeps changing how the API retrieves a character's "Name" vs. "Name-Servername" as they continue to refine the way grouped servers work. It's annoying but not much of a blocking issue, is it?
I suppose I could take a shot in the dark at fixing those issues, but it would only be a shot in the dark because I don't have an active account to login to the game to test if the repair actually works, and fuss with it through trial and error...
I noticed that now SpeakinSpell uses the "full name" syntax for names.
That is "Name-servername" instead of just "Name". Is there a way to make it so it just uses the name without the server?
Ah noticed that too.
It's all good, I'll wait for a fix ^^ Unless you're telling me you're not having time to keep this addon updated anymore, in which case I'd be very sad ;_;
I have time to help with SpeakinSpell maintenance, but unfortunately, I don't have an active WoW account anymore to login and test repairs. Blizzard doesn't document the API very well, so maintaining SpeakinSpell always required a lot of trial and error to figure out what would work. I would be very glad to help analyze and fix the problems to keep it working, but I need someone with an active account to help make sure it _actually_ works before we post official releases, otherwise I'd just be shooting in the dark...
1. open TOC file named...
"SpeakinSpell.toc"
"SpeakinSpell_Defaults.toc"
"SpeakinSpell_GUI.toc"
"SpeakinSpell_Patches.toc"
2. Change the letter that below
## Interface: 60000
## Title: SpeakinSpell (not important)
## Title-deDE: SpeakinSpell (not important)
## Author: Stonarius of Antonidas (not important)
## Author: Groguz (not important)
## Version: v6.0.3.0
YOU MUST CHANGE LINES OF INTERFACE & VERSION
3. save file & play WOD
enjoy your warcraft
Does WoW still offer a checkbox for "load out of date addons" ? I haven't played in about 2 years.
please, don't let this add-on bite the dust. It's the only add-on like it out there, and it's incredibly useful & fun.
Compatible with 6.0.2? going to be updated for WoD? if not, anyone out there know of a simular addon(s) that are being kept up to date?
Thanks in advance!
Hey!
Any chance of this getting updated for 6.0? I love this addon!
Didn't you guys used to have portal messages? That was the whole reason I got this addon, but I haven't played in a while and now I don't see any. :(
very very easy to add your own messages. First thing I did when I got the addon... have over 100 random things I say when rezzing people now lol
Just wondering. I don't remember it triggering the grats for acheivements to the person playing. IE myself. I find that now it triggers and auto grats me when i make an achievement as well as other memeber of my guild. I don't recall it doing that before. I only just started noticing that over the past couple weeks. I have a friend who uses this and she noticed it as well. It's not going to stop me from using it but I was wondering what happened to it to cause it to start autograting myself as well. Just kinda looks funny that I'm congratulating myself.
Great to see this mod make a return since I have returned to WoW recently. I did notice a bug with a speech of mine though, it's supposed to trigger when 'I Successfully Cast: Power Word: Barrier' but it triggers whenever any priest nearby casts PW: Barrier, including myself.
Hope the mod continues to be updated for WoD too!