This is still a work in progress.
Understanding how CastYeller2 works
CastYeller2 is designed around 3 items:
- the triggers, defined by source modules, that causes announces to be sent,
- the outputs, also called sinks, where announce are sent.
- the announces, that are bound to triggers and sent into the sinks.
Announces are not tied to a particular spell or item. Instead, they are tied to a set of names, that can be any combination of spell names, items names and auras names, or whatever else the source modules handle.
Each source module watch for a sets of in-game events that are translated to triggers. When such event occurs, say the player starts to cast a spell, all announces are tested against the spell name and the trigger. To be selected, an announce must :
- be enabled,
- have the spell name listed in its name list,
- have the source and trigger selected,
- have at least an output module selected.
When all these conditions are met, the message is formatted according to data provided by the source module and then send to selected output modules.
Each source module provides default message templates for all its triggers. However, one can provides custom templates. If several templates are given, one of them is randomly chosen each time the trigger fires. For more information about message templates, see this page.
Any of the source, trigger or output can be disabled globally to prevent announces to be triggered by a particular event or sent to a particular output.
Creating a new announce
- To create a new announce, go on the "Announce Options" tab. Enter the name of your new announce in the "Name" input box and click on the "Create" button. The announce name is only used for configuration ; it does NOT have to match any spell. Then select the newly created announce.
- In the "Names" text area, enter the name of the spell/auras to watch, one per line. Each name has to match either an existing spell you can cast or a buff or debuff you can apply.
- Then select the "Sources'" tab. Here you can select which events are watched. First, check the general source types you want and then the particular events you want to announce.
- Select the "Outputs" tab. Here you can select where the announce is done. When checking an output, a specific configuration box appears underneath. Use it to make announce specific configuration for that output. Global output configuration can be done in the "Global options" tab.
- Each announce trigger comes with its own default announce. However, if you want to customize the messages, select the "Custom announce templates" tab. Here you can find one entry per enabled trigger. You can define your own message templates by enabling the custom announce and entering your templates in the text area, one per line. If you want to define dynamic messages (e.g. that includes name of the target), take a look on the custom announce template format.