The '''server options''' are a collection of key=value configuration options that allow you to customize the non-[[GScript|script]]able behaviour of an individual [[Playerworld]].

== Usage ==

Options are usually set only by high [[Playerworld staff]], preferably only the [[Playerworld owner]], as they are very powerful and can be abused easily.

When you omit an option, its value will not be changed if the option has been used before. Therefore, it is more secure to change only the value and not whole option, should you need to change something.

Lines beginning with # are not parsed, and can be used for comments.

== Known Server Options ==

Please add new options if you discover them.

=== Start location ===
startlevel=level name
startx=number
starty=number

This sets the originating location for all [[Player]]s which do not have location statistics of their own saved [[Local|locally]].

=== Unstick me location ===
unstickmelevel=level name
unstickmex=number
unstickmey=number

These define the position that a [[Player]] is warped to after using the [[Unstick me]] command.

=== Protected Weapons ===
protectedweapons=list of comma seperated weapon names

[[NPC weapon]]s that cannot be deleted by the [[Player]]. This differs from weapons with asterisk prefixed name which cannot be deleted with the Del key, but still can be deleted on the [[Clientside]] using the [[Old GScript:destroy|destroy]] command. `Protected' weapons can (unless *ified) be deleted with Del, but the NPC server will not remove them from the player's weapon list and thus the [[Serverside]] part will remain and the player obtains them again on the next connect.

=== Jail Levels ===
jaillevels=level names comma separated

Non-[[Playerworld staff|staff]] players in these levels will not be able to leave them. A [[Serverside]] [[Old GScript:setlevel2|setlevel2]] or warping with [[RC]] is neccessary. Also, they can send [[PM]]s only to RC clients and not regular [[Client]]s.
, ,

=== Explosion Restriction ===
noexplosions=true/false

Disables the result of [[Old GScript:putexplosion|putexplosion]], and `explosive' [[NPC weapons]].

=== Statistic Restriction ===
setbodyallowed=true/false
setheadallowed=true/false
setbomyallowed=true/false
setswordallowed=true/false
setshieldallowed=true/false

Whether the chat commands to change the player's [[Appearance commands|appearance]] are enabled. Defaults to true.

=== Gralat Loss Options ===
mindeathgralats=number
maxdeathgralats=number

Defines the amount of [[Gralat]]s that the player drops on death.

=== Staff Gralat Restriction ===
normaladminscanchangegralats=true/false

Whether normal [[RC]]s can change the gralat count of a player. `Normal' used to be defined as `below [[Adminlevel]] 4', but nowadays is probably regulated by certain high-level [[Admin right]]s.

=== Local 'Staff Guilds' ===
staffguilds=comma seperated list of guild names

Matches to these [[Guild]] names appear in the `Staff' section of the playerlist.

=== `Bush' Items ===
bushitems=true/false

Selects whether [[Bush]]es contain [[Item]]s. May not work on a [[GMap]].

=== `Baddy' Items ===
baddyitems=true/false

Selects whether [[Baddy|baddies]] drop [[Item]]s once killed.

=== `Healing' Swords ===
healswords=true/false

Selects whether is possible to have a negative [[Sword]] power and thus add [[Heart]]s to those hit by the sword.

=== Non-script timeouts ===
respawntime=number
horselifetime=number
baddyrespawntime=number

Timeout in seconds for respawn times for [[Bush]]es, [[Horse]]s and [[Baddy|Baddies]]

=== Server Scripting Flags ===
dontaddserverflags=true/false

Selects whether [[GScript|scripts]] can add new [[Server flag]]s or only modify existing ones.

=== Server Maps ===
bigmap=maptext,mapimage,defaultx,defaulty
minimap=maptext,mapimage,defaultx,defaulty

Default serverwide [[Map]]s. Syntax resembles [[Old GScript:setmap|setmap]] and [[Old GScript:setminimap|setminimap]] [[GScript]] commands.

=== Warping (All Players) ===
warptoforall=true/false
warptoforlowadmins=true/false

Whether all [[Player]]s can use the [[Warpto]] command, and whether [[Global]] [[Admin level]] 1 allows warpto.

=== Warping Activation ===
warpto=false/true
ignorewarpto=true/false

Allows or disallows the default [[Warpto]] command for all [[staff]], including [[Global]]s. This is normally enabled.

Note that warpto=false will show a "(warping is disabled)" error message to [[Player]], whereas ignorewarpto=true will treat [[Warpto]] commands as just normal chat text and display no error message.

The latter is good for replacing the default [[Warpto]] command with a scripted version.

=== Ghost Mode ===
ghostmodeenabled=true/false
ghostmodefornotstaff=true/false

Selects whether all [[Player]]s appear as [[Ghost]], or only non-[[Playerworld staff|staff]] players, or nobody.

=== Playerlist Icons ===
playerlisticons=comma seperated list of statusses

Possible status list, [[Player]]s can select one of them in the [[Players list]]. There must be a [[Downloadable]] file plisticonNAME.png available in a folder specified as `file' in [[Folder configuration]].

=== Profile Variables ===
profilevars=comma seperated list of profile variables

Selects what is to be displayed in a [[Player]]'s profile. The default variables are: playerkills, playerdeaths, playerfullhearts, playerrating, playerap, playerrupees, playerswordpower, canspin, largely modelled after [[Old GScript]]. Custom string variables can be added in the format `name=stringname'. If name is not specified, stringname is used.

=== Trial Account Limits ===
limitfreeplayers2=true/false

Selects whether to disable adding of [[Bomb]]s, [[Arrow]]s, and [[Explosion]]s for [[Trial account]]s.

=== AP System Activation ===
apsystem=true/false

Whether the [[AP]] system is enabled. If yes, there are some restrictions for [[Player]]s with low AP regarding hearts.

=== Starting AP ===
startap=number

How much [[AP]] [[Player]]s are given upon first login to this [[Playerworld]].

=== Global Guilds Activation ===
globalguilds=true/false

Allows or disallows [[Guild]] from the [[Global]] database. This is normally enabled.

allowedglobalguilds=guild,guild,guild

This option limits what guilds can be used from the [[Global Guilds]] database. (Note: globalguilds= needs to be set to false so other guilds besides the allowed can not be used.

=== AP Timeouts ===
aptime0=number
aptime1=number
aptime2=number
aptime3=number
aptime4=number

Time (in seconds) it takes to recharge one point of [[AP]] when the AP is currently below 20, 40, 60, 80 and 100 respectively. The defaults are 30, 90, 300, 600 and 1200.

=== Heart/Sword Limits ===
heartlimit=number
swordlimit=number

The maximum amount of fullhearts and swordpower that is allowed.

=== 'putnpc' Scripting Command ===
putnpcenabled=true/false

Whether the [[Old GScript:putnpc|putnpc]] command is enabled. (Mostly [[Deprecated]])

=== Language Selection ===
translatedlanguages=comma seperated list of language domains, like de,...

The languages of which a [[Translation system|translation]] file shall be loaded by the server. If a file exists, signs and _() text will be replaced with values from the translation file for this language. See [[Creation/Dev/Releases/Client/5.006#Translation_System|Graal v5 release notes]] for more.

=== Server Language ===
serverlanguage=language domain

The default [[Translation system|language]] of the [[Playerworld]]. Defaults to English.

=== Default Language ===
defaultlanguage=language domain

The default [[Translation system|language]] of the [[Playerworld]]. Defaults to English. Players see text in this language if their language is not in ''translatedlanguages''.

=== NPC-Server 'Sleep' ===
sleepwhennoplayers=true/false

Whether the [[NPC Server]] must execute [[GScript|scripts]] even when no [[Player]] is around.

=== Tilesets ===
newtilesets=true/false
newtilesetlevels=comma seperated list of levels

Whether all [[Level]]s will use the new [[Tileset]] layout, or a match list of levels that shall.

=== Staff ===
staff=xRudyx,

The [[Account]]s in this list will count as [[Playerworld staff]] as if their admin level was > 0. Their [[PM|mass messages]] override the option to ignore mass messages, their [[Admin rights]] will be applied, and if their [[IP address range]] matches their actual IP address, they may log in to [[RC]].

=== GMAP List ===
gmaps=comma seperated list of gmap files, without .gmap extension

The server will attempt to load these as [[GMap]]s. As this line might get rather crowded, it is possible to have multiple gmaps= lines.

=== Weapon Order ===
weaponorder=comma seperated list of weapon names

Specifies the order in which the [[NPC weapon]] [[GScript|scripts]] will be sent to the [[Clientside|client]] upon connection. This can be used to ensure that the inventory script that disables the [[Q menu]] will be sent first, for example. First, all weapons in this list will be sent in order, then all unlisted weapons.

=== NPC-Control Rights ===
npcrights=true/false

Whether [[NC rights]] are active. For security reasons, it is strongly recommended to set this to true.

=== Kill Count ===
dontchangekills=true/false

Selects whether the variables 'playerkills' and 'playerdeaths' can be changed [[serverside]] via [[GScript]].

=== NPC-Server Nickname ===
nickname=string

The [[NPC Server]] will use this as its [[Nick name]], with (Server) appended. Ignores all [[Guild]] tags.

=== Speedhack Tolerance ===
speedhacktolerance=number

This gives the percentage of data packages that [[Clientside|clients]] may send above the expected over without being logged as [[Trainer users]]. On [[Graal Kingdoms]], the rather conservative setting of 90 is used. If you set this too low, your server will crash.

=== Idle Disconnect ===
disconnectifnotmoved=true/false

Selects whether [[Idle]] [[Player]]s are automatically disconnected. (Possibly deprecated).

=== Save Levels ===
savelevels=true/false

Setting this to true allows changes to the [[Tile]]s of [[Level]]s to be saved to the actual level files from [[GScript|scripting]] commands, so it is possible to persistently change the levels.

savelevelsmessage=true/false

Specifies if saving of levels should be reported on the RC chat (by default enabled).

=== Staff Only ===
onlystaff=true/false

Setting this to true allows only staff of the server to log on.

=== Log script function calls ===
scriptlogfunctions=write player.nick,write player.guild,call sendtonc,call sendtorc

This lets the npcserver log script activity into logs/scriptfunctionslog.txt. You
can get a list of available functons / actions by typing ''/listscriptlogfunctions''
on RC chat. Currently only important or exploitable things can be logged. Keep care
to delete the logs from time to time.

=== Log script errors to file ===
logscripterrorstofile=true/false

When enabled, all script errors (e.g. missing server-side script functions) will be logged into logs/scripterrors.txt instead of RC chat.

=== Level Auto-Save ===
levelsautosave=true/false
Whether or not updateboard2 changes are saved to the level file automatically (by default true). Works only if 'savelevels' is enabled as well.

=== Client RC Restriction ===
restrictclientrctoweapons=comma seperated list of weapon names
Specifies [[NPC weapon]] [[GScript|scripts]] that can use client [[RC]].

Server options

2007-11-24T03:40:04Z

Destructo104: /* Staff */

The '''server options''' are a collection of key=value configuration options that allow you to customize the non-[[GScript|script]]able behaviour of an individual [[Playerworld]].

== Usage ==

Options are usually set only by high [[Playerworld staff]], preferably only the [[Playerworld owner]], as they are very powerful and can be abused easily.

When you omit an option, its value will not be changed if the option has been used before. Therefore, it is more secure to change only the value and not whole option, should you need to change something.

Lines beginning with # are not parsed, and can be used for comments.

== Known Server Options ==

Please add new options if you discover them.

=== Start location ===
startlevel=level name
startx=number
starty=number

This sets the originating location for all [[Player]]s which do not have location statistics of their own saved [[Local|locally]].

=== Unstick me location ===
unstickmelevel=level name
unstickmex=number
unstickmey=number

These define the position that a [[Player]] is warped to after using the [[Unstick me]] command.

=== Protected Weapons ===
protectedweapons=list of comma seperated weapon names

[[NPC weapon]]s that cannot be deleted by the [[Player]]. This differs from weapons with asterisk prefixed name which cannot be deleted with the Del key, but still can be deleted on the [[Clientside]] using the [[Old GScript:destroy|destroy]] command. `Protected' weapons can (unless *ified) be deleted with Del, but the NPC server will not remove them from the player's weapon list and thus the [[Serverside]] part will remain and the player obtains them again on the next connect.

=== Jail Levels ===
jaillevels=level names comma separated

Non-[[Playerworld staff|staff]] players in these levels will not be able to leave them. A [[Serverside]] [[Old GScript:setlevel2|setlevel2]] or warping with [[RC]] is neccessary. Also, they can send [[PM]]s only to RC clients and not regular [[Client]]s.
, ,

=== Explosion Restriction ===
noexplosions=true/false

Disables the result of [[Old GScript:putexplosion|putexplosion]], and `explosive' [[NPC weapons]].

=== Statistic Restriction ===
setbodyallowed=true/false
setheadallowed=true/false
setbomyallowed=true/false
setswordallowed=true/false
setshieldallowed=true/false

Whether the chat commands to change the player's [[Appearance commands|appearance]] are enabled. Defaults to true.

=== Gralat Loss Options ===
mindeathgralats=number
maxdeathgralats=number

Defines the amount of [[Gralat]]s that the player drops on death.

=== Staff Gralat Restriction ===
normaladminscanchangegralats=true/false

Whether normal [[RC]]s can change the gralat count of a player. `Normal' used to be defined as `below [[Adminlevel]] 4', but nowadays is probably regulated by certain high-level [[Admin right]]s.

=== Local 'Staff Guilds' ===
staffguilds=comma seperated list of guild names

Matches to these [[Guild]] names appear in the `Staff' section of the playerlist.

=== `Bush' Items ===
bushitems=true/false

Selects whether [[Bush]]es contain [[Item]]s. May not work on a [[GMap]].

=== `Baddy' Items ===
baddyitems=true/false

Selects whether [[Baddy|baddies]] drop [[Item]]s once killed.

=== `Healing' Swords ===
healswords=true/false

Selects whether is possible to have a negative [[Sword]] power and thus add [[Heart]]s to those hit by the sword.

=== Non-script timeouts ===
respawntime=number
horselifetime=number
baddyrespawntime=number

Timeout in seconds for respawn times for [[Bush]]es, [[Horse]]s and [[Baddy|Baddies]]

=== Server Scripting Flags ===
dontaddserverflags=true/false

Selects whether [[GScript|scripts]] can add new [[Server flag]]s or only modify existing ones.

=== Server Maps ===
bigmap=maptext,mapimage,defaultx,defaulty
minimap=maptext,mapimage,defaultx,defaulty

Default serverwide [[Map]]s. Syntax resembles [[Old GScript:setmap|setmap]] and [[Old GScript:setminimap|setminimap]] [[GScript]] commands.

=== Warping (All Players) ===
warptoforall=true/false
warptoforlowadmins=true/false

Whether all [[Player]]s can use the [[Warpto]] command, and whether [[Global]] [[Admin level]] 1 allows warpto.

=== Warping Activation ===
warpto=false/true
ignorewarpto=true/false

Allows or disallows the default [[Warpto]] command for all [[staff]], including [[Global]]s. This is normally enabled.

Note that warpto=false will show a "(warping is disabled)" error message to [[Player]], whereas ignorewarpto=true will treat [[Warpto]] commands as just normal chat text and display no error message.

The latter is good for replacing the default [[Warpto]] command with a scripted version.

=== Ghost Mode ===
ghostmodeenabled=true/false
ghostmodefornotstaff=true/false

Selects whether all [[Player]]s appear as [[Ghost]], or only non-[[Playerworld staff|staff]] players, or nobody.

=== Playerlist Icons ===
playerlisticons=comma seperated list of statusses

Possible status list, [[Player]]s can select one of them in the [[Players list]]. There must be a [[Downloadable]] file plisticonNAME.png available in a folder specified as `file' in [[Folder configuration]].

=== Profile Variables ===
profilevars=comma seperated list of profile variables

Selects what is to be displayed in a [[Player]]'s profile. The default variables are: playerkills, playerdeaths, playerfullhearts, playerrating, playerap, playerrupees, playerswordpower, canspin, largely modelled after [[Old GScript]]. Custom string variables can be added in the format `name=stringname'. If name is not specified, stringname is used.

=== Trial Account Limits ===
limitfreeplayers2=true/false

Selects whether to disable adding of [[Bomb]]s, [[Arrow]]s, and [[Explosion]]s for [[Trial account]]s.

=== AP System Activation ===
apsystem=true/false

Whether the [[AP]] system is enabled. If yes, there are some restrictions for [[Player]]s with low AP regarding hearts.

=== Starting AP ===
startap=number

How much [[AP]] [[Player]]s are given upon first login to this [[Playerworld]].

=== Global Guilds Activation ===
globalguilds=true/false

Allows or disallows [[Guild]] from the [[Global]] database. This is normally enabled.

allowedglobalguilds=guild,guild,guild

This option limits what guilds can be used from the [[Global Guilds]] database. (Note: globalguilds= needs to be set to false so other guilds besides the allowed can not be used.

=== AP Timeouts ===
aptime0=number
aptime1=number
aptime2=number
aptime3=number
aptime4=number

Time (in seconds) it takes to recharge one point of [[AP]] when the AP is currently below 20, 40, 60, 80 and 100 respectively. The defaults are 30, 90, 300, 600 and 1200.

=== Heart/Sword Limits ===
heartlimit=number
swordlimit=number

The maximum amount of fullhearts and swordpower that is allowed.

=== 'putnpc' Scripting Command ===
putnpcenabled=true/false

Whether the [[Old GScript:putnpc|putnpc]] command is enabled. (Mostly [[Deprecated]])

=== Language Selection ===
translatedlanguages=comma seperated list of language domains, like de,...

The languages of which a [[Translation system|translation]] file shall be loaded by the server. If a file exists, signs and _() text will be replaced with values from the translation file for this language. See [[Creation/Dev/Releases/Client/5.006#Translation_System|Graal v5 release notes]] for more.

=== Server Language ===
serverlanguage=language domain

The default [[Translation system|language]] of the [[Playerworld]]. Defaults to English.

=== Default Language ===
defaultlanguage=language domain

The default [[Translation system|language]] of the [[Playerworld]]. Defaults to English. Players see text in this language if their language is not in ''translatedlanguages''.

=== NPC-Server 'Sleep' ===
sleepwhennoplayers=true/false

Whether the [[NPC Server]] must execute [[GScript|scripts]] even when no [[Player]] is around.

=== Tilesets ===
newtilesets=true/false
newtilesetlevels=comma seperated list of levels

Whether all [[Level]]s will use the new [[Tileset]] layout, or a match list of levels that shall.

=== Staff ===
staff=xRudyx

The [[Account]]s in this list will count as [[Playerworld staff]] as if their admin level was > 0. Their [[PM|mass messages]] override the option to ignore mass messages, their [[Admin rights]] will be applied, and if their [[IP address range]] matches their actual IP address, they may log in to [[RC]].

=== GMAP List ===
gmaps=comma seperated list of gmap files, without .gmap extension

The server will attempt to load these as [[GMap]]s. As this line might get rather crowded, it is possible to have multiple gmaps= lines.

=== Weapon Order ===
weaponorder=comma seperated list of weapon names

Specifies the order in which the [[NPC weapon]] [[GScript|scripts]] will be sent to the [[Clientside|client]] upon connection. This can be used to ensure that the inventory script that disables the [[Q menu]] will be sent first, for example. First, all weapons in this list will be sent in order, then all unlisted weapons.

=== NPC-Control Rights ===
npcrights=true/false

Whether [[NC rights]] are active. For security reasons, it is strongly recommended to set this to true.

=== Kill Count ===
dontchangekills=true/false

Selects whether the variables 'playerkills' and 'playerdeaths' can be changed [[serverside]] via [[GScript]].

=== NPC-Server Nickname ===
nickname=string

The [[NPC Server]] will use this as its [[Nick name]], with (Server) appended. Ignores all [[Guild]] tags.

=== Speedhack Tolerance ===
speedhacktolerance=number

This gives the percentage of data packages that [[Clientside|clients]] may send above the expected over without being logged as [[Trainer users]]. On [[Graal Kingdoms]], the rather conservative setting of 90 is used. If you set this too low, your server will crash.

=== Idle Disconnect ===
disconnectifnotmoved=true/false

Selects whether [[Idle]] [[Player]]s are automatically disconnected. (Possibly deprecated).

=== Save Levels ===
savelevels=true/false

Setting this to true allows changes to the [[Tile]]s of [[Level]]s to be saved to the actual level files from [[GScript|scripting]] commands, so it is possible to persistently change the levels.

savelevelsmessage=true/false

Specifies if saving of levels should be reported on the RC chat (by default enabled).

=== Staff Only ===
onlystaff=true/false

Setting this to true allows only staff of the server to log on.

=== Log script function calls ===
scriptlogfunctions=write player.nick,write player.guild,call sendtonc,call sendtorc

This lets the npcserver log script activity into logs/scriptfunctionslog.txt. You
can get a list of available functons / actions by typing ''/listscriptlogfunctions''
on RC chat. Currently only important or exploitable things can be logged. Keep care
to delete the logs from time to time.

=== Log script errors to file ===
logscripterrorstofile=true/false

When enabled, all script errors (e.g. missing server-side script functions) will be logged into logs/scripterrors.txt instead of RC chat.

=== Level Auto-Save ===
levelsautosave=true/false
Whether or not updateboard2 changes are saved to the level file automatically (by default true). Works only if 'savelevels' is enabled as well.

=== Client RC Restriction ===
restrictclientrctoweapons=comma seperated list of weapon names
Specifies [[NPC weapon]] [[GScript|scripts]] that can use client [[RC]].