Server options: Difference between revisions
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
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]]. | 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. | 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. | ||
| Line 6: | Line 9: | ||
Lines beginning with # are not parsed, and can be used for comments. | 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 | startlevel=level name | ||
startx=number | startx=number | ||
starty=number | starty=number | ||
This sets the originating location for all | 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 | unstickmelevel=level name | ||
unstickmex=number | unstickmex=number | ||
unstickmey=number | unstickmey=number | ||
These define the position that a | 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 | 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 | jaillevels=level names comma separated | ||
Non-staff players in these levels will not be able to leave them. A | 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 | noexplosions=true/false | ||
Disables the result of putexplosion, and `explosive' weapons. | Disables the result of [[Old GScript:putexplosion|putexplosion]], and `explosive' [[NPC weapons]]. | ||
=== | === Statistic Restriction === | ||
setbodyallowed=true/false | setbodyallowed=true/false | ||
setheadallowed=true/false | setheadallowed=true/false | ||
| Line 44: | Line 49: | ||
setshieldallowed=true/false | setshieldallowed=true/false | ||
Whether the chat commands to change the player's appearance are enabled. Defaults to true. | Whether the chat commands to change the player's [[Appearance commands|appearance]] are enabled. Defaults to true. | ||
=== | === Gralat Loss Options === | ||
mindeathgralats=number | mindeathgralats=number | ||
maxdeathgralats=number | maxdeathgralats=number | ||
Defines the amount of | Defines the amount of [[Gralat]]s that the player drops on death. | ||
=== | === Staff Gralat Restriction === | ||
normaladminscanchangegralats=true/false | normaladminscanchangegralats=true/false | ||
Whether normal | 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 | staffguilds=comma seperated list of guild names | ||
Matches to these | Matches to these [[Guild]] names appear in the `Staff' section of the playerlist ([[Delphi Client]] only for now) | ||
=== | === `Bush' Items === | ||
bushitems=true/false | bushitems=true/false | ||
Selects whether | Selects whether [[Bush]]es contain [[Item]]s. May not work on a [[GMap]]. | ||
=== | === `Baddy' Items === | ||
baddyitems=true/false | baddyitems=true/false | ||
Selects whether baddies drop | Selects whether [[Baddy|baddies]] drop [[Item]]s once killed. | ||
=== | === `Healing' Swords === | ||
healswords=true/false | healswords=true/false | ||
Selects whether is possible to have a negative | 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 | respawntime=number | ||
horselifetime=number | horselifetime=number | ||
baddyrespawntime=number | baddyrespawntime=number | ||
Timeout in seconds for respawn times | Timeout in seconds for respawn times for [[Bush]]es, [[Horse]]es and [[Baddy|Baddies]] | ||
=== | === Server Scripting Flags === | ||
dontaddserverflags=true/false | dontaddserverflags=true/false | ||
Selects whether scripts can add new | Selects whether [[GScript|scripts]] can add new [[Server flag]]s or only modify existing ones. | ||
=== | === Server Maps === | ||
bigmap=maptext,mapimage,defaultx,defaulty | bigmap=maptext,mapimage,defaultx,defaulty | ||
minimap=maptext,mapimage,defaultx,defaulty | minimap=maptext,mapimage,defaultx,defaulty | ||
Default serverwide | Default serverwide [[Map]]s. Syntax resembles [[Old GScript:setmap|setmap]] and [[Old GScript:setminimap|setminimap]] [[GScript]] commands. | ||
=== | === Warping (All Players) === | ||
warptoforall=true/false | warptoforall=true/false | ||
warptoforlowadmins=true/false | |||
Whether all | Whether all [[Player]] can use the [[Warpto]] command, and whether [[Global]] [[Admin level]] 1 allows warpto. | ||
=== Ghost Mode === | |||
=== | |||
ghostmodeenabled=true/false | ghostmodeenabled=true/false | ||
ghostmodefornotstaff=true/false | ghostmodefornotstaff=true/false | ||
Selects whether all | 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 | playerlisticons=comma seperated list of statusses | ||
Possible status list, | 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 | profilevars=comma seperated list of profile variables | ||
Selects what is to be displayed in a | 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 | limitfreeplayers2=true/false | ||
Selects whether to disable adding of | Selects whether to disable adding of [[Bomb]]s, [[Arrow]]s, and [[Explosion]]s for [[Trial account]]s. | ||
=== | === AP System Activation === | ||
apsystem=true/false | apsystem=true/false | ||
Whether the AP system is enabled. If yes, there are some restrictions for | 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 | globalguilds=true/false | ||
Allows or disallows | Allows or disallows [[Guild]] from the [[Global]] database. This is normally enabled. | ||
=== | === AP Timeouts === | ||
aptime0=number | aptime0=number | ||
aptime1=number | aptime1=number | ||
| Line 148: | Line 149: | ||
aptime4=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. | 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 | heartlimit=number | ||
swordlimit=number | swordlimit=number | ||
The maximum amount of fullhearts and swordpower that is allowed. | The maximum amount of fullhearts and swordpower that is allowed. | ||
=== | === 'putnpc' Scripting Command === | ||
putnpcenabled=true/false | putnpcenabled=true/false | ||
Whether the putnpc command is enabled. (Mostly | Whether the [[Old GScript:putnpc|putnpc]] command is enabled. (Mostly [[Deprecated]]) | ||
=== | === Translation === | ||
enabletranslations=true/false | enabletranslations=true/false | ||
Selects whether the | Selects whether the [[Translation system]] is enabled. | ||
(TODO: Move this to the aforelinked article, or gscript articles:) If yes, signs and text in [[GScript|scripts]] in #U(text goes here) form will be saved in a text file where they can be translated into different languages. The files are to be found in the translations/ folder on [[RC]]. | |||
=== | |||
=== Language Selection === | |||
translatedlanguages=comma seperated list of languages, like Deutsch,... | translatedlanguages=comma seperated list of languages, like Deutsch,... | ||
The languages of which a translation file shall be loaded by the server. If a file exists, signs and #U() text will be replaced with values from this file. | The languages of which a [[Translation system|translation]] file shall be loaded by the server. (TODO: See above:) If a file exists, signs and #U() text will be replaced with values from this file. | ||
=== | === Server Language === | ||
serverlanguage=language name | serverlanguage=language name | ||
The default language of the | The default [[Translation system|language]] of the [[Playerworld]]. Defaults to English. | ||
=== | === NPC-Server 'Sleep' === | ||
sleepwhennoplayers=true/false | sleepwhennoplayers=true/false | ||
Whether the NPC | Whether the [[NPC Server]] must execute [[GScript|scripts]] even when no [[Player]] is around. | ||
=== | === Tilesets === | ||
newtilesets=true/false | newtilesets=true/false | ||
newtilesetlevels=comma seperated list of levels | newtilesetlevels=comma seperated list of levels | ||
Whether all | Whether all [[Level]]s will use the new [[Tileset]] layout, or a match list of levels that shall. (Mostly [[Deprecated]]) | ||
=== | === Staff === | ||
staff=comma seperated list of account names | staff=comma seperated list of account names | ||
The | 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 right]s 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 | gmaps=comma seperated list of gmap files, without .gmap extension | ||
The server will attempt to load these as | 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 | weaponorder=comma seperated list of weapon names | ||
Specifies the order in which the weapon scripts will be sent to the 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. | 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 | npcrights=true/false | ||
Whether [[NC rights]] are active. For security reasons, it is strongly [[Deprecated]] to set this to false. | |||
=== | === Kill Count === | ||
dontchangekills=true/false | dontchangekills=true/false | ||
Selects whether the | Selects whether the [[Player]]'s [[Kills|kill count]] is changed for each kill. | ||
=== | === NPC-Server Nickname === | ||
nickname=string | nickname=string | ||
The NPC Server will use this as its | The [[NPC Server]] will use this as its [[Nick name]], with (Server) appended. Ignores all [[Guild]] tags. | ||
=== | === Speedhack Tolerance === | ||
speedhacktolerance=number | speedhacktolerance=number | ||
This gives the percentage of data packages that clients may send above the expected over without being logged as | 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 | disconnectifnotmoved=true/false | ||
Selects whether | Selects whether [[Idle]] [[Player]]s are automatically disconnected. (Possibly deprecated). | ||
=== | === Save Levels === | ||
savelevels=true/false | savelevels=true/false | ||
Setting this to true allows changes to the | 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. Currently, this does not work with [[GMap]]s. | ||
Revision as of 19:06, 21 December 2004
The server options are a collection of key=value configuration options that allow you to customize the non-scriptable 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 Players which do not have location statistics of their own saved 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 weapons 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 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-staff players in these levels will not be able to leave them. A Serverside setlevel2 or warping with RC is neccessary. Also, they can send PMs only to RC clients and not regular Clients.
Explosion Restriction
noexplosions=true/false
Disables the result of 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 are enabled. Defaults to true.
Gralat Loss Options
mindeathgralats=number maxdeathgralats=number
Defines the amount of Gralats that the player drops on death.
Staff Gralat Restriction
normaladminscanchangegralats=true/false
Whether normal RCs 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 rights.
Local 'Staff Guilds'
staffguilds=comma seperated list of guild names
Matches to these Guild names appear in the `Staff' section of the playerlist (Delphi Client only for now)
`Bush' Items
bushitems=true/false
Selects whether Bushes contain Items. May not work on a GMap.
`Baddy' Items
baddyitems=true/false
Selects whether baddies drop Items once killed.
`Healing' Swords
healswords=true/false
Selects whether is possible to have a negative Sword power and thus add Hearts to those hit by the sword.
Non-script timeouts
respawntime=number horselifetime=number baddyrespawntime=number
Timeout in seconds for respawn times for Bushes, Horsees and Baddies
Server Scripting Flags
dontaddserverflags=true/false
Selects whether scripts can add new Server flags or only modify existing ones.
Server Maps
bigmap=maptext,mapimage,defaultx,defaulty minimap=maptext,mapimage,defaultx,defaulty
Default serverwide Maps. Syntax resembles setmap and setminimap GScript commands.
Warping (All Players)
warptoforall=true/false warptoforlowadmins=true/false
Whether all Player can use the Warpto command, and whether Global Admin level 1 allows warpto.
Ghost Mode
ghostmodeenabled=true/false ghostmodefornotstaff=true/false
Selects whether all Players appear as Ghost, or only non-staff players, or nobody.
Playerlist Icons
playerlisticons=comma seperated list of statusses
Possible status list, Players 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 Bombs, Arrows, and Explosions for Trial accounts.
AP System Activation
apsystem=true/false
Whether the AP system is enabled. If yes, there are some restrictions for Players with low AP regarding hearts.
Starting AP
startap=number
How much AP Players 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.
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 putnpc command is enabled. (Mostly Deprecated)
Translation
enabletranslations=true/false
Selects whether the Translation system is enabled. (TODO: Move this to the aforelinked article, or gscript articles:) If yes, signs and text in scripts in #U(text goes here) form will be saved in a text file where they can be translated into different languages. The files are to be found in the translations/ folder on RC.
Language Selection
translatedlanguages=comma seperated list of languages, like Deutsch,...
The languages of which a translation file shall be loaded by the server. (TODO: See above:) If a file exists, signs and #U() text will be replaced with values from this file.
Server Language
serverlanguage=language name
The default language of the Playerworld. Defaults to English.
NPC-Server 'Sleep'
sleepwhennoplayers=true/false
Whether the NPC Server must execute scripts even when no Player is around.
Tilesets
newtilesets=true/false newtilesetlevels=comma seperated list of levels
Whether all Levels will use the new Tileset layout, or a match list of levels that shall. (Mostly Deprecated)
Staff
staff=comma seperated list of account names
The Accounts in this list will count as Playerworld staff as if their admin level was > 0. Their mass messages override the option to ignore mass messages, their [[Admin right]s 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 GMaps. 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 scripts will be sent to the 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 Deprecated to set this to false.
Kill Count
dontchangekills=true/false
Selects whether the Player's kill count is changed for each kill.
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 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 Players are automatically disconnected. (Possibly deprecated).
Save Levels
savelevels=true/false
Setting this to true allows changes to the Tiles of Levels to be saved to the actual level files from scripting commands, so it is possible to persistently change the levels. Currently, this does not work with GMaps.