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...
Great addon :), been looking for something like this for a long while since BrabbelRP got outdated.
Will there be a way to speak something while looting a npc or chest?
This event should be "LOOT_OPENED".
good idea. I created a ticket to track this new feature idea
http://www.wowace.com/addons/speakinspell/tickets/187-speak-something-while-looting-a-npc-or-chest/
Is there a way to add in an alternate substituion for situations when you don't have a <target>? Similar to the target self spells having no target? I have speeches that are firing off in situations like combat if I aggro a mob as I ride by on a mount (instead of initating combat) or NPC interactions with objects that provide quests (like noticeboards) and they'll just say <target>. I know the guildless <guild> substitution is "Your Friends". Is there anyway to make that customizable?
Not yet... it's a new feature idea discussed in more detail in the following ticket:
http://www.wowace.com/addons/speakinspell/tickets/113-target-unknown-target/
Thank you so much! Hopefully that's fixed correctly now and isn't offset by 1 letter...
--------------
6.0.3.06 - beta
--------------
Fixed yet another Lua error in the new "Name" vs "Name-Realm" logic
ok tested. working fine!
Yay! Thanks! :)
wait its still borked..
cross realm targets produce <last letter of name>-<realm>
i think ur tossing the wrong string.
no errors tho
changing
return string.sub( NameWithRealm, index-1)
(in utils.lua)to
return string.sub( NameWithRealm, 0, index-1)
seems to fix it.
Thanks! Try it now...
--------------
6.0.3.05 - beta
--------------
Fixed another Lua error in the new "Name" vs "Name-Realm" logic
seems to be fixed =D
awesome!
iz stil borked! anything with <target> generates errors.
there's 2 errors here.
4176x SpeakinSpell\utils.lua:149: attempt to call field 'substr' (a nil value)
SpeakinSpell\utils.lua:149: in function `PlayerNameNoRealm'
SpeakinSpell\wowevents.lua:1404: in function `?'
...Pet\libs\CallbackHandler-1.0\CallbackHandler-1.0-6.lua:147: in function <...Pet\libs\CallbackHandler-1.0\CallbackHandler-1.0.lua:147>
[string "safecall Dispatcher[17]"]:4: in function <[string "safecall Dispatcher[17]"]:4>
[C]: ?
[string "safecall Dispatcher[17]"]:13: in function `?'
...Pet\libs\CallbackHandler-1.0\CallbackHandler-1.0-6.lua:92: in function `Fire'
...BartrubySummonPet\libs\AceEvent-3.0\AceEvent-3.0-3.lua:120: in function <...BartrubySummonPet\libs\AceEvent-3.0\AceEvent-3.0.lua:119>
Locals:
nil
here's the 2nd one
748x SpeakinSpell\utils.lua:146: bad argument #1 to 'find' (string expected, got nil)
[C]: in function `find'
SpeakinSpell\utils.lua:146: in function `PlayerNameNoRealm'
SpeakinSpell\wowevents.lua:164: in function `SPELL_AURA_APPLIED'
SpeakinSpell\wowevents.lua:372: in function `func'
SpeakinSpell\wowevents.lua:410: in function `?'
...Pet\libs\CallbackHandler-1.0\CallbackHandler-1.0-6.lua:147: in function <...Pet\libs\CallbackHandler-1.0\CallbackHandler-1.0.lua:147>
[string "safecall Dispatcher[16]"]:4: in function <[string "safecall Dispatcher[16]"]:4>
[C]: ?
[string "safecall Dispatcher[16]"]:13: in function `?'
...Pet\libs\CallbackHandler-1.0\CallbackHandler-1.0-6.lua:92: in function `Fire'
...BartrubySummonPet\libs\AceEvent-3.0\AceEvent-3.0-3.lua:120: in function <...BartrubySummonPet\libs\AceEvent-3.0\AceEvent-3.0.lua:119>
Locals:
Well cheers for keeping this addon working. It is greatly appreciated and is one of the most fun and useful addons I've ever come across.
Maybe fixed the last major issue? Or Maybe I broke it worse? Try it now...
--------------
6.0.3.04 - beta
--------------
Fixed another Lua error in the new "Name" vs "Name-Realm" logic
Should now display "Name" instead of "Name-Realm" for all <target> and <caster> substitutions
I just HAD to make this account just to tell you how stupid it is that you haven't created an event for silences.
Do one single arena as a healer and see if you wont get silenced once. Oh my god.
Agree that would be a helpful feature. I used to get a lot of good use out of this in Arena back when I still had an active WoW subscription.
First, I'd like to apologize for the attitude in the comment. I spent hours looking for an addon to report (in chat) enemies use of CC and cooldowns, and thought I'd finally found it.. Then I realized the aforementioned issue ..
Unfortunately, it is kind of necessary since a lot of people don't want to use GladiatorLosSA or don't know about it, so I have to use this addon for them. Way too often, my team mate dies and asks "yo man y u no heal???" and with this addon, I could make it say "{skull} {square} POLYMORPHED - COME TO ME {square} {skull} .. Quite handy :-)
LOL it's all good. I'm glad you like it. I always got a lot of fun out of SS in Arena. :)
When you get silenced by a priest, you get a debuff on you for a few seconds, right? SS should be able to announce the debuff on you, although not the "being interrupted" part.
Getting kicked by a rogue is not supported by SS, because you don't get a debuff on you, just long cooldowns on everything. That calls for a new feature in SS (ticket 177 on the wowace project site).
I did the recent updates in the dark, blind, without an active WoW subscription to login to the game. I'm not sure if I'm brave enough to try adding a whole new feature like that at this time, but I'm thinking about it. There are some others who may be able to help with that.
I'm not that worried about the interrupting - Much, much more worried about the long 4 - 6 sec silences. Haven't noticed if I get an actual debuff from a silence. I'd think I would, but now I'm doubting..
Those silences hurt a lot when they're topped with various stuns ^_^