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...
I have a speach that goes '<spelllink> on >><target><<' for when my pet auto casts Spirit Mend on a low health party member but it doesn't give the target of the spell in the emote, rather it gives my pet's current attack target.
I think this is probably a limitation of the Blizzard API
When the Multi-line edit box checkmark is checked longer speeches can sometimes invisibly cause the Done button to become unclickable, thinking it's part of the Edit window (clicking and dragging will highlight text and move the cursor). This causes the problems I was stated below /earlier with the addon not accepting longer speeches. There is no such problem with single line edit boxes, but this makes speeches difficult to edit.
Also not all emotes seem to be working in the /s channel while in combat. I don't want to move all those speeches to the emote channel, because only a few are actual emotes.
Thanks for the added details about the edit boxes. Unfortunately, that comes from Blizzard and/or the Ace libraries, so there's not much I can do about that kind of behavior... I have an idea to move those edit boxes into their own popup windows, because I think that might improve their behavior, but I can't say when I'll get to that, or if it would actually work... My only guess is that Blizzard and/or Ace don't like that I'm putting 200 edit boxes into the same screen layout and then hiding most of them. It might just be too much for that framework to handle.
>> Also not all emotes seem to be working in the /s channel while in combat.
Have you identified any particular emotes that never work, or does it seem more random?
I suspect it's a configuration issue, for example if the global cooldown sometimes silences your speeches during combat, it wouldn't matter if they were emotes or not. I recommend turning on the option to show why events don't fire ("/ss options" takes you to the general settings, and it's a checkbox in the diagnostic options box near the bottom). That option will explain why events don't fire speeches, i.e. because it's on cooldown, or the random chance failed, or the chat channel is set to silent while in a raid group, or whatever the case may be. Since you said it only fails sometimes, I assume it's probably silenced by a cooldown or random chance, otherwise you'd probably notice that it works in parties but not raids or something along those lines.
>> I don't want to move all those speeches to the emote channel, because only a few are actual emotes.
Any SpeakinSpell speech that begins with "/" such as "/cheer" or "/e does something" will get special processing to run the slash command in a way that the selected chat channel doesn't matter, as long as it's not set to "Silent."
So, whether you select the /say or emote channel shouldn't make any difference, as long as it's not set to Silent. Selecting the Silent channel turns off those speeches while in that kind of group, but if any non-silent channel is selected, and the speech begins with "/" then whatever the slash command says to do should happen.
For a crazy example, you could select the emote channel, but write a speech that says "/p hello party" ... since the speech begins with "/" and the channel is not silent, that should make you say "hello party" in party chat, even though you selected the emote channel.
Quote from rismisner»
Have you identified any particular emotes that never work, or does it seem more random?
It seems to be any ingame emote that is used in combat, it doesn't matter what emote it is. The custom emotes using the /e command work as intended, but the ones with preset ingame effects like /charge, /roar, /laugh, and whatever fire off as white character speech, rather than the preprogrammed emote. Emotes set for events that do not occur in combat work just fine.
Some of Blizzard's changes in WoW 4.3 had an impact in this area.
SpeakinSpell 4.3.0.02 makes some corrections to deal with it, specifically for /script though, not for voice emotes like /cheer. While I doubt the new version will fix your problem, (if the patch didn't fix it) it does add some more debug information in this area if you turn on Show Debug Messages (which is unfortunately verbose - not something to attempt in a raid or with anyone else nearby - for combat testing I usually go attack low level wolves by myself in Elwynn Forest)
I have been able to use /roar /charge and /attacktarget while in combat, when triggered manually from a button in my action bar that runs "/ss macro battlecry" and it works fine. Triggering it from a spell or other event should work exactly the same way.
I'm not likely to notice a reply to this thread now that it has been bumped to the second page, so please provide any new information in a fresh post on the first page.
---------
4.2.0.05
---------
Fixed <target> substitutions in default speeches for Aimed Shot (Hunters) and Talk to Vendor (Night Elves)
This patch only repairs an error in the default data for new users (hunters and night elves) discussed in the recent comments below. Current users who are upgrading will not notice any difference because your saved data is always preserved when you install updates to SpeakinSpell.
If you are an upgrading user, then you have several options to make use of this repair:
A) You may "/ss eraseall" followed by "/ss import" to erase your data and then re-import the new defaults. WARNING: This method will erase all of your saved speeches, and reset them to the new defaults.
B) Use the curse client to erase your saved data for SpeakinSpell so that it acts like you're a new user (or without the curse client, manually erase the file <WoW folder>/WTF/Account/<your name>/SavedVariables/SpeakinSpell.lua). WARNING: Same as (A) This method will erase all of your saved speeches, and reset them to the new defaults.
C) Use "/ss messages" to edit these 2 speech lists manually. Change "TARGET" to "<target>" in all speeches to fix the substitutions. The effected events are Aimed Shot for all Hunters, and Talk to Vendor for Night Elves.
WARNING! Using the Curse Updater to update Speakinspell for this last update WILL delete all your speeches.
Hmmm... that's weird. I don't see any reason for that in the minimal changes that I made this time around.
Just wanted to drop this in here -
I am a new user; never had a previous version of this or any other RP mods/addons. But I have had the exact same problem as Harley described, where the TARGET issue is concerned talking to vendors.
First, I followed your advice - /ss eraseall, etc. Reloaded the UI - still same problem. Exited game in full, came back, still same.
I then checked the /ss recent, and I found all of the default/random greetings for the NPC-vendor event trigger were TARGET instead of <TARGET>
I went through & re-edited manually, and they are all fine now.
The character this happened on was a female night elf druidess. Hope this helps you in the bug hunt!
Darquenezz of Cenarion Circle
Ah-ha! Thanks. That's very helpful
Hi, Ive been trying to set up an event to announce when aura mastery fades (for Rag fight so our disc priest can put up a bubble with the lil molten seed adds). I have been unable to find the event in speakinspell, and was just wondering if this was infact possible? Many thanks
SpeakinSpell doesn't support that (yet)
Hi, I been having an issue that everytime any message with a Target line in it (using only default messages I havent made any custom ones yet) it says "target" I have no clue how to fix this, is quite annoying specialy when greeting vendors and such.
That occurs when the <target> name is unknown because you don't have any target selected, and/or when casting a spell that is not targetable (a self-only effect like a warrior's Shield Wall).
For example, using the default speeches, if you Enter Combat by getting body aggro, SpeakinSpell has a small chance to announce a battlecry ("/ss macro battlecry") which can refer to a <target> when you don't have any target selected. That can also occur frequently if you're healing using an addon like Healbot so you don't have the tank selected as your target, but you get on the enemy's aggro list and Enter Combat anyway, ths triggering a battlecry without a <target> name known.
Anyway, chances are good that you only see this failure when you trigger automatic battlecries from entering combat, so I recommend turning off the Enter Combat event trigger. You can setup a macro button on your toolbar to trigger a random battlecry manually by using the command "/ss macro battlecry" if you want to announce a battlecry after selecting a target (such as a boss) in which case the <target> name will be known
I just noticed that you mentioned the problem occurs when you greet vendors... In that case, you should have the vendor targeted, and the problem that I described should not occur.
The speech in SpeakinSpell should say "<target>" in order to work correctly. If it says "Target" then it may be using the old RPHelper2 syntax. Several months ago, Duerma added many new default speeches that she took from her older RPHelper2 project, and some of those speeches were copy-pasted incorrectly using RPHelper2's syntax of "Target" to specify where to insert the target name, instead of the SpeakinSpell form that uses brackets around it as "<target>" I thought I fixed all of those, and I can't find any of those mistakes in the current code, so either I'm overlooking something, or you must have carried over those flawed speeches from an older version of SpeakinSpell.
When you see the problem, if it says "<target>" with brackets, then the problem is that the target is unknown (which should never be a problem if you have someone selected). If it says "Target" without brackets, then the speech is written incorrectly in your SpeakinSpell data, and you need to change it to "<target>" with brackets. The easiest way to do that is to type "/ss recent" after you see the problem, and then use the clickable links in your chat window to [Edit Speeches] for the event trigger that has the problem, then scroll down the list of random speeches to find where it says "Target" and change it to "<target>".
Alternatively, since you use only default speeches, you could try refreshing them to the latest defaults by using "/ss eraseall" followed by "/ss import" and then click [Search] then [Use All]. If you try this approach and find that it still says "Target" instead of "<target>" then please let me know what race and class is your character to help me narrow down where to look for the error in the default speeches data.
Also, is there a way to link my professions into a speech? Trying set up advertisements to send out over trade.
Also I'm finding that if I want to put in a speech that is over 85 characters long SpeakinSpell won't allow it. Is there a way to increase the speech length? Ihave some wordy ones. mostly Portal and polymorph messages, but still.