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...
It is really great to have this addon back. I'd missed it. Thank you for fixing the social interface issue.
I noticed that the mount emote doesn't seem to currently function. I mount and I simply mount, no reaction of the mount actually popping up. Could this be addressed at some point? Thank you.
I really love this addon but this addon at times eithier you enable or disable it at times doesnt matter as it will say random things and piss off your raid i have been kicked x2 because of this now and its annoying as hell please fix this bug i really love it and hate to have to disble it in my addons till a hotfix but if i have no choice sux please look into this
Please clarify how are you disabling SpeakinSpell when it speaks even though it's supposed to be disabled? Are you clicking the minimap button to disable SS, but it speaks even though the whole addon is supposed to be disabled? Or are you setting specific events to be silent in raids, but they speak anyway?
Thanks for the recent bug reports. I have a newborn baby taking my attention at the moment, but when things settle down here IRL, I hope to find some time to debug the issues :)
I'm getting an error when I have a message set to 'use instance if available', giving the old 'You aren't in a party' error. It's been going on since 6.0 came out so something broke it at that point.
Thanks for this bug report. I'm tracking it in ticket 190
http://www.wowace.com/addons/speakinspell/tickets/190-wow-6-x-use-instance-if-available-not-working/
There's currently no event trigger to detect when a guild member comes online. The feature request is tracked in ticket 165. Please go vote for it :)
http://www.wowace.com/addons/speakinspell/tickets/165-guild-member-comes-online-greeting/
So to get a greeting for guild members when they come online i'd wait for someone to come online then
/ss recent
then find that event? Or is that event already built in?
Unless you use party chat or the like you can't make a speach like this, as WoW itself disallows use of /say when you die.
I'm trying to find away to make a "death speech". As in, when I die, it posts a cute little thing about dying.
I've looked through everything, and not sure how to do this, if the addon even can do it.
IIRC, there is a death event called "I died" currently supported by SS, however as noted, Blizzard won't let you use /say while you're dead, so those speeches only work in party, raid, or self-chat.
Along these lines, there is a feature request to announce low health (and low mana) tracked in ticket 134. If this feature were implemented, you could announce when you're _almost_ dead, at which point you can still use /say. Some of the details need to be worked out. Please use the following link to vote for the feature and contribute to the discussion of how the details should work
http://www.wowace.com/addons/speakinspell/tickets/134-low-health-and-mana/
I noticed that the <target> command isn't working correctly with hyphenated NPC names; for example the Shao-Tien Dominators. When it fires off the target name it simply says "Shao", ending at the hyphen.
Thanks for the bug report. This is tracked in ticket 191
http://www.wowace.com/addons/speakinspell/tickets/191-npcs-with-hyphenated-target-names/
Great news everyone! WoW patch 6.1 allows me starter access using my inactive account. I can now login to the game again to do some limited debugging!
Seems to be mostly working with WoW 6.1.
Sorry I'm a noob with the game now after a long hiatus. What's this new Social UI? How do I make it trigger an error with SpeakinSpell so I can see what you mean? I can get into the game with limited access to poke around to see if I can figure out the problem but it would help if you could provide more details please.
Sadly I've had to take SpeakinSpell out because it was causing errors with the new SocialUI. Would appreciate any kind of fix for that ASAP as I really appreciate your addon, even if some things like mounting don't work like they used to.
Is there any way I can take off the pre-speeches already there? I don't like that when I do a killing blow I have my stuff there and they say what's already there too lol. Great addon I love it!
If I understand you correctly, when you land a killing blow, you're getting 2 speeches at the same time? It sounds like you may have 2 slightly different events firing at the same time.
Here's what I suggest for the easiest way to tune up your SpeakinSpell settings in cases like that.
1. After you see a speech that you don't want, type "/ss recent"
2. SS will print a report to your chat window listing the last 5 speeches that it announced, and what event triggered it to say each speech.
Note: If the same event for a killing blow is firing twice for a single kill, then please let us know there's a bug with this event trigger. The work-around to prevent it saying 2 speeches for the same event in the case of a bug like this is to put a cooldown of 1 or 2 seconds on that event trigger in SS, to silence the second one when it fires a second time due to a bug. A cooldown like that is probably a good idea for killing blows anyway so you don't announce every death when you kill a swarm of stuff with AoE.
3. The report of recent SS announcements includes [clickable links] in brackets like when you link an item into chat. Click the links for the speech you want to delete. It should open the SS settings window for that event trigger, which includes the list of speeches as well as many other options.
4. If you want to delete that whole trigger, and all of its related speeches, press the button for "delete this event". If you want to keep the event trigger, but remove just one speech, scroll down to find the speech in the list and press the "delete" button next to the individual speech you want to delete.
Many other options are also possible in the same window of you want to change how often a speech is said based on a random chance or cooldown, silence it in raids and battlegrounds, etc.
Hey, love the addon! ...one thing I'm not understanding though. I've set some custom messages for the "mount up" event, but they never trigger (and I've got it set to 100% of the time). What am I doing wrong? (All other events seem to trigger stuff just fine).
EDIT: It's not working when I summon a pet either, actually. The pet messages only trigger when a pet is indirectly summoned--ie, I've taken a gryphon and landed and the pet is re-summoned upon landing. If anyone is able to get this to work I'd appreciate a step-by-step of what exactly I need to do (perhaps I'm not summoning pets and mounts correctly? Generally I go into the mounts / pets tab, select one, and hit "summon.")
Sounds like it's not working anymore. Is anyone else having trouble with the "Summon Mount" event?