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...
For example none of the combat events aside from entering and exiting combat seem to work. There's also quite a few spells missing for options, mostly Hunter abilities from what I've seen. Perhaps I've overlooked it, but I can't seem to find an event for casting Explosive Shot, yet theres an option for an event for when I'm struck by Explosive Shot.
Again, good work on this addon, but sadly this doesn't seem to work for me.
Not sure about the other combat events. I've run into a bug from Blzzard ever since 3.3 came out that every once in a while my combat log stops working completely, which makes many of my addons fail. I don't think that's a SpeakinSpell bug, but it would cause SS to fail (as well as Recount and a lot of other addons that I use)
but it also explains somethin i was wondering about. =D
(Some events are listed in german within the SS-Database, though, but most are in english.)
Even though many parts of the German version are not yet translated into German, the elements which show up in English should still function correctly (and you can write your own random speeches in German so the untranslated English parts of SS are only seen by you).
In practice:
You just said that's not how it really works. Darn it! Sorry...
I am going to have to investigate what it takes to get my hands on the German version of the WoW game client so I can look into issues like what you're reporting here. Until then, my ability to support the German and Korean versions of SS is very limited (to theoretical, untested code)
I am also beginning an effort to revise the localization files for compatibility with the wowace translation system, so that volunteers can more easily contribute to the translation effort. I'll post more on this later once it's up and runing.
Great roleplay addon, searched for this for ages!!
I think that's a great idea, and I've experimented with some work-arounds, but the work-arounds don't really do it for me either, so I agree this would be nice to have. I need to investigate how to auto-detect the going AFK event.
The only possible approach at this time (SS 3.3.0.06) is to use a custom macro event "/ss macro afk" which you can use to leverage SS into announcing that you're going AFK. The limitation is that you have to click your button for this (or type it) to announce that you're going AFK, since it's not auto-detecting that you went AFK 10 minutes ago and timed-out into AFK status.
You can also combine this with the game command "/afk" to set your AFK flag in two possible ways, either as a macro (/m) that does both:
/afk
/ss macro afk
or you can make SS do "/afk" for you in the random speech for "/ss macro AFK" like this...
When I type: /ss macro afk
Random speech 1: I'm going AFK, brb<newline>/afk
(you can write it on 2 lines instead of using <newline>)
The tricky part of this that I really don't like is that /afk works as a toggle, so if my AFK flag is already on, and I'm trying to use SS to randomize my AFK message in "/afk my custom message" then that can turn off my AFK flag instead of changing the message. Some fancier AFK status detection and related features would be nice in SS.
I personally want these features for setting up an auto-afk function to let my guildies know I'm 80% alt-tabbed working on SpeakinSpell development, but I can imagine plenty of other good applications.
Is there a way to turn off/delete all the default speeches?
I also double-checked the logic of which takes precedence when you check the box for "Whisper to my <target>" and select the Silent channel at the same time... and it's silent... so i was wrong in my last paragraph of my previous post. To make it whisper to someone without also saying something out loud, you have to write the "/t name" into the Random Speech itself and select a non-silent channel (and the name can be any substitution such as <target> <focus> <selected> or <caster>)
:X The cross-realm dungeon groups are something I frequent almost nonstop nowadays, it looks like I need to figure out how to rework my macro if I want to use this addon for that spell.
/run SendChatMessage("Trick of the Trade on you!", "WHISPER", nil, UnitName("focus"))
Which is really messy and doesn't really want to work with the addon, since no /w <focus> of any kind seems to work. :/
That /run command is basically what SpeakinSpell does in the LUA code, but with a GUI wrapped around it. If a SpeakinSpell speech starts with "/" then instead of sending it through SendChatMessage, SS opens an invisible chat entry box and sends the text to the game engine as if you hit Enter and typed it manually (in order to make the game engine execute the slash command).
If we're talking about a speech generated by SpeakinSpell then "/t <focus> trick of the trade on you" should work. It will substitute your focus' name, ex. Stonarius, before sending it to the chat, so it becomes "/t Stonarius trick of the trade on you" before it goes to the game engine, so it should work. /w should also work the same way, it makes no difference, i just personally tend to use /t instead.
If you're saying that doesn't work, I'll have to double-check that it works for me.
Obviously (maybe not so obvious?) if you hit enter and manually type in "/t <focus> tricks of the trade on you" then SS isn't doing anything with that to substitute a name for <focus> ... that only works in a Random Speech that is said by SpeakinSpell.
Note if it's a X-realm player, the game engine fails on "/t Stonarius-Antonidas trick of the trade on you" and will say there's no player named Stonarius. I'm holding out for Blizzard to fix that.
Also, since you're whispering to the target of tricks of the trade, "/t <target> trick of the trade on you!" should also work, and so should the checkbox in the GUI to "[X] whisper to your <target>" (then you can leave out the "/t <target>" part of your speech and let SpeakinSpell deal with it via the checkbox option)
In all cases in SpeakinSpell, your <target> is the target OF THE SPELL, not necessarily your selected target. So if you're casting a spell on your focus, your <focus> is your <target> and both substitutions mean the same thing in that context.
Aside for added detail: a warrior once asked me why <target> didn't work when he cast Shield Wall, and I told him its because the target of shield wall is him, the <player>. So that seems to be a common misconception. <target> in SpeakinSpell is a smart value meaning the actual real target of the spell, not directly equivalent to UnitName("target") which is your selected target, which isn't necessarily the target of your spell.
If you want to specify your SELECTED TARGET, which is not necessarily the target of your spell, then you can use <selected> instead of <target> or <focus>. <selected> is equal to UnitName("target") and may not be the target of your spell, if you're focus casting or using macros or other addons to cast your spells, so <selected> will always be the name of the target you have selected. There's a chapter on this topic in the in-game help because there are a lot of different ways to target and cast spells in WoW.
Note also that to make SpeakinSpell work for this purpose, you also have to select a non-silent channel for your scenario, ex. "In a Raid", or I'll think you want SS to shut up when you're in a raid. So pick the "say" channel or something, even though you don't actually want it to use the say channel, because the "/t <focus>" at the start of a speech (random speech 1 or whatever) will override that.
The checkbox to "[X] Whisper to my <target>" is independant of the selected channel, so if you select the "silent" channel and check the box for "Whisper to my <target>" then it will still whisper in all scenarios.
I started thinking that it would be brilliant to configure it for different characters so that it would help me in other things, like my responsibilities as a guild leader, ect.
I suppose what I'm going to say is a combination of suggestions/questions/problems I've run into:
Is there a way to have speakinspell whisper your focus, instead of your target? I keep my tricks of the trade target focus'd for my tott macro to work.
Lack of a guildchat output :X Gratsing a guildmate on an achievement in battleground chat is silly.
On another note I really like this addon and would like to make it a core part of my game experience on all characters.