equip.xml.md

title	layout
equip.xml	wiki

{% include toc.md %}

equip.xml

The equip.xml file is used to set up the different equipment slots for the player's characters in the game world.

Here is an example of the currently default equip.xml file:

{% highlight xml %}

{% endhighlight %}

`equip-slots` node
`slot` child node
Parameter name	Type	Required in client	Required in account-server	Required in game-server	Default value	Description
id	**integer**	yes	yes	yes	0	The equipment slot's id. This is internally used as a reference and must be unique and be \> 0.
name	**string**	yes	yes	yes	""	The equipment slot's name. This is internally used as a reference and **should really** be unique.
capacity	**integer**	yes	yes	yes	0	The number of available space in the slot. Especially useful for the hands slot for two-handed weapons for instance.
visible	**boolean**	yes	yes	yes	true	Whether the slot is visible on the player sprite. Invisible slots do not make the being look updates.
weapon	**boolean**	yes	yes	yes	false	Whether the slot is the weapon slot. This is used so that the engine knows which slots handle weapons. The 'weapon' slot should not be omitted.
ammo	**boolean**	yes	yes	yes	false	Whether the slot is the ammo slot. This is used so that the engine knows which slots handle ammo. The 'ammo' slot should not be omitted.
`box` child node
Box nodes are used to tell the client where to place the icon boxes indicating the actual equipment of the character in the equipment window, so you can tweak the display of your equipment to your need. There must be one `box` node per capacity value. The nodes are taken in the order they are written when loading the window.
x	**integer**	yes	no	no	0	The equipment box x pixel value, relative to the left of the equipment window.
y	**integer**	yes	no	no	0	The equipment box y pixel value, relative to the top of the equipment window.
background	**string**	yes	no	no	""	The equipment box background image filename. The filename must be relative to the theme root path, or `the data/graphics/gui` when none. The image size shouldn't be larger than 36x36 pixels.