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...
Until I fix the bug, I've been told it will work if you go to the general settings (/ss options) and turn on "always use orcish" (That option overrides and disables all event-specific racial RP language options in a way that reportedly prevents the bug from happening)
Other Horde players have reported the same problem. (ticket 154: http://www.wowace.com/addons/speakinspell/tickets/154-you-dont-know-that-language-errors/). That's a weird bug that appeared to break only for Horde players in Cataclysm. I've never had it happen to me as Alliance.
>> Orcish, random, and Thalassian. I am neither of those races as a Blood Elf.
All horde speak "Orcish" (not just Orcs) the same way that all Alliance speak "Common" (not just Humans) and the Blood Elf language is called Thalassian in an RP/Lore kind of way (rather than Bloodelfian) so you *should* know both languages as a Blood Elf.
The problem is probably something like I'm trying to make you speak a language called "GUILD" in a chat channel called "Orcish" ... that kind of thing, just some kind of technical defect I need to track down where Blizzard changed something on me.
>> I looked closer and my cooldown was set to 11
Ohhh yeah that too... putting a few seconds of cooldown on guild grats is actually a good idea because sometimes people get 6 achievements at the same time (like finishing the argent tournament achievements), or a whole 10-man guild run will defeat a raid boss for the first time together and they spam guild chat with 10 achievements... you probably don't want to echo that with 10 grats. That's why I put a cooldown on it. I'd recommend at least 3 seconds.
Great response time, btw...I really like this add on and now I like it more. :P
I´m looking for a way to annouce that i interrupted certain spell, not that i sucessfully cast interrupt spell. Do you know what i mean? This announcement seems to be very important for cata and i couldn´t get it to work yet. Could you help me please?
I found it out today. It´s called sInterrupt:
http://wow.curse.com/downloads/wow-addons/details/sinterrupt.aspx
I thought you´d still like to know. ;)
Also, "Grats!" is not a word. You mean "Congratulations!" which is already in there by default. "grats" is how players usually say it, and I wrote it that way by choice, not because I was sloppy. It's a matter of taste. To each his own.
Recently, I added an event: "On successful cast [Rough Dynamite]". Well, it worked perfectly fine. Whenever I tossed a stick of Rough Dynamite, the event would trigger and I'd do one of many random things. However, I later found out that there was a problem with this... The event for Rough Dynamite ALSO triggered when I CREATED Rough Dynamite with Engineering! This is kind of awkward considering some of the actions I have listed are "Bombs away!" and "Ka-BOOM!".
Anyway, is this intentional? Or just an unfortunate, coincidental kind of condition?
A future version of SpeakinSpell will fix this, but it's somewhat tricky so it may take a while... In the mean time, my temporary solution is to put a cooldown on the SpeakinSpell speech for a couple of minutes, or put it to silent when you're solo. That way it still announces when I use the item in combat in a group, but only says it once when I'm crafting a stack.
but i cant seem to find it. The Chat Events Category is empty.
With setup guides checked, nothing happens when a guildie says ding.
How can i make SpeakinSpell work with 'ding' in guild chat?
---------
4.0.3.05
---------
Removed the SpellIdCache and the related lag-producing search to match a spell name to its ID
- New in WoW 4.0, spell IDs are now reported by the Blizzard API events like UNIT_SPELLCAST_START, so we don't need to search for an ID that matches the name anymore
Fixed a Lua error in "/ss import"
Fixed a case where <targetclass> was still using the target's name for NPCs instead of "NPC"
Fixed minor inaccuracies in the memory usage report
WoW/Interface/addons/SpeakinSpell_Defaults/DefaultSpeeches-enUS.lua
and you changed it... but that didn't change anything in-game, by design, because those are just the default settings. When you first install SpeakinSpell, it makes a copy of the default speeches, and saves them in your SavedVariables file, which is here:
/WoW/WTF/Account/<your name>/SavedVariables/SpeakinSpell.lua
So if you *really* want to go outside the game and edit the lua file to change strudel into cake, the file you need to change to have an effect in-game is your SavedVariables. You'd have to exit the game before you change this file, because WoW saves this file every time you logout, and you don't want that to overwrite your changes.
However, since you already changed the DefaultSpeeches file, you *could* actually use the command "/ss reset" in-game to reset to the defaults, and it would have to use your modified version of the defaults, which would have the same effect: it would copy your changes from DefaultSpeeches-enUS.lua into your SavedVariables.
But... don't you realize you can change all this in-game? Just go to "/ss messages" or right-click the minimap button and click on Message Settings. That was kinda the whole point of making this addon in the first place, because I used to edit lua files outside the game to change my mage table speeches way back in Cryolisis 2, over 2 years ago, and I hated that my new macros always got blown away when I'd install an update to the addon, which I had to do every time Blizzard released a patch...
So with SpeakinSpell, when you install an update, it will *never* change your speeches in-game, because I assume you changed them all and spent hours writing your own witty new macros for your spells and guild achievement congratulations and stuff, just like I would do, and I don't want to destroy all your hard work. So whether you change the DefaultSpeeches file like you did, or whether I change it in an update to SpeakinSpell, either way, that won't change your speeches in-game, because those aren't YOUR speeches, those are just the defaults, and I see a big difference.
That said, if you install an update to SpeakinSpell, and you *choose* to use the new default speeches (if I added new ones) you can import them one at a time, or in groups, by using "/ss import"
Also, I feel compelled to say that "Slam into a cake!" just doesn't have the same ring to it. "Slam into a strudel!" is a satire of the old "Slam into a Slim Jim" commercials... I just don't think it fits for cake. But that's just me. By all means, go ahead and use "Slam into a cake!" if you like it, I really want you to write your own speeches... especially if they're good and I can copy them LOL... but I haven't come up with anything better yet for cake either, so... /shrug. Little <player's> Cakes<TM> - some spoof on Hostess or Little Debbie's? I dunno LOL.
That's half the fun of SpeakinSpell is writing all your own speeches (/ss messages) and setting up new event triggers (/ss create) and that's why I rambled on like this in detail instead of just giving you the SavedVariables file path that you asked for. Plus you said "ANY thoughts?" and I had plenty LOL :P
If a spellcast triggers a speech calling "/ss macro [whatever]", does that called macro inherit the substitution data from the spell, such as [spellname], [target], etc? If so, would that inheritance continue through multiple steps until a terminus was reached?
The reason that I ask is that, currently, most of my spells are set to trigger /ss macro [spellname]-pve and /ss macro [spellname]-pvp macros, each of which speaks in appropriate conditions and is silent in its partner's conditions. Even with a low percentage set, there's a -lot- of spellcasting taking place over the course of a fight, and I've seen the RNG trigger 4 events in 4 GCDs, then go silent for half an hour. Rather than using the global cooldown built into SpeakinSpell (which would also prevent me from auto-gratzing guildies who gain achievements while I'm in combat), I want to put in a throttle macro.
The intended architecture would be for any of my offensive spells to call "/ss macro combat-throttle", with that setup to call "/ss macro [spellname]-pve" and "/ss macro [spellname]-pvp" together. This way, I could put a cooldown specifically on my spells, and once I had their percentages relative to one another where I like them, I could adjust my over-all spamminess by modifying the throttle macro's proc chance and cooldown. This would allow me to control all of my spellcasting events comfortably, while leaving outside events open to fire normally.
Will these modifications work as I hope, or is it going to be a wasted effort to login and perform the setup for it?
More importantly, if this -does- work as I hope, in what other ways could I use this group-throttling trick?