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 4000 "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.
- 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.
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. 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
- 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) One day, Grand Warlock Wilfred Fizzlebang offered to help me add some features to SpeakinSpell... unfortunately, he tried to summon a demon to write some code for us, and, well, to make a long story short, the demon is still lurking around somewhere in the addon... Don't let him eat your soul!
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 the last time I updated this description, SpeakinSpell version 3.2.2.25 was built against WoW client version 3.2.2, and is my 25th update to SpeakinSpell since that patch to WoW. When WoW 3.3.0 is released, the next versioin will be 3.3.0.01.
Type "/ss help" in game for the complete user's manual. SpeakinSpell has many more features than those listed above.
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.
If you have any questions, problems, comments, or concerns, please feel free to post here on the website or submit a ticket.
Credits
SpeakinSpell was created by...
Primary Beta Testing, Arena Team Pwnage, Key Grip...
Translators who help me in so many other ways...
- leXin for the German deDE
- troth75 for the Korean koKR
Many of the default speeches were blatantly stolen from...
- Cryolysis2
- Necrosis
- LunarSphere
- Ultimate Warcraft Battlecry Generator
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
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
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...
------------------------------------------------------------------------
r1367 | rismisner | 2010-01-18 02:40:50 +0000 (Mon, 18 Jan 2010) | 1 line
Changed paths:
A /tags/v3.3.0.07-release (from /trunk:1366)
tagged 3.3.0.07
------------------------------------------------------------------------
r1366 | rismisner | 2010-01-18 02:37:06 +0000 (Mon, 18 Jan 2010) | 1 line
Changed paths:
M /trunk/changelog.txt
cleanup release notes
------------------------------------------------------------------------
r1365 | rismisner | 2010-01-18 02:35:26 +0000 (Mon, 18 Jan 2010) | 1 line
Changed paths:
M /trunk/data.lua
M /trunk/speech.lua
don't save duplicates in the recent list for "/ss recent"
------------------------------------------------------------------------
r1364 | rismisner | 2010-01-18 00:13:32 +0000 (Mon, 18 Jan 2010) | 1 line
Changed paths:
M /trunk/gui/createnew.lua
updated usage of DoReportDetectedSpeechEvent
------------------------------------------------------------------------
r1363 | rismisner | 2010-01-18 00:12:25 +0000 (Mon, 18 Jan 2010) | 1 line
Changed paths:
M /trunk/SpeakinSpell.lua
M /trunk/data.lua
M /trunk/loader.lua
M /trunk/slashcommands.lua
M /trunk/speech.lua
added "/ss recent" to show setup guides for recent events and speeches, to [click here] to edit options
------------------------------------------------------------------------
r1362 | rismisner | 2010-01-17 20:28:41 +0000 (Sun, 17 Jan 2010) | 1 line
Changed paths:
M /trunk/changelog.txt
release note
------------------------------------------------------------------------
r1361 | rismisner | 2010-01-17 20:22:14 +0000 (Sun, 17 Jan 2010) | 1 line
Changed paths:
M /trunk/utils.lua
M /trunk/wowevents.lua
Fixed bug: "ding" now matches whole word only (not "raiding" etc)
------------------------------------------------------------------------
r1360 | rismisner | 2010-01-17 19:35:14 +0000 (Sun, 17 Jan 2010) | 1 line
Changed paths:
M /trunk/clickhere.lua
M /trunk/gui/colors.lua
M /trunk/loader.lua
the color of [Click Here] links is now configurable, and defaults to a shade of gold instead of blue
------------------------------------------------------------------------
r1359 | rismisner | 2010-01-17 19:22:20 +0000 (Sun, 17 Jan 2010) | 1 line
Changed paths:
M /trunk/SpeakinSpell.lua
M /trunk/data.lua
M /trunk/loader.lua
M /trunk/speech.lua
when turning on setup guides, show guides for recent events detected and/or announced
------------------------------------------------------------------------
r1358 | rismisner | 2010-01-17 18:57:11 +0000 (Sun, 17 Jan 2010) | 1 line
Changed paths:
M /trunk/changelog.txt
release note
------------------------------------------------------------------------
r1357 | rismisner | 2010-01-17 18:55:33 +0000 (Sun, 17 Jan 2010) | 1 line
Changed paths:
M /trunk/wowevents.lua
stop congratulating myself for achievements earned near me
------------------------------------------------------------------------
r1356 | rismisner | 2010-01-17 18:47:25 +0000 (Sun, 17 Jan 2010) | 1 line
Changed paths:
M /trunk/loader.lua
At the start of SpeakinSpell system messages printed in chat, where it says "SpeakinSpell:" that is now a clickable link to open the options (same as "/ss toggle")
------------------------------------------------------------------------
r1355 | rismisner | 2010-01-17 18:37:27 +0000 (Sun, 17 Jan 2010) | 3 lines
Changed paths:
M /trunk/SpeakinSpell.lua
- ShowSpellEvents renamed to ShowSetupGuides
- Enhanced welcome message
- Added functions to toggle setup guides with [click here] messages
------------------------------------------------------------------------
r1354 | rismisner | 2010-01-17 18:36:35 +0000 (Sun, 17 Jan 2010) | 1 line
Changed paths:
M /trunk/speech.lua
ShowSpellEvents renamed to ShowSetupGuides
------------------------------------------------------------------------
r1353 | rismisner | 2010-01-17 18:36:15 +0000 (Sun, 17 Jan 2010) | 1 line
Changed paths:
M /trunk/gui/generaloptions.lua
ShowSpellEvents renamed to ShowSetupGuides
------------------------------------------------------------------------
r1352 | rismisner | 2010-01-17 18:36:00 +0000 (Sun, 17 Jan 2010) | 1 line
Changed paths:
M /trunk/gui/createnew.lua
ShowSpellEvents renamed to ShowSetupGuides
------------------------------------------------------------------------
r1351 | rismisner | 2010-01-17 18:35:38 +0000 (Sun, 17 Jan 2010) | 1 line
Changed paths:
M /trunk/Locales/help-enUS.lua
added "/ss guides" to toggle setup guides on/off
------------------------------------------------------------------------
r1350 | rismisner | 2010-01-17 18:35:19 +0000 (Sun, 17 Jan 2010) | 1 line
Changed paths:
M /trunk/slashcommands.lua
added "/ss guides" to toggle setup guides on/off
------------------------------------------------------------------------
r1349 | rismisner | 2010-01-17 18:34:58 +0000 (Sun, 17 Jan 2010) | 1 line
Changed paths:
M /trunk/loader.lua
ShowSpellEvents renamed to ShowSetupGuides and enabled by default
------------------------------------------------------------------------
r1348 | rismisner | 2010-01-17 18:34:34 +0000 (Sun, 17 Jan 2010) | 1 line
Changed paths:
M /trunk/data.lua
"/ss macro stuff" is now immune to the global option for SpeakinSpellSavedData.EnableAllMessages run macros will always announce even if SS is globally disabled
------------------------------------------------------------------------
r1347 | rismisner | 2010-01-17 18:33:52 +0000 (Sun, 17 Jan 2010) | 1 line
Changed paths:
M /trunk/changelog.txt
release notes for changes in progress
------------------------------------------------------------------------
r1346 | rismisner | 2010-01-17 06:52:46 +0000 (Sun, 17 Jan 2010) | 1 line
Changed paths:
M /trunk/utils.lua
dont assume self-cast for unknown <target>
------------------------------------------------------------------------
r1345 | rismisner | 2010-01-16 03:02:29 +0000 (Sat, 16 Jan 2010) | 1 line
Changed paths:
M /trunk/changelog.txt
added a release note
------------------------------------------------------------------------
r1344 | rismisner | 2010-01-16 03:00:22 +0000 (Sat, 16 Jan 2010) | 1 line
Changed paths:
M /trunk/clickhere.lua
implemented clickable link to [Edit Speeches] / [Setup New Event]
------------------------------------------------------------------------
r1343 | rismisner | 2010-01-16 02:54:28 +0000 (Sat, 16 Jan 2010) | 1 line
Changed paths:
M /trunk/speech.lua
DoReportDetectedSpeechEvent now supports an option to force it even if the global option is turned off (for showing a link for newly detected /ss macro things)
------------------------------------------------------------------------
r1342 | rismisner | 2010-01-16 02:53:45 +0000 (Sat, 16 Jan 2010) | 2 lines
Changed paths:
M /trunk/gui/createnew.lua
- (change) When a new /ss macro is detected, do not automatically open the Create New interface anymore. Show a clickable link instead.
- (cleanup) When opening the message settings window, use the subroutine from gui.lua instead of a manual call
------------------------------------------------------------------------
r1341 | rismisner | 2010-01-16 02:44:35 +0000 (Sat, 16 Jan 2010) | 1 line
Changed paths:
M /trunk/data.lua
<SpellLink> will no longer put incorrect brackets around "/ss [macro something]"
------------------------------------------------------------------------
r1340 | rismisner | 2010-01-16 02:33:00 +0000 (Sat, 16 Jan 2010) | 1 line
Changed paths:
M /trunk/speech.lua
the "Report Detected Speech Events" feature now includes [Click Here] links to edit the detected event options
------------------------------------------------------------------------
r1339 | rismisner | 2010-01-16 02:32:19 +0000 (Sat, 16 Jan 2010) | 1 line
Changed paths:
M /trunk/SpeakinSpell.lua
updated usage of MakeClickHereLink to specify the "[Click Here]" text for this message
------------------------------------------------------------------------
r1338 | rismisner | 2010-01-16 02:32:00 +0000 (Sat, 16 Jan 2010) | 2 lines
Changed paths:
M /trunk/clickhere.lua
- (work in progress) Added a stub handler function for OnClickEditEvent(key)
- MakeClickHereLink now allows the [Click Here] text to be changed
------------------------------------------------------------------------
r1337 | rismisner | 2010-01-16 01:47:41 +0000 (Sat, 16 Jan 2010) | 1 line
Changed paths:
M /trunk/SpeakinSpell.lua
M /trunk/gui/generaloptions.lua
Changed the "Loaded version N" message to say "Welcome to SpeakinSpell vN [Click Here] to edit options"
------------------------------------------------------------------------
r1336 | rismisner | 2010-01-16 01:29:40 +0000 (Sat, 16 Jan 2010) | 1 line
Changed paths:
M /trunk/clickhere.lua
fixed syntax errors
------------------------------------------------------------------------
r1335 | rismisner | 2010-01-13 19:02:30 +0000 (Wed, 13 Jan 2010) | 1 line
Changed paths:
M /trunk/SpeakinSpell.wowproj
added clickhere.lua to the wowproj file (manually in a text editor)
------------------------------------------------------------------------
r1334 | rismisner | 2010-01-13 19:01:26 +0000 (Wed, 13 Jan 2010) | 1 line
Changed paths:
M /trunk/SDD.doc
added clickhere.lua
------------------------------------------------------------------------
r1333 | rismisner | 2010-01-13 18:55:44 +0000 (Wed, 13 Jan 2010) | 4 lines
Changed paths:
M /trunk/SpeakinSpell.lua
M /trunk/SpeakinSpell.toc
M /trunk/changelog.txt
M /trunk/loader.lua
- Incremented version number
- Added clickhere.lua to the TOC
- Call new ClickHere_Init function OnInitialize
- Defined the color of [Click Here] links
------------------------------------------------------------------------
r1332 | rismisner | 2010-01-13 18:52:03 +0000 (Wed, 13 Jan 2010) | 1 line
Changed paths:
A /trunk/clickhere.lua
rough draft of functions to implement [Click Here] links in chat
------------------------------------------------------------------------
r1330 | rismisner | 2009-12-18 18:41:37 +0000 (Fri, 18 Dec 2009) | 1 line
Changed paths:
M /trunk/changelog.txt
release note
------------------------------------------------------------------------
r1329 | rismisner | 2009-12-17 20:47:22 +0000 (Thu, 17 Dec 2009) | 1 line
Changed paths:
M /trunk/SpeakinSpell.toc
M /trunk/changelog.txt
M /trunk/loader.lua
increment version and release notes
------------------------------------------------------------------------