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...
just un-check that, and you're golden =)
----
TLDR answer:
1) /ss messages
2) type "rez" in the search box and hit enter
3) below that, select the event "When I type: /ss macro rez" (it should select by default)
4) scroll way down and look for the speech you want to delete, and click on Delete.
In the current version 3.2.2.10, the speech in question is Random Speech 64 in the default settings - the very last one at the very bottom of the screen.
----
More complete instructions with explanation...
For the sake of clarity, please note the following 2 subtle details:
A) SpeakinSpell is not whispering to people "when they die" ... it's whispering to them when you cast the spell to resurrect them. There is an important difference there.
B) Depending what class you play, your resurrection spell has a different name. Paladins cast "Redemption" but Druids cast "Revive" and priests and shamans call their rez spells something else too.
OK, now that you're thinking about the game in my terms, I'll describe this as if you're a paladin.
1) Type in "/ss messages" to open the Message Settings window
2) At the top of the window, type in part of your rez spell name, "redemption" and hit enter.
It will search for all events with "redemption" in the name that you have set up for announcements.
3) Select the event "When I start casting: Redemption" (it's probably the only one)
The area below that drop-down list allows you to change all of the settings for when/how/what to announce "When I start casting: Redemption"
4) Scroll down to the area labeled "What To Say? When I cast: Redemption" and you will see a list of speeches.
You can scroll down through the list of speeches until you find the one about idiot failure, and you can edit or delete that speech.
If you are a very new SpeakinSpell user just starting with us in the most recent version, or since a pretty recent version about 3.2.2.08 or so, perhaps it is not obvious why you only see one speech listed here that says "/ss macro rez"
What is this? Where are all the speeches like this one I want to delete about the idiot failure?
----
Near "Random Speech 1" where it says "/ss macro rez" you will see 2 buttons: "Edit Macro Event" and "Import Macro's List".
If you click on "Edit Macro Event" it will select the event "When I type: /ss macro rez" in the drop-down list above so you'll be looking at "What to Say? When I type: /ss macro rez" ... and you will see the list of speeches in front of you so you can edit them, and thus delete the "idiot" speech that you don't like.
If you click on "Import Macro's List" it will COPY all of the speeches from the event "When I type: /ss macro rez" INTO the event "When I cast: Redemption" and you'll still be looking at "What to Say? When I start casting: Redemption" ... and you will see the list of speeches in front of you so you can edit them, and thus delete the "idiot" speech that you don't like.
Which button you press determines where the data lives after this, if you want to keep it in the list for "When I type: /ss macro rez" and trigger that when you cast Redemption ... vs. if you want to stop using the "/ss macro rez" thing, and just maintain your speech list directly under the event for when you cast Redemption.
----
To reiterate...
1) "When I start casting: Redemption"...
2) I have SpeakinSpell set up to say "/ss macro rez" which it sends into the chat
3) "When I type: /ss macro rez"
4) I have SpeakinSpell set up to say a random thing from a big long list, one of which is "Well, well, well... It looks like <target> has suffered an 1D10T failure..."
It's set up this way "out of the box" for rez spells, mounts, and pets, in order to share the same speech lists between many different events (for example all different class' rez spells, or 50+ different mount summoning spells).
----
TIP (Read-Only) There are 63 other speeches you might or might not like. The Read-Only checkboxes are a nice way to keep track of which speeches you've "approved" vs. those you haven't read yet. You can also uncheck the box for "Show read-only speeches" to completely hide all the speeches you marked read-only because you like them.
TIP (Exit Combat) There is another speech you might be talking about where it says "Ahhh..... another 1D10T malfunction..." which is provided for you in an optional content pack called "Dire Lemming's Enter/Exit Combat" which you would only be using if you had previously gone to Import New Data (/ss import) to add that event announcement. This speech is an Exit Combat speech that I did not enable by default in the "out of the box" experience for SpeakinSpell, but it is provided for you there under Import New Data. Please note that it doesn't exactly announce when someone in your group dies ... it announces when you exit combat ... that could occur at the same time, but it's not really the same thing. Those exit combat speeches are all written with the assumption that you lived / won the fight, i.e. vs. a raid boss.
----
If you have any ideas for how to make all this more intuitive, please submit a ticket for a feature request over on my tickets page: http://www.wowace.com/addons/speakinspell/tickets/
I'm considering a variety of options for dealing with that RNG issue in a future version.
I was aware it would cause this result but hoping nobody would notice LOL. I am continuing to ponder the issue.
One thing you can do as a work-around for the short-term is add a blank line. "/ss macro something<newline>" will not be expanded in-line like that and will use the previous behavior of multiple-RNG and using the channel and frequency options from the "/ss macro something" event instead of the calling event. I did that to preserve behavior of "/ss macro A<newline>/ss macro B" where macros A and B have different settings.
With BattleCry, each of the possibilities for a triggering event had a weighting option (a number between 1 and 10) which was effectively how many times that possibility was added to the list when populating valid choices for the RNG. This process was limited by each also having its own conditions and options, such as "Target name = X" or "Zone = Y".
If you could include a similar methodology, the user could weight a common list higher to compensate for it being only one of many possibilities. If, for instance, you have 20 things that could be said for any mount at all, and 10 just for the Dreadsteed, then in "when I finish casting Dreadsteed" the normal weight would give each of the Dreadsteed's specific possibilities a 1/11 chance, and each of the shared a 1/220 chance. If, instead, you could weight the possibility that read "/ss macro mounting shared list" to 20x as heavy as the others, then everything you could say on summoning the Dreadsteed has the same 1/30 chance.
if we have something set to /em, AND to whisper the target, it shows up as:
Topiary rustles her leaves in alarm as Elden's health begins to fall! She covers Elden in sap and sheds leaves in an effort to HEAL!!!
then the person who get the whisper gets this:
To [Elden]: "rustles her leaves in alarm as Elden's health begins to fall! She covers Elden in sap and sheds leaves in an effort to HEAL!!!"
there a ways to, with whispers, make it come out like this:
To [Elden]: "*rustles her leaves in alarm as <you|your> health begins to fall! She covers <you|your> in sap and sheds leaves in an effort to HEAL!!!*"
where the difference between <target's> and <target> yields "your" or "you", and the asterisks (or whatever you use for emotes like *hug* and *cry* and *cpvers you in sap and leafs* pop up around?
maybe its just me being strange, or on an RP server..... but it just makes it more umm.. finished? instead of fragmented?
I have an idea for a simple impovement in this area, but leaving my rambling brainstorming out of this post...
here's a thought for what you can do today within the existing feature set of SpeakinSpell: Make a 2-line speech.
1) Select the "say" channel instead of "emote" channel. Any non-silent selection will have the same effect, the actual channel option you select is going to be overriden by the speech, but it has to be a non-silent selection or I'll think it's disabled in the current scenario.
2) Disable the whisper target feature - you're going to write the "/t <target>" into your speech
3) Then type a 2-line speech to do both the whisper and /emote in slash commands:
/e rustles her leaves in alarm as Elden's health begins to fall! She covers Elden in sap and sheds leaves in an effort to HEAL!!!
/t <target> * I rustle my leaves in alarm as your health begins to fall! I cover you in sap and shed leaves in an effort to HEAL!!! *
This approach would give you the most control and allow you to get the most correct grammar and RP-style spoken action with stars and more fluid sounding ... * I rustle my leaves at you *
And considering I have no idea what spell you're using this for - it's not obvious from what you would whisper to me when you cast it - you could add a third line...
/t <target> ((OOC)) <spelllink> slow cast time heal incoming!
annnd... before you kill me for the bad druid puns, <target> works the same as the whisper target function? sweet. the ways to confuse the people i'm healing are forming. thank you! this gives me sooo much more control. i might hafta add that to other spells >.>
i love the new modifications and options being added, by the way. i think well over half my guild now uses your mod =)
Channel = Emote
Whisper Target = true
Speech 1 = "makes strange gestures"
emotes:
Stonarius makes strange gestures
Whispers:
To [Direlemming]: * Stonarius makes strange gestures *
Woot!!
>> Downloads Total: 20,377
Woot x 20k!!! ZOMG I'm throwing a party! :)
*dives into altering all of her speeches*
It also makes the new multi-line edit boxes optional, so you can go back to the old single-line edit boxes if you prefer them, or if they bug out for you.