All rules are optional, however you must specify at least one.

• <WC> = Means the item supports Windower wildcard and regex notation. For more information click here.

• Time - As of SpellCast 2.15, time related rules are calculated based off the server time and should be within a second of Vana'diel time.

Additionally, you may prefix all of these rules with 'Not' as in 'NotSpell', 'NotGroup', 'NotDay' to reverse the check and make sure that rule is NOT true.

• Example of 'AND' mode rule.

<!--This rule will change equipment on ws, while additionally not change equipment-->
<!--if we dont actually have enough tp-->
<if mode="AND" CommandPrefix="/ws|/weaponskill" NotTPLT="100">
	<action type="castdelay" delay=".2" />
	<action type="Equip" when="Precast" set="Weapon Skill" />
	<action type="Equip" when="Aftercast" set="Standard" />
</if>

• Example of 'OR' mode rule.

<!--This will equip evasion gear if you cast Utsusemi OR, if your hp is less than 30% when the rule is parsed -->
<!--Unlikely anyone would actually use this, but was an easy example-->
<if mode="OR" spell="Utsusemi*" HPPLT="30">
	<action type="Equip" when="precast" set="Evasion_Gear" />
	<action type="command" when="midcast">input /echo Evasion Gear ON</action>
 
</if>

Used for setting up advanced rules. These rules allow comparisons against variables, and have a special syntax. Please note the additional tick(') that is placed around the whole advanced rule.

The advanced rule allows for specifying an advanced boolean expression. This is very close to C, C++, JAVA, etc format. I will try my best to make this easily accessible to non-programmers.

Here are a few rules describing the syntax of the Advanced rule

• A boolean expression consists of a condition check OR a condition check joined to another boolean expression.
  • boolean expression example: '”%MainJob”=“WHM”'
  • joined expression example: '”%MainJob”=“WHM” AND ”%SubJob”=“BLM”'
• A condition check consists of a value and a second value separated by a comparison operator.
  • Values can be literals or variables, or equations
  • Valid variables can be found here.
  • Valid comparison operators include:
    • &lt; - less than
    • &gt; - greater than
    • &lt;= - less than or equal
    • &gt;= - greater than or equal
    • == - exactly equal
    • = - exactly equal
    • != - not equal
  • If any math is used that might result in a decimal, you must typecast to (float).
  • Strings should be placed within double quotes. ie. “this”
    • If a variable stores a string value, it too should be placed within quotes. ie. ”%Job”
• Boolean expressions can be joined through the use of boolean operators.
  • AND - The boolean expressions on both sides of this operator must be true in order for the whole expression to be true.
  • &amp;&amp; - This is the same as the AND boolean operator. This is really just putting &&, but since & is an escape character…
  • OR - At least one boolean expressions on either side of this operator must be true in order for the whole expression to be true.
  • || - This is the same as the OR boolean operator.
• Boolean expressions can be grouped together through the use of parenthesis.
  • ie. Expression1 AND (Expression2 OR Expression3) - This will only be true if expression1 and either expression2 and/or expression3 are also true.
• An additional single tick(') must be placed on both sides of the whole boolean expression.
• Advanced rules support regular expressions and wildcards. However, expressions with regex take a slightly different form. For example: (regex)%Weather=^.* x2$(/regex)
• You can perform simple math in advanced rules using the common operators.
  • If your math might result in a decimal, you must typecast to float.
• You can not pipe in the same way as you can in normal rules. Instead you must use regular expressions to pipe inside advanced rules.

When comparing values of different types, you need to typecast one of the values to the other. This is done by placing the desired type in parenthesis immediately prior to the value you want to type cast. For example, to type cast the time to a float so you can compare it you would use (float)%Time.

Note: Putting double quotes (”) around things automatically turns them into strings. Even if you typecast within the quotes, the quotes will make the end result a string. So for instance, you would have to do advanced='%tp < 100'. If you did advanced='”%tp” < “100”', you would get true for almost any value. Since alphabetically speaking, 11 is higher than 100.

For a list of the variables available to advanced rules, click here.

<if Advanced='"%MainJob"="WHM" and ("%SubJob"="SMN" or "%SubJob"="BLM")'>
	<action type="addtochat">Mainjob is WHM and subjob is SMN or BLM!</action>
</if>

Below you can find example rule sections for common things used.

HQ Staff rule (Place the sections into the corresponding sections in your XML – Not a direct copy and paste!) 1)

<!--Have $SetStaff inside of a set-->
<set name="standard">
	<main>$SetStaff</main>
</set>
<!--Create Variables for all your staves, and one to be changed-->
<variables>
	<var name="SetStaff">Apollo's Staff</var>
	<var name="Light">"Apollo's Staff"</var>
	<var name="Dark">"Pluto's Staff"</var>
	<var name="Earth">"Terra's Staff"</var>
	<var name="Water">"Neptune's Staff"</var>
	<var name="Wind">"Auster's Staff"</var>
	<var name="Fire">"Vulcan's Staff"</var>
	<var name="Ice">"Aquillo's Staff"</var>
	<var name="Thunder">"Jupiter's Staff"</var>
</variables>
<!--Insert action inside of your rule-->
<rules>
	<if skill="ElementalMagic"> 
		<!--%SpellElement will process first. If ThunderIV is cast then $SetStaff will be set to $Thunder -->
		<action type="Var" cmd="set SetStaff $%SpellElement" /> 
	</if>
<rules>

Obi Rules (Place the sections into the corresponding sections in your XML – Not a direct copy and paste!)

<variables>
  <!--Corresponding Obi per element-->
  <var Name="EarthObi">Dorin Obi</var>
  <var Name="ThunderObi">Rairin Obi</var>
  <var Name="WaterObi">Suirin Obi</var>
  <var Name="FireObi">Karin Obi</var>	
  <var Name="IceObi">Suirin Obi</var>
  <var Name="WindObi">Furin Obi</var>
  <var Name="LightObi">Korin Obi</var>
  <var Name="DarkObi">Anrin Obi</var>
</variables>
 
<rules>
  <!--  Equip The right obi based on weather(and scholar storm) or day-->
  <if Advanced='"%SpellElement" = "%WeatherElement" OR "%SpellElement" = "%DayElement"'> 
    <!--Equip your weather/day related gear here.-->
    <action Type="Equip" When="MidCast"> 
      <waist Lock="Yes">$%SpellElementObi</waist> 
      <!--An alternative would have been to define sets by these names and only parse once-->
    </action> 
  </if>
</rules>

Basic Utsu: Ichi rule to cancel shadows (Place sections into corresponding sections within your XML)

<!-- Rule for auto-canceling of shadows during Utsusemi: Ichi cast-->
<if spell="Utsusemi: Ichi">
	<action type="Equip" when="precast" set="Evasion" />
	<!--Utsusemi:Ichi cast time is 4 sec-->
	<!--This may be conservative and it may not always be enough. I have seen delay 3 work-->
	<!--Find a delay value that YOU are comfortable relying upon-->
	<action type="midcastdelay" delay="2.5" />
	<!--Cancel currently active shadows(Buff_Id 66). Technically only need for Ni to Ichi, but no way to tell-->
	<action type="Command" when="midcast">cancel 66</action> 
</if>