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'm trying to get the add-on to say "Welcome back, " then my guildie's name. I usually type this manually, and link to the yellow font in the chat that says something like [Keedor] is online. Not entirely sure how to make a custom emote. The best I can do is make a "/ss macro welcome" that when I type that it says "Welcome back, <target>/<guild>/<castor>. Please someone help!
any chance of fixing the congratulating myself in guild chat?
Any chance of adding a delay? Just something I could toggle so it waits 5 or 10 seconds after something is done to react. Not as usefull on spell casts, but on the auto congrats and reacting to other events.
I don't know if this still works because I've been out of the loop for a long time, but there's another addon called SlashIn which lets you write a speech for SpeakinSpell like "/in 5 /g congrats!" and that would do what you you're looking for.
<target> : how to obtain only the NAME of the target and NOT HIS REALM ?
Thank you for this amezing addon
I have a little problem with Speakinspell when i open my spellbook i have an extra button on most spells that says SS is there any chance that you can disable that? yes it's belong to Speakinspell when i press on a SS button it direct me to Speakinspell and create new speech
i don't mean to offend you but that extra button bothers me and it makes it harder for me to check my spellbook
but i really like your addon so keep up the good work :-)
How do you create a chat event?
I looked at the guide, as well as tried to "create new", and it was just blank.
I wish to be able to automatically respond to phrases people say in guild chat.
Thank you!
No idea why, but I was able to make one macro for my tigereye brew, and it worked perfectly, after that, it refused to find any skill I tried to look up :(
mmmm... under the search menu, there is the place where you type in a search key word... make sure that is clear if you're looking for any and all other events.
We've found out what was causing players to congratulate themselves in guild chat and fixed it. We're also coming up with default events such as "Achievements earned by: Me" in which when you get an achievement you either cheer or say something random like, "Oh wow! Awesome!" in a /say message.
We'll most likely be releasing this update to fix the guild achievement event soon, before then we're looking to see if there are any additional bugs that need to be squished. Let us know if anything stands out in your mind. Any errors or crashes associated with SpeakinSpell, post it in here and we'll see what we can do to fix 'em.
Thanks to everyone for the feedback and for using Speakinspell!
Hey guys. New release is up 5.4.7.00 - Just a heads up I did some more testing as far as the Achievements messages go. Turns out there is a bit of a thing going on when you earn an achievement - if you are in a guild and you get an achievement, you send out a grats message to yourself in the guild chat. For example, let's say your name is John and you earn the achievement Explore Durotar, and your S&S has the event set up under the category Achievements, and the event is "A Guild Member"... if you are in a guild and you earn an achievement, it will proc a speech, "Grats John!" So in a sense, if you get an achievement, you'll be congratulating yourself.
If another guild member earns an achievement, it works fine, but unfortunately the addon recognizes you as a guild member as well and you'll see the event proc when you earn an achievement while in guild.
Another bug I've been seeing is also related to when you earn an achievement. Another event under the Achievements category is "Someone Nearby," which means, say you're at a mailbox in a city and someone next to you gets an achievement for getting the collector's edition of the next expansion. If you have this event set up, then it will trigger "/congrats <caster>". Unfortunately, when YOU earn an achievement, the addon will consider you to be someone nearby as well, so it will most likely trigger "/congrats <caster>" and since the caster is yourself, the message will then appear as "You congratulate everyone around you." Imagine you reach 450 in mining or 600 in herbalism and you congratulate everyone around you when this procs?
Fortunately, I found a way to remedy this situation. If you go to Create New in your S&S, and you set the category to Achievements, you'll most likely find a new event to create, "Me". Select that and press create new, then make and edit the speeches accordingly. For example, just to test it out, put "/cheer" as one of the speeches to proc when you earn an achievment. Then go out and earn an achievement and when you earn it, it should only proc the event "Me" instead of "Someone Nearby". The addon will know the difference in this situation.
Some ideas for Achievements earned by: "Me" could be things like, "/cheer", "Oh wow, I got an achieve! Yahoo!", "Ohhh, I didn't know about this achievement! Cool!", "Wha--- oh, neat! Wonder if I get a title from this..." Still, if you want to test just to make sure it works, use "/cheer" for the Me event, and then the "/congrats <caster>" for the Someone Nearby event.
Unfortunately, if you earn an achievement, it will still grats yourself in guild, and the addon is having some trouble discerning between when You earn the achievement or Someone Nearby... We are aware of these issues and will come up with a fix soon. As for the events when someone near you earns something or you get one yourself, Double check your settings and see if you can create the event necessary.
If you notice any other odd things happening or bugs or whatnot, post it here and we'll look into it! :)
>> Unfortunately, if you earn an achievement, it will still grats yourself in guild, and the addon is having some trouble discerning between when You earn the achievement or Someone Nearby... We are aware of these issues and will come up with a fix soon.
Hi there - thanks for maintaining SS in my absence - I don't want to step on your toes, but I could swear I wrote logic to fix that problem once upon a time, let me just check around here for a second, and... yeah I found it in wowevents.lua, line 1345, where we handle the Blizzard event CHAT_MSG_ACHIEVEMENT take a look at this code...
From what I've heard about the changes to the game since I stopped playing, EarnedBy probably contains the player's server name these days, but UnitName("player") doesn't, so they're never equal, so this logic isn't working as intended anymore (or maybe some variation on that general idea) which is why SS is treating you as a member of your own guild and person near yourself with respect to achievements.
We can see the same thing on line 1373 in the Blizzard event CHAT_MSG_GUILD_ACHIEVEMENT:
function SpeakinSpell:CHAT_MSG_GUILD_ACHIEVEMENT(event, ChatMessage, EarnedBy, ...)
if EarnedBy == UnitName("player") then -- don't congratulate myself (we DO get this message for our own achievements)
return
end
You need to simply fix this condition...
...to make it work with the current Blizzard API for what it sends you for 'EarnedBy' vs. what it returns for UnitName("player") so it compares them properly. I'm not sure what is the best way to do that with the current Blizzard API, maybe something like...
if EarnedBy == (UnitName("player") + "*" + GetRealmName()) then
Already done. It was the exact problem that Groguz identified. He and I tested it and it looks good. If there are any other bugs that need fixing let us know.
Hey Glad your having look and staying in the loop. Gradually we are getting the addon up to date with all the changes. The latest fix for the Acheivments is the only one we have found so far that is related to connected realms. The rest of the fixes should be just updates to the default speeches for new classes and or factions. Your input is always expected and welcome. We are happy to maintain the code base!
I'm hoping new features are in the works. =)
As a roleplaying addon I feel that names should have their server taken off so isntead of playername-servername it's just playername. And also having an option to fire quotes every x amount of seconds/minutes so when we're just travelling it'd say something or not have our quotes tied to casts and events.
> And also having an option to fire quotes
> every x amount of seconds/minutes so when we're just travelling
That could get annoying. And if you wanted some peace and quiet, you'd have to go to the trouble of deactivating it.
If you want something like that, better to have it tied to a keybind. That way you can fire off a quip when you wanted to and not say anything when you didn't
im still "congratulating" myself when i my achievement in guild shows up... *confused*
I'm helping out by coming up with new templates for Goblin, Worgen, Pandaren, and monks; events such as entering combat or talking to vendors. Hoping to have this implemented in the next release. I'm also coming out with ideas for new general spells to be found under the import section of the addon.
Hopefully more features added that'll give us better control of our quotes such as an option to cycle through all of the quotes rather than randomly picking one gives the chances of saying the same quote 2 or 3 times in a row which may be annoying...
the answer is yes. it is being fixed and updated. New release will be comming soon!