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
Main Features
- Can detect a variety of "Events" and automatically announce them in the chat using a random selection from a list of user-defined speeches (some defaults are provided for you as examples). This includes:
- 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)
- Other events (Login, etc)
- whenever you type "/ss macro something"
- Up to 100 speeches can be entered per spell.
- Each spells' random speeches can be directed to any chat channel you choose
- Supports different channel options for different scenarios: solo, group, raid, BG, and arena.
- Fully configurable through the interface options panel.
- Includes funny default speeches for many spells for all classes
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 "/SpeakinSpell" ("/ss" also works) 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.
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.
Additional Features
- Supports many substitution variables such as <player>, <target>, <targetclass>, <targetrace>, and many more. Type "/ss help" in game for the complete list.
- 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 only announce the use of a spell based on a random chance
This is a user-configurable percent chance per spell. This can be useful for roleplaying purposes, or to cut down on the amount of spell-triggered spam you generate in chat.
- Can be configured to use a cooldown on spell announcements for each spell
This can be used to prevent announcing spell casting too often for frequently used spells
- 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. 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 "_ macro something" which you can setup to be announced with random speeches. This can be used for randomized battlecries, greetings, farewells, or anything you want to define.
Using SpeakinSpell in Non-English Versions
If SpeakinSpell has not yet been localized into your native language, don't worry, it can still work for you.
The core design concepts in SpeakinSpell which enable it to work on any spell for any class also enable it to work in any non-English version of the WoW game client. The slash commands and labels in the options interface will of course appear in English, as well as the default example spell settings and random speeches. However, the core functionality of detecting user-selected spells and events, and announcing them with user-defined speeches, will continue to function in any language.
How to Interpret the Version Number (i.e. why it starts at 3.0.3.01)
The SpeakinSpell version number is composed of the WoW client version number that SpeakinSpell was built and tested against, followed by an incremental SpeakinSpell version number
For example SpeakinSpell version 3.0.3.05 was built against WoW client version 3.0.3, and is SpeakinSpell release 5 against that version of WoW
When WoW 3.1.0 comes out, the next SpeakinSpell release will be SpeakinSpell v3.1.0.01
Type "/ss help" in game for the complete user's manual.
If you have any questions, problems, comments, or concerns, please feel free to post here on the website.
Credits
Thanks to Meneldil for Beta Testing. Go Go Tough as Cloth!
Big thanks to leXin for the German translation, many ideas for random speeches, and much appreciated feedback on usability, options, tooltips, and general clarity of use.
Thanks to troth75 for spontaneously and unexpectedly sending me a (mostly) completed Korean translation.
I'd also like to thank the authors of all the wonderful addons that I use, especially Titan, Omen, Recount, and Healbot, for offering me hundreds of hours of better gameplay, inspiration for my own addon, and most importantly: LUA code samples!
Thank you to the community on the wowace forums for much appreciated LUA coding help.
Some of the default random speeches were lifted from Necrosis, Cryolysis2, and LunarSphere.
No sheep were popped in the making of this addon. Well, maybe a couple who wandered into the AoE...
------------------------------------------------------------------------
r242 | rismisner | 2009-06-26 07:55:22 +0000 (Fri, 26 Jun 2009) | 1 line
Changed paths:
A /trunk/SavedVariables/3.1.3.02
A /trunk/SavedVariables/3.1.3.02/SpeakinSpell.lua
A /trunk/SavedVariables/3.1.3.02/SpeakinSpell.lua.bak
adding sample saved data from v3.1.3.02 for future testing purposes. this is not to be distributed by the release packager.
------------------------------------------------------------------------
r241 | rismisner | 2009-06-26 07:53:19 +0000 (Fri, 26 Jun 2009) | 1 line
Changed paths:
M /trunk/Locales/Locale-enUS.lua
minor correction to interface options Create New instructions
------------------------------------------------------------------------
r240 | rismisner | 2009-06-26 07:48:22 +0000 (Fri, 26 Jun 2009) | 1 line
Changed paths:
M /trunk/SpeakinSpell.lua
show localized text on the Create New page
------------------------------------------------------------------------
r239 | rismisner | 2009-06-26 07:45:36 +0000 (Fri, 26 Jun 2009) | 1 line
Changed paths:
M /trunk/todo.txt
updated todo list
------------------------------------------------------------------------
r238 | rismisner | 2009-06-26 07:43:26 +0000 (Fri, 26 Jun 2009) | 1 line
Changed paths:
A /trunk/todo.txt
added todo list to source code control. this will not be included in release packages.
------------------------------------------------------------------------
r237 | rismisner | 2009-06-26 07:42:41 +0000 (Fri, 26 Jun 2009) | 1 line
Changed paths:
M /trunk/Locales/Locale-enUS.lua
clarified the text for the category "spells and abilities" to include items (when you manually activate them - automatic procs are considered buffs that you receive from yourself or someone/something else)
------------------------------------------------------------------------
r236 | rismisner | 2009-06-26 07:36:03 +0000 (Fri, 26 Jun 2009) | 1 line
Changed paths:
M /trunk/Locales/Locale-deDE.lua
M /trunk/Locales/Locale-enUS.lua
M /trunk/Locales/Locale-koKR.lua
M /trunk/SpeakinSpell.lua
localized the text labeling the new event type category filter controls. Korean and German translations are still pending.
------------------------------------------------------------------------
r235 | rismisner | 2009-06-26 07:30:14 +0000 (Fri, 26 Jun 2009) | 1 line
Changed paths:
M /trunk/SpeakinSpell.lua
automatically select the matching category option under message settings when creating a new event
------------------------------------------------------------------------
r234 | rismisner | 2009-06-26 07:11:13 +0000 (Fri, 26 Jun 2009) | 1 line
Changed paths:
M /trunk/SpeakinSpell.lua
fixed the root cause of the missing event type information in the saved data
------------------------------------------------------------------------
r233 | rismisner | 2009-06-26 06:56:29 +0000 (Fri, 26 Jun 2009) | 3 lines
Changed paths:
M /trunk/changelog.txt
high level changes for 3.1.303:
- adds new event type filters to the options interface
- fixes a bug in the saved data
------------------------------------------------------------------------
r232 | rismisner | 2009-06-26 06:55:43 +0000 (Fri, 26 Jun 2009) | 3 lines
Changed paths:
M /trunk/SpeakinSpell.lua
- added first pass at new event type filters in the options GUI
- fixed a bug in the saved data where event types were not listed properly to support the new event type filters
- incremented version number to apply saved data fix
------------------------------------------------------------------------
r231 | rismisner | 2009-06-26 06:53:59 +0000 (Fri, 26 Jun 2009) | 1 line
Changed paths:
M /trunk/SpeakinSpell.toc
update to version 3.1.3.03
------------------------------------------------------------------------
r230 | rismisner | 2009-06-26 06:53:40 +0000 (Fri, 26 Jun 2009) | 1 line
Changed paths:
M /trunk/Locales/Locale-enUS.lua
removed instructions "If the list is too large, you can type "/console reloadui" to reset it." because this is no longer true
------------------------------------------------------------------------
r229 | rismisner | 2009-06-26 01:42:04 +0000 (Fri, 26 Jun 2009) | 1 line
Changed paths:
A /trunk/SavedVariables
A /trunk/SavedVariables/3.1.2.03
A /trunk/SavedVariables/3.1.2.03/SpeakinSpell.lua
A /trunk/SavedVariables/3.1.2.03/SpeakinSpell.lua.bak
A /trunk/SavedVariables/3.1.2.09
A /trunk/SavedVariables/3.1.2.09/SpeakinSpell.lua
A /trunk/SavedVariables/3.1.2.09/SpeakinSpell.lua.bak
A /trunk/SpeakinSpell.wowproj
A /trunk/SpeakinSpell.wowsln
added project development files which are not intended for release packages for end users
------------------------------------------------------------------------
r228 | rismisner | 2009-06-23 20:54:48 +0000 (Tue, 23 Jun 2009) | 3 lines
Changed paths:
M /trunk/SpeakinSpell.lua
M /trunk/SpeakinSpell.toc
M /trunk/changelog.txt
Moved NewEventsDetected table from RuntimeData to SpeakinSpellSavedData.
- updated version number to next available
- removed X-Curse tags from TOC since these appear to be auto-generated by curse.com
------------------------------------------------------------------------
r226 | rismisner | 2009-06-23 03:17:21 +0000 (Tue, 23 Jun 2009) | 1 line
Changed paths:
M /trunk/SpeakinSpell.lua
M /trunk/SpeakinSpell.toc
M /trunk/changelog.txt
updated version number to match game client version 3.1.3
------------------------------------------------------------------------
r225 | rismisner | 2009-06-23 03:05:22 +0000 (Tue, 23 Jun 2009) | 1 line
Changed paths:
M /trunk/Locales/Locale-deDE.lua
M /trunk/Locales/Locale-enUS.lua
fixed lua error from copy-pasting the same table key names
------------------------------------------------------------------------
r224 | rismisner | 2009-06-23 01:48:56 +0000 (Tue, 23 Jun 2009) | 1 line
Changed paths:
M /trunk/Locales/help-koKR.lua
fixed the comment at the top of the file describing what this file is (Korean not English)
------------------------------------------------------------------------
r223 | rismisner | 2009-06-23 01:48:34 +0000 (Tue, 23 Jun 2009) | 1 line
Changed paths:
M /trunk/Locales/help-deDE.lua
updated this entire file with a copy of the new english text since the german user's manual has not yet been translated
------------------------------------------------------------------------
r222 | rismisner | 2009-06-23 01:45:47 +0000 (Tue, 23 Jun 2009) | 3 lines
Changed paths:
M /trunk/Locales/help-enUS.lua
- Added notes for ATTENTION TRANSLATORS
- documented <spelllink> under variables
- various scattered cleanup
------------------------------------------------------------------------
r221 | rismisner | 2009-06-23 00:37:21 +0000 (Tue, 23 Jun 2009) | 1 line
Changed paths:
M /trunk/Locales/help-deDE.lua
M /trunk/Locales/help-enUS.lua
gave troth75 a credit for the new Korean translation in the in-game help. I hope to write a more creative sentence for him in the future when I know him better.
------------------------------------------------------------------------
r220 | rismisner | 2009-06-23 00:31:58 +0000 (Tue, 23 Jun 2009) | 1 line
Changed paths:
M /trunk/changelog.txt
documented Korean support in change log
------------------------------------------------------------------------
r219 | rismisner | 2009-06-23 00:31:45 +0000 (Tue, 23 Jun 2009) | 1 line
Changed paths:
M /trunk/SpeakinSpell.lua
M /trunk/SpeakinSpell.toc
updated version number in preparation of new release
------------------------------------------------------------------------
r218 | rismisner | 2009-06-23 00:30:11 +0000 (Tue, 23 Jun 2009) | 1 line
Changed paths:
A /trunk/Locales/DefaultSpeeches-koKR.lua
A /trunk/Locales/Locale-koKR.lua
A /trunk/Locales/help-koKR.lua
added new files to support a new Korean translation courtesy of troth75
------------------------------------------------------------------------
r217 | rismisner | 2009-06-23 00:23:40 +0000 (Tue, 23 Jun 2009) | 1 line
Changed paths:
M /trunk/Locales/Locale-deDE.lua
M /trunk/Locales/Locale-enUS.lua
added defines for "advertise" slash commands which were formerly using hard-coded English for the optional chat channel control specifiers in: /ss ad /w, /ss ad /s, /ss ad /p, and /ss ad /ra
------------------------------------------------------------------------
r216 | rismisner | 2009-06-23 00:21:56 +0000 (Tue, 23 Jun 2009) | 1 line
Changed paths:
M /trunk/SpeakinSpell.lua
moved several string concatenation processes from runtime to defined locale text to correctly support both English and Korean versions of slash commands: /ss ad /w, /ss ad /p, /ss ad /s, and /ss ad /ra
------------------------------------------------------------------------
r215 | rismisner | 2009-06-23 00:03:44 +0000 (Tue, 23 Jun 2009) | 2 lines
Changed paths:
M /trunk/SpeakinSpell.toc
add Korean localization files
add X-curse tags
------------------------------------------------------------------------
r213 | rismisner | 2009-06-03 06:29:52 +0000 (Wed, 03 Jun 2009) | 1 line
Changed paths:
M /trunk/SpeakinSpell.lua
M /trunk/SpeakinSpell.toc
M /trunk/changelog.txt
updated version number and change log
------------------------------------------------------------------------
r212 | rismisner | 2009-06-03 06:12:18 +0000 (Wed, 03 Jun 2009) | 1 line
Changed paths:
M /trunk/SpeakinSpell.lua
fixed bug with the whisper target feature
------------------------------------------------------------------------
r210 | rismisner | 2009-05-27 12:07:46 +0000 (Wed, 27 May 2009) | 1 line
Changed paths:
M /trunk/Locales/help-enUS.lua
updated help with info about <focus>
------------------------------------------------------------------------
r209 | rismisner | 2009-05-27 11:47:07 +0000 (Wed, 27 May 2009) | 1 line
Changed paths:
M /trunk/Locales/Locale-deDE.lua
M /trunk/Locales/Locale-enUS.lua
M /trunk/SpeakinSpell.lua
M /trunk/SpeakinSpell.toc
M /trunk/changelog.txt
Added substitution variable <focus>
------------------------------------------------------------------------
r207 | rismisner | 2009-05-26 14:03:53 +0000 (Tue, 26 May 2009) | 2 lines
Changed paths:
M /trunk/SpeakinSpell.lua
- dont return a rankelss key if the ranked key is the same value
- show the rank if using a default (ranked) key and a rank is specified, otherwise continue not showing the rank since it was unspecified
------------------------------------------------------------------------
r206 | rismisner | 2009-05-26 13:53:53 +0000 (Tue, 26 May 2009) | 1 line
Changed paths:
M /trunk/SpeakinSpell.lua
M /trunk/SpeakinSpell.toc
updated version number
------------------------------------------------------------------------
r205 | rismisner | 2009-05-26 13:53:12 +0000 (Tue, 26 May 2009) | 8 lines
Changed paths:
M /trunk/Locales/DefaultSpeeches-enUS.lua
M /trunk/Locales/Locale-enUS.lua
M /trunk/Locales/help-enUS.lua
M /trunk/SpeakinSpell.lua
M /trunk/changelog.txt
Fixed ranked vs. rankless spell event detection
- the Create New interface will now allow creating ranked events even if "any rank" events already exist for that spell
- "any rank" events now announce correctly (unless an event with a specific rank takes precedent)
<caster|I> now works
"<caster|I> cast <spelllink> on <target|myself>" works nicely
report detected events now uses the event type text and spell link, duplicated appropriately for "any rank" designations
------------------------------------------------------------------------
r203 | rismisner | 2009-05-26 03:04:33 +0000 (Tue, 26 May 2009) | 1 line
Changed paths:
M /trunk/SpeakinSpell.lua
M /trunk/SpeakinSpell.toc
M /trunk/changelog.txt
updated version number and change log
------------------------------------------------------------------------
r202 | rismisner | 2009-05-26 02:41:02 +0000 (Tue, 26 May 2009) | 3 lines
Changed paths:
M /trunk/SpeakinSpell.lua
- Fixed missing EventTable creation
- Fixed "_ event: login" should be all lowercase during data updates from older versions
- Clarified error message text
------------------------------------------------------------------------