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...
Hello there, (firstly LOVE this addon amazing work much appreciated!)
Secondly, i'm having some trouble. According to your info here, this thing is supposed to save its files in users/public/world of warcraft...etc however, in my Public folder, there are NO games folders or anything like that. There is a said folder in the admin area, however, it hasnt got wow in it under games...
i recently transferred a character from one faction/server to another and lost all her SIS data... and i'm really hoping it's not lost and it's just a matter of finding it and renaming something...(character name didnt change)
The info is obviously being saved somewhere as it does work, and things are fine on my other characters that i have not moved. Would you please help?
The file with all the quotes is located in World of Warcraft/WTF/Account/<Your Account Name>/SavedVariables
If you don't have World of Warcraft under users/public, then it has to be somewhere.
Search for a file called WoW.exe or WoW64.exe. Where that is is where World of Warcraft is.
I don't recall what happens during a race (faction) change if the name stays the same. I've never done that.
One thing you should be careful of is that there is a bug in WoW which will sometimes erase your addon data. This will force SpeakNSpell to reset itself to default. So backup your SpeakNSpell data every once in a while. Especially if you make changes to your speeches, add new ones, and the like.
You can handle this scenario of character transfers using "/ss import" which allows you to import settings from one of your alts to another.
"/ss import" also lets you import optional built-in content packs, and SpeakinSpell content that you've collected from your friends using "/ss sync".
Thank you so much for this addon. I'm warped and very random and this addon helps me to fly my Crazy Flag. (I'd totally donate if I wasn't addicted to Starbucks and World of Warcraft)
Thanks!
How do I delete a character from SpeakNSpell? Like a character I don't use anymore. I'd like to delete her so the file isn't as large.
That's a good idea for a feature, so I created a ticket to track this idea here:
https://www.wowace.com/projects/speakinspell/issues/2346
Unfortunately, the only way to do this currently would be to edit your saved variables file manually in notepad or some other text editor.
1. Go to c:\users\public\World of Warcraft\WTF\Account\{your name}\SavedVariables\SpeakinSpell.lua
2. Make a backup copy of the file, in case something goes wrong
3. You should see all of your characters listed like this
Delete outdated info as desired. Be warned that if you leave a mismatched bracket {} or extra or missing comma, then WoW won't be able to load the file anymore, and SpeakinSpell will return to default settings.
I'm pleased to announce a new release on the way. Big thanks to Bazor and Harmoniii for making this happen!
--------------
7.2.1.01
--------------
Compatible with WoW patch 7.2.1
Added support for the Demon Hunter language and the Arcane Languages buff.
I bow to you for the work you put into this awesome addon!
Thanks, man. (This is Bazor btw). It took a while to get something out, but we finally got there. :D A big thanks to Harmoniii for spotting a particularity in WoW's coding that really set the foundation for this new version. Expect more to come in the future. This project is far from being dead. ;)
It's cool if that was usefull so.
I made changement for my own utility at first^^'
PS : Errr... it's "Hermoni" but no prob xD
Is there anyone you can give the addon to since you don't play WoW anymore? It still seems to be fairly popular.
I would be very happy to work with anyone who wants to jump in and help out. There have been a few volunteers who have helped out over the last couple of years, but unfortunately none of them are actively participating in the project anymore. Send me a PM if you're interested and I'd be happy to chat with you about how the code works, or how to use SVN, etc.
Meanwhile, I use a free account to login and fix any obvious bugs to make sure it still loads and runs. Sorry it took me so long to put up a TOC update for 7.1.0. I'm usually a bit faster than 6 months :(
All the other bugs and feature requests that I haven't had time to implement are tracked here. I continue to watch for bug reports and add them to the issue tracker. Anyone who wants to volunteer is welcome to dive in and implement any of those bug fixes or feature ideas, or any other change you feel like contributing, and I'd be happy to talk with you about it and provide any help that I can. :)
Someday I also hope to return to WoW, but I have too much toddler in my life at the moment, so maybe in a couple more years or so...
SS v7.1.0.02 should show up here on curse as soon as it passes moderator review. It used to be automatic, but apparently there's a moderator review process now, and I'm not sure how long that usually takes. Meanwhile, you might be able to get it here:
https://www.wowace.com/projects/speakinspell/files
This is just a TOC update to WoW 7.1.0 so the game won't show it as out of date. There are no new features or bug fixes, other than to update the external libraries. I tested it briefly and it seems to be working fine, but I don't actively play WoW anymore, so I'm not giving it the thorough play testing that I used to give it back in the day. If you run into any bugs, please speak up, and I'll see what I can do.
The Replacers aren't working correctly - what do I need to do to fix this?
I've been replacing <target> with %t, but I don't know how to fix ones like <subzone> or <target^him^her> for example.
Hmm that's strange. It seems to be working fine for me.
There's a new update that should show up on the site here soon. I didn't fix anything in the code, but I did update the libraries so that might help, and I updated the TOC version so WoW won't think SpeakinSpell is out of date anymore.
I tested <target> and <subzone> substitutions with one spell (Disengage) a macro (/ss macro test) and the built-in feature that tests all substitutions (/ss testallsubs) and all of the substitutions seem to be working normally.
"Main Features:
How do I make it so this addon will greet people in guild chat when they come online and login?
That feature doesn't exist yet.
https://www.wowace.com/projects/speakinspell/issues/165
Edit: the "Login" event is currently only for when you login, not when anyone else logs in.
Any word?