Events

How to make and remove custom events for Shinrameter.

Events files are located in "ShinraMeter\resources\config\events" Depending on what class you are logged into, it will load a different events file. events-common.xml will always be loaded and will serve as a way to tell you if things like Hurricane or Enrage are currently on the boss, this file will notify you no matter what class you are logged into. But if you main mystic, you'll want to edit events-mystic.xml to your liking.

##Buff/Debuff lists You can find a list of buffs/debuffs here: https://raw.githubusercontent.com/neowutran/TeraDpsMeterData/master/hotdot/hotdot-EU-EN.tsv (or you can use any other region file from https://github.com/neowutran/TeraDpsMeterData/tree/master/hotdot or even from ./resources/data/hotdot directory of your meter)

• you can use more condensed list from http://moongourd.com/info , that contains most common buffs/debuffs.

##Disable event Since V1.60 you can disable any event by adding active="false" attribute to it. If no active on event level is specified - one from <events> node will be used, if there is no active attribute even there - default is active="true".

##To remove an unwanted beep Look in your class file, copy the abnormality codes and look it up in the above files until you find what it is, and remove any unwanted sounds. To fully remove an event, remove everything between and including and the very next .

##To add an event I'll have to explain the different kinds of events you can create. "Added", "Removed", "MissingDuringFight"

• Added: When a buff or debuff is added to the boss, yourself, or a party buff such as Energy Stars (set by whether you put "Self", "Boss", or "Party" as the target), the meter will beep and send you a message.

• Removed: When a buff or debuff ends and is no longer applicable, the meter can send you a beep and a message.

• MissingDuringFight: If you start a fight or have recently resurrected and you don't have a certain buff on you, such as Ninja's Focus, or a Complete Crystalbind.

##How to create an event. This is what a completed event looks like:

	<abnormality ingame="true" remaining_seconds_before_trigger="0" rewarn_timeout_seconds="0" trigger="MissingDuringFight" target="Self">
		<abnormalities>
			<abnormality>10154030</abnormality>
		</abnormalities>
		<actions>
			<notify>
				<balloon title_text="{abnormality_name}" body_text="{abnormality_name}" display_time="3000" />
				<sound type="Beeps">
					<beeps>
						<beep frequency="220" duration="500"/>
					</beeps>
				</sound>
			</notify>
		</actions>
	</abnormality>

You can change the:

• remaining_seconds_before_trigger="0" to the number of seconds you want the meter to wait before it'll send a beep, so for example if you spend 10 seconds without the buff, it'll notify you. If the buff goes up before the 10 seconds are up, it won't notify you.

• rewarn_timeout_seconds="30" - applied only for "MissingDuringFight" events, delay next check for X seconds after notification

• trigger to "Added", "Removed", or "MissingDuringFight" as whichever you want.

• target between "Self", "Boss", or "Party" depending on what the buff will be affecting.

• find an abnormality in the list (see https://github.com/neowutran/ShinraMeter/wiki/Events#buffdebuff-lists ), then change the number inbetween to the desired one.

• message that the meter will send you, or you can delete the entire line that starts with "" to not receive a message. The title_text is what shows up at the top of the notification, I'd recommend leaving this the same. But body_text is what is contained in the message, {abnormality_name} will automatically name whatever is in , but after that you can put something like "{abnormality_name} has been put on the boss! Quick, use Fire Avalanche/Burning Heart!" Onto the display_time, this is in milliseconds, so 3000 will display the message for 3 seconds, if you want it to be up for 10 seconds, change it to 10000.

• The final thing to change is whether you want it to beep, not beep, or play music. An easy way to turn off the beep is to set the duration and frequency to 0, or to just delete everything between and including and . Beeps is pretty self-explanatory, but you can also set it to play music. Here is an example of what you would have it look like if you wanted it to play music:

<sound type="Music">
<music file="C:\MyMusic\foo.mp3" volume="100" duration="2000"/>
</sound>

Remember that duration="" is in milliseconds, so 2000 would be 2 seconds. Volume="" is 0-100, so 100 would be if you were listening to it on Windows Media Player at 100% volume.

Restore defaults

If at any point your event file gets corrupted or you mess up, you can just delete the entire file and it will be recreated the next time you open ShinraMeter with default settings.