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...
---------
3.2.2.05
---------
Messages GUI enhancements
- added option to show/hide groups of options
- added option to set read-only flags on each speech
- added delete and delete-all buttons
Fixed LUA errors
I'm having the same issue. On some of the spells (take Ritual of Refreshment on my mage for example) several of the input fields will be black & I wont be able to click on them, "random speech" fields 1-17, then random speech 18 has text which I can click & edit. Trying to create new speech events results in all black fields with no cursor, no text, & which cannot be edited. I disabled all my other addons on my mage & was still unable to make edits.
Date: 2009-09-24 13:12:13
ID: -1
Error occured in: Global
Count: 1
Message: ..\AddOns\SpeakinSpell\data.lua line 237:
attempt to concatenate field '?' (a nil value)
Debug:
(tail call): ?
(tail call): ?
(tail call): ?
SpeakinSpell\data.lua:237: FormatDisplayName()
SpeakinSpell\data.lua:47: InitDefaultSavedData()
SpeakinSpell\wowevents.lua:59: ?()
...Tom\libs\CallbackHandler-1.0\CallbackHandler-1.0.lua:146:
...Tom\libs\CallbackHandler-1.0\CallbackHandler-1.0.lua:146
[string "safecall Dispatcher[1]"]:4:
[string "safecall Dispatcher[1]"]:4
[C]: ?
[string "safecall Dispatcher[1]"]:13: ?()
...Tom\libs\CallbackHandler-1.0\CallbackHandler-1.0.lua:91: Fire()
...ace\AddOns\TomTom\libs\AceEvent-3.0\AceEvent-3.0.lua:119:
...ace\AddOns\TomTom\libs\AceEvent-3.0\AceEvent-3.0.lua:118
AddOns:
Swatter, v5.6.4424 (KangaII)
AckisRecipeList, v1.0 3.2 Beta 3 2463
Altoholic, v3.2.002
AtlasLoot, vv5.07.06
AtlasLootFu, vv5.07.06
AucAdvanced, v5.6.4424 (KangaII)
AucDb, v5.1.DEV.3583
AucFilterBasic, v5.6.4424 (KangaII)
AucFilterOutlier, v5.6.4424.2531
AucMatchUndercut, v5.6.4424.2531
AucStatClassic, v5.6.4424 (KangaII)
AucStatHistogram, v5.6.4424 (KangaII)
AucStatiLevel, v5.6.4424 (KangaII)
AucStatPurchased, v5.6.4424 (KangaII)
AucStatSales, v5.6.4424.2842
AucStatSimple, v5.6.4424 (KangaII)
AucStatStdDev, v5.6.4424 (KangaII)
AucStatWOWEcon, v5.6.4424.2530
AucUtilAHWindowControl, v5.6.4424.3311
AucUtilAppraiser, v5.6.4424.2530
AucUtilAskPrice, v5.6.4424.3175
AucUtilAutoMagic, v5.6.4424.3142
AucUtilCompactUI, v5.6.4424.2530
AucUtilEasyBuyout, v5.6.4424.3583
AucUtilFixAH, v5.6.4424 (KangaII)
AucUtilItemSuggest, v5.6.4424.3108
AucUtilPriceLevel, v5.6.4424.2545
AucUtilScanButton, v5.6.4424.2530
AucUtilScanFinish, v5.6.4424.2530
AucUtilScanProgress, v5.6.4424.2530
AucUtilSearchUI, v5.6.4424.3655
AucUtilSimpleAuction, v5.6.4424.0
AucUtilVendMarkup, v5.6.4424.2530
AutoRepair, v
Babylonian, v5.1.DEV.130
BeanCounter, v5.6.4424 (KangaII)
BrokerPortals, v1.7.9
Configator, v5.1.DEV.130
DataStore, v3.2.002
DataStoreAchievements, v3.2.002
DataStoreAuctions, v3.2.002
DataStoreCharacters, v3.2.002
DataStoreContainers, v3.2.002
DataStoreCrafts, v3.2.002
DataStoreCurrencies, v3.2.002
DataStoreInventory, v3.2.002
DataStoreMails, v3.2.002
DataStorePets, v3.2.002
DataStoreQuests, v3.2.002
DataStoreReputations, v3.2.002
DataStoreSkills, v3.2.002
DataStoreSpells, v3.2.002
DataStoreStats, v3.2.002
DataStoreTalents, v3.2.002
DBMCore, v
DebugLib, v5.1.DEV.130
Decursive, v2.4.3.1
Enchantrix, v5.6.4424 (KangaII)
EnchantrixBarker, v5.6.4424 (KangaII)
Gatherer, v3.1.14
KHunterTimers, v
Omen, v3.0.8
Panda, v3.2.0.23
QuestHelper, v1.1.17
RandomMount, v0.9.6
Recount, v
SellOMatic, vv1.1.15
SlideBar, v5.6.4424 (KangaII)
SpeakinSpell, v3.2.0.05
Stubby, v5.6.4424 (KangaII)
TomTom, vwowi:revision
ViperNotify, v1.3.7
BlizRuntimeLib_enUS v3.2.2.30200 <us>
(ck=898)
I did find some questionable/unsafe code near the areas described by this error log, so the next version 3.2.2.07 will have some safety checks in it which might help this issue ... but the main thing is that I think you just need to exit and restart the game ... although you probably already tried that, huh?
3.2.2.04
---------
GUI Touch-ups
Embedded LibBetterBlizzOptions for a better overall experience with the blizzard options frame
Enhanced data structures to support upcoming features
Fixed LUA errors
Date: 2009-09-25 01:02:34
ID: 1
Error occured in: Global
Count: 1
Message: ..\AddOns\SpeakinSpell\parser.lua line 84:
bad argument #1 to 'sub' (string expected, got nil)
Debug:
(tail call): ?
(tail call): ?
[C]: sub()
SpeakinSpell\parser.lua:84: ParseThirdPersonOrMe()
SpeakinSpell\parser.lua:30: ParseSubstitutionKey()
SpeakinSpell\substitutions.lua:410:
SpeakinSpell\substitutions.lua:406
(tail call): ?
[C]: gsub()
SpeakinSpell\substitutions.lua:443: FormatSubs()
SpeakinSpell\speech.lua:256: SpeakForSpell()
SpeakinSpell\speech.lua:58: OnSpeechEvent()
SpeakinSpell\wowevents.lua:138: UNIT_SPELLCAST_StandardHandler()
SpeakinSpell\wowevents.lua:178: ?()
...oot\Libs\CallbackHandler-1.0\CallbackHandler-1.0.lua:146:
...oot\Libs\CallbackHandler-1.0\CallbackHandler-1.0.lua:146
[string "safecall Dispatcher[5]"]:4:
[string "safecall Dispatcher[5]"]:4
[C]: ?
[string "safecall Dispatcher[5]"]:13: ?()
...oot\Libs\CallbackHandler-1.0\CallbackHandler-1.0.lua:91: Fire()
...\AddOns\DataStore\libs\AceEvent-3.0\AceEvent-3.0.lua:119:
...\AddOns\DataStore\libs\AceEvent-3.0\AceEvent-3.0.lua:118
AddOns:
Swatter, v5.6.4424 (KangaII)
AlphaMap, v3.76.30100
AlphaMapBattlegrounds, v
AlphaMapExteriors, v
AlphaMapInstances, v
AlphaMapPOIInstances, v
AlphaMapPOITravelAgents, v
AlphaMapPOIUtilities, v
AlphaMapWorldBosses, v
AlphaQuestHelper, v1.01.30100
Altoholic, v3.2.002
AtlasLoot, vv5.08.01
AtlasLootFu, vv5.08.01
AucAdvanced, v5.6.4424 (KangaII)
AucDb, v5.1.DEV.3583
AucFilterBasic, v5.6.4424 (KangaII)
AucFilterOutlier, v5.6.4424.2531
AucMatchUndercut, v5.6.4424.2531
AucStatClassic, v5.6.4424 (KangaII)
AucStatHistogram, v5.6.4424 (KangaII)
AucStatiLevel, v5.6.4424 (KangaII)
AucStatPurchased, v5.6.4424 (KangaII)
AucStatSales, v5.6.4424.2842
AucStatSimple, v5.6.4424 (KangaII)
AucStatStdDev, v5.6.4424 (KangaII)
AucStatWOWEcon, v5.6.4424.2530
AucUtilAHWindowControl, v5.6.4424.3311
AucUtilAppraiser, v5.6.4424.2530
AucUtilAskPrice, v5.6.4424.3175
AucUtilAutoMagic, v5.6.4424.3142
AucUtilCompactUI, v5.6.4424.2530
AucUtilEasyBuyout, v5.6.4424.3583
AucUtilFixAH, v5.6.4424 (KangaII)
AucUtilItemSuggest, v5.6.4424.3108
AucUtilPriceLevel, v5.6.4424.2545
AucUtilScanButton, v5.6.4424.2530
AucUtilScanFinish, v5.6.4424.2530
AucUtilScanProgress, v5.6.4424.2530
AucUtilSearchUI, v5.6.4424.3655
AucUtilSimpleAuction, v5.6.4424.0
AucUtilVendMarkup, v5.6.4424.2530
Babylonian, v5.1.DEV.130
BeanCounter, v5.6.4424 (KangaII)
Bejeweled, v1.1a
BonusScanner, v5.2
BrokerBonusScanner, v1.2
BrokerRecount, v1.0
Clique, vwowi:revision
Configator, v5.1.DEV.130
CurseProfiler, v
DataStore, v3.2.002
DataStoreAchievements, v3.2.002
DataStoreAuctions, v3.2.002
DataStoreCharacters, v3.2.002
DataStoreContainers, v3.2.002
DataStoreCrafts, v3.2.002
DataStoreCurrencies, v3.2.002
DataStoreInventory, v3.2.002
DataStoreMails, v3.2.002
DataStorePets, v3.2.002
DataStoreQuests, v3.2.002
DataStoreReputations, v3.2.002
DataStoreSkills, v3.2.002
DataStoreSpells, v3.2.002
DataStoreStats, v3.2.002
DataStoreTalents, v3.2.002
DebugLib, v5.1.DEV.130
Enchantrix, v5.6.4424 (KangaII)
EnchantrixBarker, v5.6.4424 (KangaII)
Grid, v1.30200.2009081101
Informant, v5.6.4424 (KangaII)
MyRolePlay, v3.0.52
NeedToKnow, v2.2
Prat30, v3.2.4
Prat30Libraries, v
QuestHelper, v1.1.19
Recount, v
SimpleRaidTargetIcons, v1.08
SlideBar, v5.6.4424 (KangaII)
SpeakinSpell, v3.2.2.03
Stubby, v5.6.4424 (KangaII)
Titan, v4.3.0.30200 - Revision 316
TitanAmmo, v4.3.0.30200
TitanBag, v4.3.0.30200
TitanClock, v4.3.0.30200
TitanCoords, v4.3.0.30200
TitanGoldTracker, v4.3.0.30200
TitanLootType, v4.3.0.30200
TitanPerformance, v4.3.0.30200
TitanRegen, v4.3.0.30200
TitanRepair, v4.3.0.30200
TitanVolume, v4.3.0.30200
TitanXP, v4.3.0.30200
BlizRuntimeLib_enUS v3.2.2.30200 <us>
(ck=af6)
Unfortunately a new release will be delayed by a day or 2 while I clean up some work in progress on other new features.
As a temporary work-around you avoiding <third person|me> forms should prevent the problem, or change the following line of code:
parser.lua line 84 SHOULD read:
sk.me = string.sub(sk.me, 2)
(I think your version says)
sk.me = string.sub(me, 2)
I'd like to ask 1 more question, is there a way to disable all automatic messages when you create a new spell to use with speakinspell?
Honestly, it's kinda annoying having to delete all the already generated messages, with every speakinspell I make.
3.2.2.03
---------
More GUI touchups
Fixed: Will now ignore blank lines in speeches
Added a patch function to auto-upgrade <newline> to actual line breaks for use in the new multi-line edit boxes
(<newline> may still be used as a substitution)
3.2.2.02
---------
GUI Overhaul: Better organization, labeling, and overall appearance
Added channel option: Self-Only Raid Warning
Fixed: Rebuffs now count as buff events and will be announced if applicable
Added "/ss toggle"
Changed "/ss" and "/ss toggle" now work the same way as right-clicking the minimap button
Various bug fixes - Removed "beta" designation
3.2.2.01 (beta)
---------
Fixed LUA error with spell links
Fixed LUA error with events that do not have any speeches
Enhanced <spelllink> to work on most spells now
(adds spell id cache)
Added "/ss memory" and memory display on the General Settings
---------
3.2.0.08 (beta)
---------
Added support for Gender substitutions
- The simple form is: <target*male*female>
- More advanced forms like <mouseover's*his*her> target is <mouseovertarget*a boy*a girl|me>
- See the in-game help chapter 8. Gender for details
Improved Search GUI
- If search options are too limited, will now display "No Matching Search Results Found"
- normally limited to 100 results to get rid of the lag
- Fixed bugs with some of the search results
Added substitutions:
<scenario> - "The Arena", "A Battleground", "Wintergrasp", "A Raid", etc
<eventtype> - "Spells, Abilities, and Items (Start Casting)", etc
<eventtypeprefix> - "When I Start Casting: " etc.
Overhauled the substitution engine
- Possessive forms now work on all subtitutions
- Third Person |me parsing now works on all subtitutions, and when combined with possessive forms, as in <target's|my>
- Substitution data is now only generated if it is used (performance boost)
- Gender substitutions are now supported
Added a minimap button for easier access to settings