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...
The problem is that the French spell names are different from the English. So the default settings are in English but those spells are never cast, because you cast those spells by a different name in French...
Je parles un peux de Franglais, mais pas enough a faire le complete good translation... c'est le Franglais, pas le Francais lol... je suis etudiant qui parle le franglais a quatre ans a l'ecole...
Follow these steps to make it work in French
1) type "/ss messages" to open the SpeakinSpell Message Settings window
2) click on the delete or remove button to remove all of the default settings, which will not work in the French game client
3) click OK to close the window
4) Play the game for a little bit. Cast any spells, proc any effects, or encounter any events that you want SpeakinSpell to announce. This will make them appear in the list in the next step.
5) type "/ss create" to open the SpeakinSpell Create New window
6) select a spell or other event from the list.
- It will show as a mix of French and English, like "When I cast: Aveugle" ... assuming here that Aveugle is the French word for the Rogue spell, Blind. Adornment text like "When I cast" will still be in English, but the names of your spells will show up in your native French.
7) Select the desired spell or event, and click Create - this will take you to the settings for that event.
8) Write your own speeches in French for the event.
9) Click OK
Now it should be detected and announce as expected in the chat. I hope that made sense.
With an special command like </n> to create a new line?
In the mean time, you can work around it by editing the SavedVariables files. Your SpeakinSpell settings are all saved under ...\World of Warcraft\WTF\Account\[your account name]\[Realm]\[Character]\SavedVariables\SpeakinSpell.lua. Those .lua files are text files. You can open it in notepad or your favorite text editor and copy-paste from one character's file to the other.
Be warned that these saved variables files are processed as LUA programming code, so if you mess up the syntax while copy-pasting (such as a missing comma or an extra bracket) then you'll get errors when you login or reloadui in game, and WoW will revert your saved settings to the contents of the SpeakinSpell.lua.bak file.
I would like to have the ability to transfer messages between characters without having to manualy type them for each one
Thanks
Thanks for your feedback as always Folji. You're a fountain of good ideas. I agree we could use some better filters and/or search capabilities under Create New, and it would also be nice to have additional event types for spell cast success, failure, hit, miss, crit.
I've been using this AddOn for a while now (thanks for adding the possibility to have different message for the same ability output to different channels, by the way), and I'd very much like to see the possibility to remove events from the "Create New..." list, as well as an option to filter out things that just seem to clutter it up (like different ranks of the same ability (only time(s) I've used that was for the mage conjure spells), things you just know you won't do anything with, tradeskill crafting, etc.).
EDIT: Oh, and it would also be kind of neat if there was a way for the AddOn to detect when a spell or ability successfully hit (to add on to when the character begins casting them).
Hello SpeakinSpell User Community!
First of all I want to excuse myself for the, certainly sometimes bad or wrong expressed English while I’ am typing her and trying to translate German words from my brain in English words here in the comment (My specialty is the other direction!)
But now it is 4 o'clock in the morning and I’ am very tired after working for some Hours at the completely German localization.
So please take regard!
I’ am the free (and of course evil, because I’ am German! :-P) German Translator for this ingeniously and useful Add on, who wants to take over the world! Hm, no, not good - Ok let us better disregard this last part of the sentence..
Joking apart.
It is an honor for me to work on such a Project like SpeakinSpell under the Leadership and/or Management of Riz because Riz is one of the most patiently and friendly Add on Developer I worked with in my Lifetime as WoW Add on Translator.
And believe me; I have translated already several Add ons for several Developer and Writer.
When you work within the code of an Add on, when you listen to an Author while he tries to explain certain functions for you, when there are problems with the localization, when you see all the additional notes in the code to avoid chaos nobody will ever recognize except a few people who work with the code then you truly understand how much time, trouble, effort and damn heart blood an Author like Riz have pushed in his Project.
Riz always took his time to explain everything, every little and stupid question of mine so often until I understand the function or the sense of it.
This is the most important reason I will always continue working on SpeakinSpell together with a man who become with every further Conversation of us my new and only Amigo from America! ;)
Do never pay a single thought on stopping to develop this terrific Project furthermore Riz!
(Ok, let me pray to god that I didn't brought shame to you with my little speech or my bad English *g*)
By the Way
I have nearly finished the completely and fixed German localization Riz.
There are only 2 Chapter missing in the User’s Manual!
It is Important that we both can talk in Skype because I have some open questions and I haven't seen you in Skype for a while!
leX
BTW on a side note, you can use /flex instead of /me flexes. That's the latest new feature.
I have a feature request, however: Is it possible to have my Random Speech to do two or more things at once?
For example:
I receive Heroism.
Random Speech 1
/me flexes
/y ROAOOOOOAR!!
Random Speech 2
/me goes haywire
/y Today is a good day to die!
Random Speech 3
/me taunts
/y Bring it!!
Random Speech 1
/flex[newline]/y ROAOOOOOAR!!
Random Speech 2
/me goes haywire[newline]/y Today is a good day to die!
Random Speech 3
/me taunts[newline]/y Bring it!!
... and for even more flair, you could do...
Random Speech 4
/me taunts <target>[newline]/y Bring it, <randomtaunt>!!
Random Speech 4
/me taunts [target][newline]/y Bring it, [randomtaunt]!!
The only limitation is that you can't use secure commands like /cast and other commands that Blizzard designated as protected to prevent botting.
While I agree that most of the default speeches that I wrote are basically OOC for a true RP realm, those are only intended to serve as examples, rather than the speeches that you're stuck with as in most other similar addons, and I feel this addon itself is still a good fit for the RP category because of its functionality, not it's data (it should also show up under the Chat & Communication category). SpeakinSpell users are intended to change all the messages by writing their own ("/ss messages", then scroll down), and I assume that good role-players would have a lot of ideas along those lines.
That said, if you (anyone reading this) have ideas for more good speeches, I would be happy to include them as defaults in the addon if you share them with me by posting your SavedVariables\SpeakinSpell.lua file on the Tickets page for this project (or find any other way to send me that file).
On the development progress topic, I have completed work on a feature to support overriding the selected chat channel for a specific message, as well as built-in emotes like /roar and /cheer. I'm just writing up the help text now and the new version should be available for download in about an hour or so.
For any SpeakinSpell announced event, any message that you write that starts with a slash "/" will be fully processed, just as if you typed in that command into the chat manually. Due to limitations imposed by Blizzard, this can not be used for secure commands like /cast, but it can be used for anything else, including "/ss macro something" and other addon commands, chat channels including /g and /2 or anything else, whisper to a specific person with /t playername, built-in emotes like /roar, and probably other things I'm forgetting.
The previous release added a feature to announce 2 new additional events: entering and exiting combat. I found some good reference material to go by for adding more in the near future.
I have not yet started looking into LDB or a minimap button, but those are still on my list. Time is short unfortunately and I wish I could work on this 40 hours a week, but I'm lucky to find 4 hours a week...