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...
Hi! Sorry for the delay; you managed to comment the one week I was out of town. Can you please tell me what other addons you are running? There have been no recent changes to the Speakinspell code and we haven't hit the patch yet, so it's gotta be a conflict with another addon. Thank you!
Throughout the past 4-5 years, it's been a great pleasure to tinker with SpeakinSpell and share it with all of you. However, times change, and I have decided to take an official hiatus from the game in order to pursue other interests - don't get me wrong, MoP is great, it's not the game, it's me, and I might be back someday...
So anyway, with my WoW subscription on hold, I have to reluctantly step down, and this will be my last post as the Project Manager of SpeakinSpell, and I just wanted to take a moment to thank you all for the many years of support and enthusiasm you've shown for my little pet project here. When I first published SpeakinSpell on Thanksgiving weekend of 2008, I never imagined it would reach a thousand downloads, but today the count is over 140 thousand downloads over the life of the project, and I estimate about 9-10 thousand active users world-wide (based on the peak downloads for individual versions)
Duerma has graciously agreed to take over maintenance and development in my absence, so please bombard her with your steady stream of feature requests and complaints, I'm out!!
-- er, I mean... Please continue to show her the kind support and enthusiasm for macro fun that you've shown me all these years 
Thanks for the fun ride!
/p Stonarius is sheeping >> His WoW subscription << ... Baaaah!
is there any way of restoring the settings i had on the addon befor i cleared the interface folder with the addon folder in it? i still have a backup of what i was using but dont want to go thoguht and deleate and readd the ones i was missing agian
All of your speeches for all characters are stored here: C:\Users\Public\Games\World of Warcraft\WTF\Account\<your name>\SavedVariables\SpeakinSpell.lua
If you want to create a backup of your speeches, that's the file you need to backup or restore - NOT anything from the /interface/addons/SpeakinSpell/ folder.
C:\Users\Public\Games\World of Warcraft\Interface\Addons\SpeakinSpell\ is separate, where the addon code lives.
So all of your speeches and other saved settings should be unchanged by deleting and reinstalling your addons.
Just got the addon to replace one that became out of date and so far I'm loving it. My only question is if it is possible to add delays to speech events. If not this would be a nice feature. My old addon for 'gratzing' my guildies' achievements let me set up a 5-15 second interval bewteen the achievement and the message, making it feel more natural and less automated.
You can add delays if you get another addon called ShashIn. Then you can write your speeches in SpeakinSpell to say something like "/in 5 /g grats!"
An unfortunate side effect I've noticed since the addition of the instance channel is if I have say an event that plays a message in party chat such as '<spelllink> on >>><target><<<!' I can't leave it set to party because in instances the game will say I'm not in a party, but if I set the event to use the instance channel it will say I'm not in an instance when in the oustide world. Very bothersome...
Ugh, that's unfortunate. There are several considerations for the best way to handle this problem within SpeakinSpell, so I'm thinking it over. Meanwhile, I'm open to suggestions. So far, I can think of the following options for changes I can make to SpeakinSpell to help with this problem:
I could potentially add all of those features, and I'm open to other ideas as well.
The update for WoW 5.1 is ready.
---------
5.1.0.01
---------
"Up to date" for WoW 5.1
Added event triggers for fading buffs and debuffs
Added support for the Instance channel (/i)
Blizzard has removed the Battleground channel (/bg).
Your settings will be updated automatically to use the new Instance (/i) channel instead.
Awesome. I thought it was interesting that they came up with an instance channel, and until I read your notice I had no idea they did away with the battleground channel. I'm very glad to hear you updated this addon. I love it. Thanks =]
Any hope of getting this baby up and running with 5.1?
I honestly cannot find a replacement :c
Please add support to create an even for buffs fading. That's the reason why i downloaded the addon in the first place :(
Also, is there a way to remove ALL pre-existent speeches? I only want speeches I've created myself.
Type "/ss eraseall" to erase all your data. This includes any defaults as well as any custom speeches you've written.
I use the following in several macros and I was wondering are they implementable via SS through custom configuration:
/run for i=1,GetNumRaidMembers()-1 do local u,t="raid"..i,"target"if UnitIsUnit(u..t,t)then SendChatMessage("Change targets! Trying to sheep...","WHISPER",nil,UnitName(u))end end
Can I have my above script only announce that I'm CC'ing once per target at a max time limit of once every 30 seconds.
And can I implement scripts that I use to run specific sound files that would be prevent it from spamming the sound file once per 30 seconds even if I cast that spell 10 times within 30 seconds , eg:
/run PlaySoundFile("Sound\\Creature\\RAGNAROS\\VO_QUEST_42_RAGNAROS_TAUNT_01.ogg");
Example macro:
#show Living Bomb
/cast Living Bomb
/run PlaySoundFile("Sound\\Creature\\RAGNAROS\\VO_QUEST_42_RAGNAROS_TAUNT_03.ogg"); <=== prevent this from being run to only once every 30 seconds even if I button mash.
Yes to all your questions.
>> /run...
Am I reading this correctly that you're sending a whisper to the targeted raid member? So you must be casting your CC on your focus instead of your selected target, right? Otherwise UnitIsUnit("raid"..i, "target") will be false and you won't SendChatMessage. Or am I misreading your script and your intentions here?
That's much easier in SpeakinSpell. You can simply use the speech:
/t <target> Change targets! Trying to cast sheep on <focus>
I get the idea you have your tank targeted and want to whisper to them? Why not just use /ra chat?
>> Can I have my above script only announce that I'm CC'ing once per target at a max time limit of once every 30 seconds.
Of course. Go to "/ss messages" and select your polymorph event trigger. Check the checkbox for "limit once per <target>" and set the cooldown to 30 seconds.
SpeakinSpell will enforce both rules at the same time and err on the side of silence, so if you change targets and sheep within less than 30 seconds, you won't announce it. Is that really what you want? I suspect that "limit once per <target>" is enough. (I built that feature for use with CC)
That limit of once per target is based on the target's name changing, so if you go from one trash pull to the next and its your job to sheep the "Sorcerer" on every pull, SpeakinSpell won't consider that a change in targets, even though it's a different Sorcerer this time.
If you're trying to whisper to your target (of sheep??) you can use a SpeakinSpell speech like
/t <target> Change targets! Trying to sheep
But you can't whisper to a mob, so that doesn't make sense...
Is the situation like... you have your tank targeted, and your CC target set as your focus, so you cast sheep on your focus (/cast [@focus] polymorph, or use the Alt key) and you want to whisper this to the tank.
/t <target> Change targets! Trying to sheep <focus>
>> can I implement scripts that I use to run specific sound files that would be prevent it from spamming the sound file once per 30 seconds even if I cast that spell 10 times within 30 seconds
Yes, just go to "/ss messages" and select the event trigger called "When I start casting: Living bomb" and set the cooldown to 30 seconds, and the speech to
/run PlaySoundFile("Sound\\Creature\\RAGNAROS\\VO_QUEST_42_RAGNAROS_TAUNT_03.ogg")
SpeakinSpell detects the spell casting for you, so you'd remove that /run command from your macro, which would become simply
#show Living Bomb
/cast Living Bomb
and you don't need to make a macro like that because it doesn't do anything... just stick the Living Bomb spell in your bar.
>> /run for i=1,GetNumRaidMembers()-1 do local u,t="raid"..i,"target"if UnitIsUnit(u..t,t)then SendChatMessage("Change targets! Trying to sheep...","WHISPER",nil,UnitName(u))end end
Ohhh I see what your script is doing now. You want to whisper to any/all raid members who are currently targeting your CC target, so they will know to stop hitting it, so they don't break your CC.
OK, try this as your speech in SpeakinSpell, and note the added use of the <target> substitution
/run for i=1,GetNumRaidMembers()-1 do local u="raid"..i; if UnitIsUnit(u.."target", "<target>") then SendChatMessage("I'm trying to sheep your target: <target> - please stop hitting it!","WHISPER",nil,UnitName(u))end end
Unlike your current approach, the script above through SpeakinSpell will support focus casting accurately, because the SpeakinSpell <target> substitution uses the actual target of your spell, which is not necessarily the same mob you have selected as your target, i.e. if you're using focus casting, or other addons or macros to target your spells.
And of course you can still set it to a 30 second cooldown and/or once per target. And if it's not obvious, you'll have to set the selected chat channel to /say or anything other than Silent. It won't actually "/say /run ..." because your use of a slash command (/run) will override the selected chat channel, unless you selected the "Silent" channel option to disable speeches for this event under a certain scenario (i.e. enabled in raids, but disabled in battlegrounds)
I'm afraid that, at some point during my long absense from WoW, the guides/tutorials I wrote for SpeakinSpell have been lost forever. I intend to try to remember what I had written, and go on to rewrite them, but for now the link is dead (which I'm sure somebody's noticed by now) and cannot be recovered.
I'm sorry for the inconvenience.
Welcome back, Aetharan!
A new set of tutorials is being born as we speak. They are located here.
Is it possible to say ACHOO when i use my shockwave on my warrior?