paths.xml

The paths.xml file is used by the client to override default data paths and some default filenames not already handled by the branding file.

Here is a description of the currently available options:

Paths parameters

Here is a paths.xml file sample:

<?xml version="1.0"? encoding="utf-8">
<configuration>
    <option name="itemIcons" value="graphics/items/" />
    <option name="unknownItemFile" value="unknown-item.png" />
    <option name="sprites" value="graphics/sprites/" />
    <option name="spriteErrorFile" value="error.xml" />

    <option name="particles" value="graphics/particles/" />
    <option name="levelUpEffectFile" value="levelup.particle.xml" />
    <option name="portalEffectFile" value="warparea.particle.xml" />
    <option name="hitEffectId" value="26" />
    <option name="criticalHitEffectId" value="28" />

    <option name="minimaps" value="graphics/minimaps/" />
    <option name="maps" value="maps/" />

    <option name="sfx" value="sfx/" />
    <option name="attackSfxFile" value="fist-swish.ogg" />
    <option name="music" value="music/" />

    <option name="wallpapers" value="graphics/images/" />
    <option name="wallpaperFile" value="login_wallpaper.png" />
</configuration>

Note: The parameter names ending with 'File' are obviously for setting filenames. Other parameters are setting up paths. Also, note that folder parameters are ending with a '/'.

Parameter	Default value	Description
itemIcons	graphics/items/	Item icon path folder name.
unknownItemFile	unknown-item.png	Item image used for unknown items.
sprites	graphics/sprites/	Sprite files path.
spriteErrorFile	error.xml	XML file used when a sprite file isn't found.
particles	graphics/particles/	Particles files path.
levelUpEffectFile	levelup.particle.xml	XML file used for the level-up particle effect.
portalEffectFile	warparea.particle.xml	XML file used to show warp area particle effects.
hitEffectid	26	Default effect id to trigger when doing a successful hit with a weapon. This is an integer value, but it must refer to an effect having itself an actual path. See [effects.xml](effects.xml.md).
criticalHitEffectId	28	Default effect id to trigger when doing a successful critical hit with a weapon. This is an integer value, but it must refer to an effect having itself an actual path. See [effects.xml](effects.xml.md).
minimaps	graphics/minimaps/	Minimap files path.
maps	maps/	Map files path.
sfx	sfx/	sfx files path.
attackSfxFile	fist-swish.ogg	Default attack filename.
music	music/	Music files path.
wallpapers	graphics/images/	Wallpaper files path.
wallpaperFile	login_wallpaper.png	Default wallpaper filename.