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...
- Import New Data -
This interface allows you to browse for new content, including speeches and <randomsubs>, and import anything you like into your active settings.
This also includes some touch-ups on the default speeches, and added content packs.
Since I updated from 3.2.2.04 to 3.2.2.07, I've been unable to enter text into any of the random saying fields. It doesn't pop up any LUA errors on me-- it just doesn't do anything.
Assuming that somehow a solution to that crops up, I was actually wondering if there's any way (as a warlock) to detect my commands to my pets as I remember Battlecry doing or, better yet, to detect my pets' actions whether I commanded it or they're acting on their own.
I suspect that something may have been loading before SpeakinSpell that prevented some of the embedded library from working correctly.
On the pet attack question, I assume I'll have to add support for additional combat log events in order to announce those.
Of course it would be better if SpeakinSpell had native support for pet abilities, and that's definitely something I'd like to add, but I just thought I'd mention the "/ss macro" featuure for a temporary solution until I have time to figure out how to add that feature.
I've been hoping since sometime around WoW2.2 to be able to use the trigger: "When my pet casts Charge" rather than "When I tell my pet to charge." After all, the Felguard runs in on his own, and cleaves without me having to tell him to. I'd just love for his master to be able to encourage such behavior in his minions.
Still, no LUA errors cropping up that I can find. I've discovered that when it goes into this mode, I can actually type in the field and save it, but I cannot see the field updating after anything has happened on the message settings page.
I'm sorry if I'm posting this in the wrong place.
Hmmm... I run Vista too (64-bit home edition), and I just now tested SpeakinSpell with no other addons loaded, and I do not see this problem. I'm able to make any number of changes to the speeches, add, delete, change, and save them all, and I don't see this problem with losing the ability to click on those controls.
That's unfortunate. It means A) I don't know how to fix your problem, so B) I have to type more paragraphs of rambling speculation...
The lower level behavior of those text input boxes comes from either WowAce embedded libraries, or Blizzard, or both. All I do is set up a data structure which I pass to a WowAce API to add it to the blizzard options frame. The behavior of the Accept button or bugs with those text boxes disabling themselves is somewhat outside my control.
It's possible this is a WowAce library bug that only effects very few people, or only pops up if you have some other problem that falls in the category of "/shrug, delete your WTF folder and see if that helps." Ya know, like what Blizz tech support would say...
One thing I will point out is that the new multi-line text boxes have the same odd behavior in the Accept button as they did back in the one-line text boxes. There's no "lost focus" handler when you click off the text box, so your changes are lost if you do that. After typing any changes, you MUST click the Accept button to save those changes. Otherwise, when you click off to set the input focus somewhere else, like the next text box, your changes get lost from the previous one because you didn't click Accept.
I have also seen an issue very rarely where the cursor stops showing up. That seems pretty random, but the issue there is limited to the cursor not blinking on the screen - the cursor is actually still there, and you can still type.
>> I can actually type in the field and save it...
OK so you're clicking Accept and it saves the change then, right?
>> but I cannot see the field updating after anything has happened on the message settings page.
This part I don't fully understand. What kind of thing happening are you expecting to update the text field?
When I first load the options GUI, everything is as it is supposed to be. I can see the text inside each of the boxes, click one of them to get a cursor, etc. If I change one of the dropdown boxes or click Accept below any of the text boxes, the window jumps back to the top and whatever change I'd made is saved.
From this point, if I scroll back down to the entry boxes I cannot see the contents of any of them. Anything checked as "read-only" will show up and be legible, but the boxes that are still editable appear blank. If I click on one of them, no cursor appears. No text I type is visible, but if I click Accept afterward it saves properly, and is viewable if I reloadui or check the read-only box.
As far as I can tell, the boxes are working exactly as they should on the data side. It's only the visual difficulty of not being able to see a cursor position or what text is already contained in the box.
I'm on the same version of Windows as you, by the way. Note that renaming my WTF and WDB folders did no good (as if it ever does?)
One oddity I notice is how you say it jumps back to the top of the window after you accept a changed speech... that shouldn't happen. I'm not sure why it does that, but I'll look into it and see if that clue pans out.
Meanwhile, the new v3.2.2.09 adds an option to use the old single-line edit boxes. That might help as a work-around.
My main is a mage, so you'd think I would have noticed that, but I never tried to announce when Ignite procs, so it never occurred to me that it's a different kind of combat log event. I would bet the same limitation applies to Improved Scorch and several other debuffs for other classes as well, if they are applied to your target in a similar way.
The issue here is that we're talking about abilities that proc in a way that does not generate a "When I start casting: ____"
kind of combat log event (UNIT_SPELLCAST_SENT notification through the WoW LUA API) and it obviously doesn't generate a "spell aura gained" combat log event either, because that's only for buffs/debuffs on you.
I assume there must be another type of combat log event that I could monitor in SpeakinSpell to detect these types of procced debuffs like Ignite. I'll have to research it and add the feature.
I will say though, just as a warning, that Ignite procs so often that it's really not the best choice of event for SpeakinSpell announcements, unless you give it a very small random chance and/or long cooldown, or limit to once per combat or whatever, at which point it will seem so random anyway that you might as well attach those speeches to Fireball or Scorch instead, which are what you're using to proc Ignite in the first place.
For example, I used to announce Hot Streak procs, and that only procs roughly 25% as often as Ignite, but that was still way too much chat spam... once I started announcing it every time it procs, I realized just how often it procs and had to tone down my SpeakinSpell spam because it was way too much. Instead, I have a 2% chance to announce most fire spells now.
So I'm just throwing those ideas out there as possible work-arounds until I can figure out how to detect/announce Ignite and similar procs.
I've had it proc several times now and the addon does not register it for me to create a speech event.
This "chance on hit" effect, otherwise known as a "proc," counts exactly the same as casting a spell, even though it's automatic, and it's not exactly a magic spell... but as far as the game is concerned, you cast a spell.
So go to "/ss create" and look through the list of spells for a speech event called "When I start casting: ____" for whatever that "spell" is called when your glove enchant procs. The proc effect "spell" will probably not have the same name as the glove enchant.
If you don't know what to look for - the name of the spell you cast when your glove enchant procs - you can check your combat log, or you can go to the general options "/ss options" and turn on the option to "Report Detected Speech Events" ... then fight until your glove enchant procs, and see what it was called in the combat log.
(under "/ss create") You could also try to search the possible speech events for a guess at part of the name of the spell, like "launch" or "air" or "knock back" and see if anything comes up.
Is this an error?
(If not, I would like it very much if the addon would just use the currently set language.)