Usage : general

Usage

Download the latest build here, and put it in your plugins/ folder.

Once your server restarted, the bukkit command /pl should display UltimateSpellSystem in green.

Permissions

The permissions are really basic : to be allowed to manage spells, the permission uss.admin is required (OP by default).

Commands

All commands are under the /uss shortcut. Here's a list of sub-commands :

• /uss reload : Reload the configuration and the spells folder definition.
• /uss list : List all spells loaded by the plugin Spell Manager.
• /uss purge : Purge all spell-entities, summons and tasks running by the plugin.
• /uss <enable | disable> <spell_id> : Enable or disable a specific spell. Transient.
• /uss cast <spell_id> : Cast a spell on yourself. Use it to debug your spells.
• /uss debug <spell_id> : Print the AST of a spell.
• /uss bind <spell_id> [condition] [trigger] : Bind a spell to your selected item in hand. It will modify its NBT to allow other players to cast it. Check the following section for more informations.
• /uss unbind [spell_id] : Unbind the spell in the item currently in hand. If no argument, remove all spells.
• /uss bind-check : Test if an item is bound to a spell.
• /uss status : Check version and integration status of USS.

Bind command

As mentionned before, the bind command takes the following arguments :

• The spell ID (mandatory),
• An optional condition,
• An optional trigger sequence.

If the last two elements are not specified, the values will be the one from the configuration.

Bind condition

A condition will define the condition for a spell to be cast by a player. The condition can be on the player himself, or the held item, or more.

Here's the list of included conditions. Don't forget that your plugin can register custom one.

Condition name	Arguments	Description
none	None	No condition, the bound spell can always be cast.
durability	amount (int)	Remove durability on the item. May destroy the item if the it does not have enough durability.
experience	amount (int), level (bool)	The player must have a certain level or raw experience points. The second argument is true if the unit is "level".
food-level	amount (int)	Amount of food-level to remove. If the player doesn't have enough, spell will not cast.
health	amount (double)	Amount of health to remove. If the player doesn't have enough, spell will not cast.
item-amount	amount (int)	Amount to remove on the item. Casting will fail is the held amount is not enough.
permission	value (string)	A permission the player is required to have to be able to cast the spell. This can be a safety with administration spells.

Bind trigger

After the condition, you may also set the sequence for a player to trigger the spell. You may have multiple of them, don't forget to use /uss bind-check to see them.

A trigger is a sequence of trigger-step. each step will be one of the following :

• attack : a left-click attack on a living entity.
• left_click : all left-clicks except for the attack.
  • left_click_block : only left click on blocks.
  • left_click_ait : only left click on air.
• right_click : all right-clicks.
  • right_click_block : only right click on blocks.
  • right_click_ait :
• sneak the sneak action (from standing to sneaking).

There is no limit of the amount of steps required.

Examples

On a "magic fire wand", you want "RRR" for a fireball, and "RRL" for a fire-tornado.

Each need a different durability cost.

/uss bind fireball durability 5 right_click right_click right_click

/uss bind fire_tornado durability 12 right_click right_click left_click

Unbind

To cleanse bindings from an item, do /uss unbind [spell_id], holding the item.

Test a spell

Simply do /uss cast <spell_id> to cast it on yourself.

Moreover, you can see the code of a spell with the /uss debug <spell_id> command.