manaserv.xml [Mana Documentation]

- manaserv.xml file configuration
  - Database backends configuration
  - Account server configuration

manaserv.xml file configuration

Data from the manaserv.xml file or .manaserv.xml store central configuration values for the account and the game servers. Each configuration option is defined using an <option> tag within the <configuration> main node, for instance:

manaserv.xml sample

 <?xml version="1.0"?>
 <configuration>
    <option name="net_accountServerAddress" value="localhost"/>
    <option name="net_accountServerPort" value="9601"/>
 </configuration>

Database backends configuration

SQLite

The SQLite database system uses only one parameter, defining where the database (.db) file is to be found. Note that the file automatically created if not found.

Option name	Mandatory	Default value	Description
sqlite_database	No	./mana.db	Database filename including absolute or relative path.

mySQL

Option name	Mandatory	Default value	Description
mysql_hostname	No	localhost	IP or Database Hostname
mysql_port	No	3306	MySQL server Port
mysql_database	No	mana	Database name
mysql_username	No	mana	Username used for the database credentials
mysql_password	No	””	Password used for the database credentials

PostgreSQL

FIXME : Add PostgreSQL.

Account server configuration

Players start point

Option name	Mandatory	Description
char_startMap	Yes	Map ID used by the account server See: maps.xml
char_startX	Yes	X pixel start coordinate on the start map.
char_startY	Yes	Y pixel start coordinate on the start map.

Network configuration

Option name	Mandatory	Default value	Description
net_accountServerAddress	No	localhost	The IP or hostname the account server will listen to.
net_accountServerPort	No	9601	Port used by the account server. Note that the account server will listen to the game server on <net_accountServerPort> + 1, and to the chat server on <net_accountServerPort> + 2.
net_gameServerAddress	No	localhost	IP Address or hostname used by the game server, but also by the account server to listen to.
net_gameServerPort	No	9604	Port used by the game server to listen to.
net_maxClients	No	1000	Total simultaneous allowed client connections.
net_password	No	P@s$w0rd	Password used between the account and the game server to authenticates queries (Very important in order not to get hacked easily.
defaultUpdateHost	No	””	The Update host hostname or IP address given to the client, used to download updates data.

Data localisation

Option name	Mandatory	Default value	Description
serverPath	No	”.”	The location of manaserv. Used mainly to find the Lua libraries provided by manaserv.
clientDataPath	No	“example/clientdata”	The default data folder used for client data shared with the server. In many case, you'll still want to keep the server data as a whole and not share those with the client. You can set this value to ”” in that case.
serverDataPath	No	“example/serverdata”	The server data folder. Previously hard-coded to “data”. Note: The server data and client data are merged to get the server running, using PhysFS. If the same file is provided by both folders, the server data will prevail.

Account settings

Option name	Mandatory	Default value	Description
account_allowRegister	No	1	Tells if the registration can be done via a manaserv client (1), or not (0).
account_denyRegisterReason	No	””	Message displayed if the registration is denied. (For instance, the URL to the web interface in which you can actually register.)
account_minNameLength	No	4	Account names minimal length.
account_maxNameLength	No	16	Account names maximal length.

Note: The Client currently only uses the default values.

Avatars settings

Option name	Mandatory	Default value	Description
char_numHairStyles	No	15	Number of available Hairstyles.
char_numHairColors	No	9	Number of available Hair colors.
char_numGenders	No	2	Number of available gender types.
char_minNameLength	No	4	Characters' names minimal length.
char_maxNameLength	No	25	Characters' names maximal length.
char_maxCharacters	No	3	Maximal number of characters per account.
char_startingPoints	No	60	Number of attribute points available at character creation.

Note: The Client currently only uses the default values.

Gameplay Options

Option name	Mandatory	Default value	Description
visualRange	No	320	Range around the player in pixels for which the game server send state updates to the client. (Defines the client view range.)
respawnMap	Yes		Map ID where the character will respawn if he/she dies. See: maps.xml
respawnX	Yes		X coordinate of the spawn point on the respawn map.
respawnY	Yes		X coordinate of the spawn point on the respawn map.
defaultPvp	No	“none”	Standard PVP¹⁾ mode on maps which have not set any corresponding properties. Available options are: “none”: No PVP. “free”: PVP fully enabled.
maxSkillCap	No		Option indicating if a configurable hard cap based on the skill level is to be set.
floorItemDecayTime	No	0	Time in seconds until items laying on the floor disappear. Set to 0 to make items lay on the floor indefinitely (while this would be the “realistic” setting keep in mind that it will make your game world look like a garbage dump in the long run).
hpRegenBreakAfterHit	No	0	Sets the time in ticks²⁾ before the player HP regeneration starts again when fighting.

Mail System Options

Option name	Mandatory	Default value	Description
mail_maxAttachments	No	3	Mails maximal number of attachments.
mail_maxLetters	No	10	Mails maximum number of digits (or characters).

¹⁾ PVP: Player Versus Player. Defines if a player can deal damage to another one.

²⁾ A tick is a server cycle, currently set to 100ms