SpeakinSpell

Which Channel?

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, Entered Combat, Changed Zone 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, arena, and Wintergrasp.
    • Also supports built-in emotes and most other slash commands
  • Fully configurable through the interface options panel.
  • Includes funny default speeches for many spells for all classes. These are only meant to serve as examples. You can and should write your own speeches.


Usage Instructions

How to setup SpeakinSpell in a few easy steps:

  1. Login and play your toon for a few minutes.
  2. Activate any abilities, trigger any procced effects, and encounter any other detectable events that you would like SpeakinSpell to announce.
  3. Type "/SpeakinSpell" ("/ss" also works) to access the interface options panel
  4. Click on "Create New..." or type "/ss create" to create settings for a new spell or other event
  5. 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.
  6. 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.
  7. 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 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 ____).


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


More Information

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

SpeakinSpell was created by...

  • Stonarius of Antonidas

Primary Beta Testing, Arena Team Pwnage, Key Grip...

  • Meneldill

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.

Special thanks to the authors of these addons that I use as a model for how addons should be made...

  • Titan
  • Omen
  • Recount
  • Healbot
  • the WowAce libs

Thank you to the community on the wowace forums for much appreciated LUA coding help.

Thanks to Blizzard Entertainment for this great game! ... hire me??

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 said "Baaah! sheeped again <target>?!" and it was all good...

You must login to post a comment. Don't have an account? Register to get one!

  • Avatar of rismisner rismisner Sun, 20 Sep 2009 19:27:36

    3.2.0.06 is up. It adds tons of new stuff. So much new stuff in fact that I decided to call it a beta because I'm only about 98% sure it all works, instead of a full 100% "release" quality. See the changelog.txt file for details.

  • Avatar of rismisner rismisner Thu, 03 Sep 2009 19:08:51

    3.2.0.05 is up... this version basically just brings the Korean language files up to date with the new features.

    2 posts down I said...
    >> There is a more concise write-up on this feature in the in-game user's manual (/ss help) in chapter 8: Custom Macros.

    It's not so concise anymore in 3.2.0.05 since I expanded the documentation in that chapter to describe how to use this to set up spell groups, and how to do one spell with different lists of speeches - topics discussed in the following comments below.  Now I think it's a little too wordy so I'll probably fuss with it more some time, but I guess more info is better than less.

  • Avatar of rismisner rismisner Wed, 26 Aug 2009 20:45:40

    I have updated the tickets page to ensure there is a ticket for every feature idea that I have on my list, including every feature or change that's been suggested to me.

    I will respect the votes if you vote on the ideas that you like more than others, and try to add the feature ideas with more votes before those with fewer.  So go vote for what you want to see in the next version of SpeakinSpell!

    http://www.wowace.com/addons/speakinspell/tickets/

    As always I am also taking more suggestions if you have more ideas for new features or ways you would like SpeakinSpell to work differently, please don't hesitate to create a ticket, or post here and I'll create a ticket out of your suggestion.

  • Avatar of rismisner rismisner Mon, 24 Aug 2009 21:17:41

    Short answer... manually type into the chat "/ss macro blank" and fill in the blank with any name you want to give it. You will be prompted to create settings for that event. (it's smart enough to only prompt you the first time). That should get you started playing with it.

    ---

    A little more long-winded explanation about the /ss macro feature...

    The announceable event that is detected by SpeakinSpell is called "When I type: /ss macro something"

    Note that the Create New interface (/ss create) will only list events that it has seen before. So it will not list a spell until it sees you cast that spell. It will not show the system event: Entered Combat, until it sees you enter combat at least once. And likewise it will not list the event "When I type: /ss macro something" until you've actually typed "/ss macro something" into the chat at least once.

    So type "/ss macro something" into the chat to get started setting this up.

    Now "something" in this context can be anything you want, in order to allow you to create any number of custom events where you type "/ss macro [the name of my custom event]"

    As an added shortcut assistant feature to this idea, the very first time that you type a new event name in "/ss macro the name of a macro that SpeakinSpell has not seen you type before" ... SpeakinSpell will detect that you've typed in a new macro name that it has not seen before, so it will automatically open the Create New interface (/ss create) to prompt you to setup speeches for that event, because it assumes you're trying to create a new one.

    The only required text is the prefix "/ss macro" then a space, then anything else you want to type. It can be one or more words, spaces are allowed, as well as special symbols, and I don't know of any limit to the length.

    I hope that makes more sense to you now.

    There is a more concise write-up on this feature in the in-game user's manual (/ss help) in chapter 8: Custom Macros. I think once you start playing with it, you'll find it intuitive and easy to use.

    Please don't hesitate to speak up if you still have trouble with it, or if you have any questions.

  • Avatar of Folji Folji Mon, 24 Aug 2009 19:08:29

    Creating an /ss macro would probably work pretty well for creating one set of messages for several spells and abilities, though there is one problem.

    When I select the /ss macro category in the "Create New..." option, the "Select Spell" field shows as empty, and when I try to create the selected event, it returns this error;

    SpeakinSpell: ERROR: CreateNew_OnClickCreateNew() - no event selected

    As obviously, I haven't selected any event. As there are no events to select under /ss macro

  • Avatar of rismisner rismisner Mon, 24 Aug 2009 00:37:36

    To make an event for a buff or ability that fires message A when playing solo, and message B when in a party, but never vice versa...

    I considered several approaches to this, but in order to achieve this in various ways, either the GUI was going to have to get more complicated, or the string parsing would have to get more complicated (and would not be obvious) and I never liked anything I came up with for making this feature happen... and then it occurred to me that it's already possible within the existing feature-set by using /ss macro something

    For your event, specify a single message: /ss macro this event when I'm solo<newline>/ss macro this event when I'm grouped

    Now each time you encounter this event, it will always trigger two /ss macro events: "When I type: /ss macro this event when I'm solo" and "When I type: /ss macro this event when I'm grouped" (yes it's completely OK for SpeakinSpell to trigger itself recursively like this, as long as "/ss macro something" doesn't call out the same "/ss macro something" which would cause infinite recursion)

    Now configure your settings for "When I type: /ss macro this event when I'm solo" to only say anything when you're solo (silent in all other scenarios), and "When I type: /ss macro this event when I'm grouped" to only say anything if you're grouped (silent when solo) ... they can have different speech lists, and you can achieve what you're looking for that way, and achieve totally different settings for the different scenarios in terms of the random chance, cooldown, limit once per combat, etc.

    A similar approach will work for setting up a set of events to share the same speeches. Put all the shared speeches under a "/ss macro something" event, then call out "/ss macro something" as the speech for all of the other events that you want to share that message list.

    I recently started toying around along those lines by setting up the "System Event: Entered Combat" with a 2% chance to trigger "/ss macro battlecry"

  • Avatar of rismisner rismisner Mon, 24 Aug 2009 00:32:26

    Your thinking is in line with mine. I'm giving my translators time to catch up for now, but I do want to keep working on this. I expect them to catch up any day now.

    I'll spare you my ramblings on gender and grammar... suffice it to say it's a topic I puzzle over because whatever I do, I want it to be as universal as possible to support foreign languages with possibly very different grammar rules... I am thinking along the lines of following more of the <target|me> feature where perhaps you could say <targetgender:he/she> or <targetgender:him/her> or <targetgender:male/female> or whatever fits the sentence.

    The randomtaunts and randomfactions are both slated to become configurable in a future version.

    The import data function is totally planned for expansion into importing from your other characters. I also want to do something similar with that underlying function for importing speeches from one event into another.

    I thought about prompting you for each one, but decided it could be a lot of prompts, so I opted for printing the names of each event touched by that process (look in your chat window for the list) and then you can go through those events and delete what you didn't want imported. The first few times I tested it, all of the new speeches were added to the end, so it was easy to find the new ones and delete what I didn't want... unfortunately, the last time I tried it, I found speeches mixed in the middle, and some that appeared duplicated, so I think the series of prompts may be a better way to go... "Do you want this speech for this event?" [yes | no | yes to all] ... something like that.

    I haven't worked on the minimap button or LDB tie-in yet, but that's rapidly rising to the top of my todo list.

    2 of your ideas are possible within the existing feature set given the magic of "/ss macro something" + the ability to use slash commands in the random speeches. I'll cover the instructions in my next post so it's not buried in the middle of my other ramblings here.

  • Avatar of Folji Folji Sat, 22 Aug 2009 01:14:55

    To contrast messages that are silent in certain situations, it would be nice if SpeakinSpell had some way to add messages to an event that only fire in a certain situation (like make an event for a buff or ability that fires message A when playing solo, and message B when in a party, but never vice versa).

    I really do like the added <newline>, <zone> and <subzone> commands, though I'm.. not all that fond of the <randomtaunt> one. I really doubt that my guild, or that many other people, would appreciate it that much if I was to yell "Die Nub!" at the high spot of the fight. In an "everyone for their own taste" kind of way, it would probably be a considerable idea to throw in some easily accessible way of customizing the "taunts" for oneself. Same could probably also go for the <randomfaction>, though here it's more a matter of what factions you want to shout about and what factions you don't. An Orc shouting "for the Light!"? A Dwarf fighting "for the Sin'Dorei"? Anything other than a Rogue doing stuff "for Ravenholdt"?

    There are also these two things that could probably be considerable as new things in SpeakinSpell; one is a gender variable for both the target and the player, the other is a way to import/copy specific phrases from either the default ones or those of another character and give it to the character you're currently playing.

    The first one would be as easy as referring to the UnitSex API (http://www.wowwiki.com/API_UnitSex), and creating a simple table of gender phrases for different situations. One he/she/it (like "he/she/it prepares something or other"), one his/her/its (like "raises his/her/its shield"), and one him/her/it (like "<player> thinks <target>'s big teeth fits him/her/it well") - could probably be referenced as <pgender1/2/3> and <tgender1/2/3>, player and target respectively. Could be handy for when creating gender referencing phrases where one would normally just use an androgynous term like "their" instead.

    The second one can probably be best explained by referencing to the "Import new default phrases" option (which can probably later be expanded to importing from other characters and suchlike). You have things you can import, but do you want to import it all? You hit the import button (be it the new default ones or maybe from another character), and instead of just right away importing the phrases there are; it opens a list of phrases that can be imported. You can then get a glimpse at them, and choose which ones you actually want to import to the current character.

    And just to throw in one last thing; have there been any further thoughts on adding a minimap/LibDataBroker plugin to quickly and easily toggle the AddOn and open the options? Or that "Several events, same phrases" thing I suggested a bit back, to basically add an option to take a bunch of abilities/events and grouping them together to share a single set of phrases?

    Keep working on this AddOn. Really. The ability to let my characters roleplay themselves while I'm too preoccupied with running around and casting spells to stop and type anything, is awesome.

    Last edited on 22 Aug 2009 by Folji
  • Avatar of rismisner rismisner Wed, 05 Aug 2009 19:29:04

    Thanks for your feedback as always Folji. You're a fountain of good ideas. I agree we could use some better filters and/or search capabilities under Create New, and it would also be nice to have additional event types for spell cast success, failure, hit, miss, crit.

  • Avatar of Folji Folji Sat, 25 Jul 2009 23:08:31

    I've been using this AddOn for a while now (thanks for adding the possibility to have different message for the same ability output to different channels, by the way), and I'd very much like to see the possibility to remove events from the "Create New..." list, as well as an option to filter out things that just seem to clutter it up (like different ranks of the same ability (only time(s) I've used that was for the mage conjure spells), things you just know you won't do anything with, tradeskill crafting, etc.).

    EDIT: Oh, and it would also be kind of neat if there was a way for the AddOn to detect when a spell or ability successfully hit (to add on to when the character begins casting them).

    Last edited on 26 Jul 2009 by Folji

Facts

Date created
28 Nov 2008
Categories
Last update
23 Nov 2009
Development stage
Release
Language
  • deDE
  • enUS
  • koKR
License
Public Domain
Curse link
SpeakinSpell
Recent files

Authors