Servers.cfg Explained: Difference between revisions

From OuroDev
 
Line 45: Line 45:
{{CLArg|AuthServer <strcpy> <atoi>|}}
{{CLArg|AuthServer <strcpy> <atoi>|}}
{{CLArg|LocalIp <strcpy>|}}
{{CLArg|LocalIp <strcpy>|}}
{{CLArg|SqlDbProvider <strcpy> (mssql, postgresql)|}}
{{CLArg|SqlDbProvider <strcpy>|Supported values:
: {{ms|mssql}}: Microsoft SQL Server.
: {{ms|postgresql}}: Experimental (and incomplete) PostgreSQL support.}}
{{CLArg|SqlDbName <strcpy>|}}
{{CLArg|SqlDbName <strcpy>|}}
{{CLArg|SqlLogin <strcpy>|}}
{{CLArg|SqlLogin <strcpy>|}}
{{CLArg|SqlInit <strcat>|}}
{{CLArg|SqlInit <strcat>|}}
{{CLArg|SqlAllowDDL <atoi>|}}
{{CLArg|SqlAllowDDL <atoi>|}}
{{CLArg|SqlAllowAllDDL <atoi>|}}
{{CLArg|SqlAllowAllDDL <atoi>|Alias of SqlAllowDDL}}
{{CLArg|SqlAddAttributes <atoi>|}}
{{CLArg|SqlAddAttributes <atoi>|Allow the SqlAddAttributes DDL command.}}
{{CLArg|SqlAddColumnOrTable <atoi>|}}
{{CLArg|SqlAddColumnOrTable <atoi>|Allow the SqlAddColumnOrTable DDL command.}}
{{CLArg|SqlDeleteColumnOrTable <atoi>|}}
{{CLArg|SqlDeleteColumnOrTable <atoi>|Allow the SqlDeleteColumnOrTable DDL command.}}
{{CLArg|SqlRebuildTable <atoi>|}}
{{CLArg|SqlRebuildTable <atoi>|Allow the SqlRebuildTable DDL command. This has the same effect as setting SqlAllowDDL.}}
{{CLArg|SqlAlterColumn <atoi>|}}
{{CLArg|SqlAlterColumn <atoi>|Allow the SqlAlterColumn DDL command.}}
{{CLArg|DefaultAccessLevel <atoi>|}}
{{CLArg|DefaultAccessLevel <atoi>|}}
{{CLArg|LogDir <strcpy>|}}
{{CLArg|LogDir <strcpy>|}}
{{CLArg|AssertMode <strcpy> (Minidump, Fulldump, Exit, NoTimestamp, NoDate, Zip, Ignore)|}}
{{CLArg|AssertMode <strcpy>|Set the behavior of assertion failures. Multiple modes can be specified if the argument is wrapped in quotes. Possible modes are:
{{CLArg|MaxPlayers <atoi> (less than 8191)|}}
{{CommandLineTable|
{{CLArg|Minidump|Create minidumps (.mdmp) on failure.}}
{{CLArg|Fulldump|Create full dumps (.dmp) on failure.}}
{{CLArg|Exit|Exit on failure.}}
{{CLArg|NoTimestamp|Don't name dump files with timestamps.}}
{{CLArg|NoDate|Same as {{ms|NoTimestamp}}.}}
{{CLArg|Zip|Zip the dump files.}}
{{CLArg|Ignore|Enable the ignore button on assertions.}}
}}}}
{{CLArg|MaxPlayers <atoi>|The maximum number of players that can be connected at any time. The maximum value is AUTH_SIZE_MAX (8191)}}
{{CLArg|LoginsPerMinute <atoi> (greater than 0)|}}
{{CLArg|LoginsPerMinute <atoi> (greater than 0)|}}
{{CLArg|MinPlayers <atoi>|}}
{{CLArg|MinPlayers <atoi>|}}
Line 84: Line 95:
{{CLArg|OfflineIdleDays <atoi>|}}
{{CLArg|OfflineIdleDays <atoi>|}}
{{CLArg|CompleteBrokenTasks <atoi>|}}
{{CLArg|CompleteBrokenTasks <atoi>|}}
{{CLArg|DroppedPacketLogging <atoi>|}}
{{CLArg|DroppedPacketLogging <atoi>|Log when packets are dropped or received out of order.}}
{{CLArg|AuthBadPacketReconnect <atoi>|}}
{{CLArg|AuthBadPacketReconnect <atoi>|}}
{{CLArg|BeaconMasterServer <strcpy>|}}
{{CLArg|BeaconMasterServer <strcpy>|Hostname for beaconserver.}}
{{CLArg|MasterBeaconServer <strcpy>|}}
{{CLArg|MasterBeaconServer <strcpy>|Alias of BeaconMasterServer.}}
{{CLArg|DoNotLaunchBeaconMasterServer <strcpy>|}}
{{CLArg|DoNotLaunchBeaconMasterServer <strcpy>|Don't launch beaconserver.}}
{{CLArg|DoNotLaunchMasterBeaconServer <strcpy>|}}
{{CLArg|DoNotLaunchMasterBeaconServer <strcpy>|Alias of DoNotLaunchBeaconMasterServer.}}
{{CLArg|BeaconRequestServerCount <atoi>|}}
{{CLArg|BeaconRequestServerCount <atoi>|Number of beaconrequestservers to launch. Negative values correspond to 2. Default is -1.}}
{{CLArg|RequestBeaconServerCount <atoi>|}}
{{CLArg|RequestBeaconServerCount <atoi>|Alias of BeaconRequestServerCount.}}
{{CLArg|DoNotPreloadCrashReportDLL <atoi>|}}
{{CLArg|DoNotPreloadCrashReportDLL <atoi>|}}
{{CLArg|BeaconRequestCacheDir <strncpy>|}}
{{CLArg|BeaconRequestCacheDir <strncpy>|}}
Line 98: Line 109:
{{CLArg|DoNotLaunchMapServerTSRs <atoi>|}}
{{CLArg|DoNotLaunchMapServerTSRs <atoi>|}}
{{CLArg|RaidTimeZoneDelta <atof>|}}
{{CLArg|RaidTimeZoneDelta <atof>|}}
{{CLArg|DisableContainerBackups <atoi>|}}
{{CLArg|DisableContainerBackups <atoi>|Disable on-disk container backups.}}
{{CLArg|XPScale <atof>|}}
{{CLArg|XPScale <atof>|Experience multiplier.}}
{{CLArg|AuctionInvMaxLastLoginDays <atoi>|}}
{{CLArg|AuctionInvMaxLastLoginDays <atoi>|Auction entries for accounts that have not logged in in this many days are not sent. Default is 60.}}
{{CLArg|AuthnameLimiterEnabled <atoi>|}}
{{CLArg|AuthnameLimiterEnabled <atoi>|}}
{{CLArg|AuthnameLimiterAccessLevel <atoi>|}}
{{CLArg|AuthnameLimiterAccessLevel <atoi>|}}
{{CLArg|BlockedMapKey <strncpy>|}}
{{CLArg|BlockedMapKey <strncpy>|A comma delimited list of map keys to not load.}}
{{CLArg|DisabledZoneEvents <strcpy>|}}
{{CLArg|DisabledZoneEvents <strcpy>|A comma delimited list of disabled zone events.}}
{{CLArg|ClientCommands <strcpy>|}}
{{CLArg|ClientCommands <strcpy>|}}
{{CLArg|MissionserverMaxSendQueueSize <atoi>|}}
{{CLArg|MissionserverMaxSendQueueSize <atoi>|The maximum amount of bytes allowed in the send queue to the [[missionserver]]. Default is {{ms|DB_MISSIONSERVER_MAX_SENDQUEUE_SIZE_DEFAULT}} (1000000).}}
{{CLArg|MissionserverMaxSendQueuePublishSize <atoi>|}}
{{CLArg|MissionserverMaxSendQueuePublishSize <atoi>|The maximum amount of bytes allowed in the publish queue to the [[missionserver]]. Default is {{ms|DB_MISSIONSERVER_MAX_SENDQUEUE_SIZE_DEFAULT}} (500000).}}
{{CLArg|Locale <atoi>|Must be an index or shorthand language code. Possible values:
{{CLArg|Locale <atoi>|Must be an index or shorthand language code. Possible values:
: {{ms|0/en}}: English
: {{ms|0/en}}: English
Line 118: Line 129:
: {{ms|7/es}}: Spanish}}
: {{ms|7/es}}: Spanish}}
{{CLArg|OverrideAuthBit <TODO: authUserData.c authUserSetFieldByName>|}}
{{CLArg|OverrideAuthBit <TODO: authUserData.c authUserSetFieldByName>|}}
{{CLArg|IsBetaShard <atoi>|Appended to MapServerParams as -IsBetaShard}}
{{CLArg|IsBetaShard <atoi>|On beta shards, users can use the broken mission fix every 10 minutes, rather than every 3 days. Appended to MapServerParams as -IsBetaShard.}}
{{CLArg|IsVIPShard <atoi>|}}
{{CLArg|IsVIPShard <atoi>|Whether or not this shard is a VIP shard. Only accounts marked as VIP can log into this shard. }}
{{CLArg|OwnsGoingRogue <atoi>|}}
{{CLArg|OwnsGoingRogue <atoi>|}}
{{CLArg|GoingRogueNagAndPurchase <atoi>|}}
{{CLArg|GoingRogueNagAndPurchase <atoi>|Show the nag dialogs and buy button for Going Rogue.}}
{{CLArg|KarmaEventHistoryDays <atoi>|}}
{{CLArg|KarmaEventHistoryDays <atoi>|How many days of past karma event history to read on load. Default is 30.}}
{{CLArg|NameLockTimeout <atoi> (> 600)|}}
{{CLArg|NameLockTimeout <atoi> (> 600)|}}
{{CLArg|SetLogLevel <atoi>|}}
{{CLArg|SetLogLevel <atoi>|}}
{{CLArg|IsLoggingMaster <atoi>|}}
{{CLArg|IsLoggingMaster <atoi>|If truthy, this server will propagate the configured loglevels to all of the connected servers.}}
{{CLArg|MARTYEnabled <atoi>|Appended to MapServerParams as -MARTY_enabled}}
{{CLArg|MARTYEnabled <atoi>|Enable/disable the MARTY anti-cheat. Appended to MapServerParams as -MARTY_enabled}}
{{CLArg|DebugSendPlayersDelayMS <atoi>|}}
{{CLArg|DebugSendPlayersDelayMS <atoi>|When sending the list of characters to a client, delay the SQL query by this many milliseconds.}}
{{CLArg|DefaultLoyaltyPointsFakeAuth <atoi>|}}
{{CLArg|DefaultLoyaltyPointsFakeAuth <atoi>|}}
{{CLArg|DefaultLoyaltyLegacyPointsFakeAuth <atoi>|}}
{{CLArg|DefaultLoyaltyLegacyPointsFakeAuth <atoi>|}}
{{CLArg|ForceOverloadProtection <atoi>|}}
{{CLArg|ForceOverloadProtection <atoi>|Forces overload protection to be enabled.}}
{{CLArg|OverloadProtection_LauncherHighWaterMarkPercent <atof>|}}
{{CLArg|OverloadProtection_LauncherHighWaterMarkPercent <atof>|Launcher upper bound for overload protection. When the percentage of launchers that cannot launch a server rises above this percentage, engage overload protection.}}
{{CLArg|OverloadProtection_LauncherLowWaterMarkPercent <atof>|}}
{{CLArg|OverloadProtection_LauncherLowWaterMarkPercent <atof>|Launcher lower bound for overload protection. When the percentage of launchers that cannot launch a server drops below this percentage, disengage overload protection.}}
{{CLArg|OverloadProtection_SQLQueueHighWaterMark <atoi>|}}
{{CLArg|OverloadProtection_SQLQueueHighWaterMark <atoi>|SQL upper bound for overload protection. When the size of the SQL queue grows larger than this, engage overload protection.}}
{{CLArg|OverloadProtection_SQLQueueLowWaterMark <atoi>|}}
{{CLArg|OverloadProtection_SQLQueueLowWaterMark <atoi>|SQL lower bound for overload protection. When the size of the SQL queue drops below this, disengage overload protection.}}
{{CLArg|MapserverIdleExit <atoi>|Appended to MapServerParams as -idleExitTimeout}}
{{CLArg|MapserverIdleExit <atoi>|Shut down mapservers if they are idle for this many minutes. Default is 0 (idle shutdown is disabled). Keep in mind that maps without Transient in their maps.db entry will never shut down, even after being idle. Appended to MapServerParams as -idleExitTimeout}}
{{CLArg|MapserverIdleUpkeep <atoi>|Appended to MapServerParams as -idleUpkeep}}
{{CLArg|MapserverIdleUpkeep <atoi>|Number of minutes a mapserver must be idle before performing idle maintenance. Idle maintenance will attempt to minimize the memory footprint of the mapserver by compacting the working set. Default is 20 minutes. Appended to MapServerParams as -idleUpkeep}}
{{CLArg|MapserverDailyUpkeep <atoi> (start 0-24) <atoi> (end 0-24)|Appended to MapServerParams as -dailyUpkeep <start> <end>}}
{{CLArg|MapserverDailyUpkeep <atoi> (start 0-24) <atoi> (end 0-24)|Specify an hour range (24-hour clock) for when to perform daily maintenance on static mapservers. Daily maintenance is disabled by default. Appended to MapServerParams as -dailyUpkeep <start> <end>}}
{{CLArg|SendDoorsToAllMaps <atoi>|}}
{{CLArg|SendDoorsToAllMaps <atoi>|Whether door updates should be sent to all mapservers. This is a legacy behavior; by default, updates are only sent to static maps and supergroup bases, and not mission maps, raid maps and arena maps.}}
{{CLArg|MetricsEnable <atoi>|}}
{{CLArg|MetricsEnable <atoi>|Enable ZeroMQ metrics. Disabled by default.}}
{{CLArg|MetricsIPAddress <strcpy>|}}
{{CLArg|MetricsIPAddress <strcpy>|IP address for the ZeroMQ instance.}}
{{CLArg|MetricsPortNumber <atoi>|}}
{{CLArg|MetricsPortNumber <atoi>|Port for the ZeroMQ instance.}}
{{CLArg|MetricsMQType <atoi>|}}
{{CLArg|MetricsMQType <atoi>|This is "the socket type of the metrics system's ZeroMQ connection."}}
{{CLArg|MetricsHighWaterMark <atoi>|}}
{{CLArg|MetricsHighWaterMark <atoi>|The high water mark of the ZeroMQ connection.}}
{{CLArg|AdvertisedIp <strcpy>|}}
{{CLArg|AdvertisedIp <strcpy>|}}
}}
}}

Latest revision as of 11:09, 29 May 2019

Inherent Settings

dual_player_slots = 12

backup_period = 30

logins_per_minute = 100

xpscale = 1.0

client_commands = { 0 }

map_server_params = { 0 }

eventhistory_cache_days = 30

MARTY_enabled = 0

blocked_map_keys = 0

disabled_zone_events = 0

locale_id = -1

isBetaShard = 0

isVIPServer = 0

ownsGR = 1

GRNagAndPurchase = 0

queue_server = 1

max_players = DEFAULT_MAX_PLAYERS = 100

name_lock_timeout = DEFAULT_NAME_LOCK_TIMEOUT = 1200

advertisedIp = 0

Configuration Options

DbServer <strcpy>

DbServer<N> <strcpy>

UseFakeAuth <atoi>

AuthServer <strcpy> <atoi>

LocalIp <strcpy>

SqlDbProvider <strcpy>

Supported values:

mssql: Microsoft SQL Server.
postgresql: Experimental (and incomplete) PostgreSQL support.

SqlDbName <strcpy>

SqlLogin <strcpy>

SqlInit <strcat>

SqlAllowDDL <atoi>

SqlAllowAllDDL <atoi>

Alias of SqlAllowDDL

SqlAddAttributes <atoi>

Allow the SqlAddAttributes DDL command.

SqlAddColumnOrTable <atoi>

Allow the SqlAddColumnOrTable DDL command.

SqlDeleteColumnOrTable <atoi>

Allow the SqlDeleteColumnOrTable DDL command.

SqlRebuildTable <atoi>

Allow the SqlRebuildTable DDL command. This has the same effect as setting SqlAllowDDL.

SqlAlterColumn <atoi>

Allow the SqlAlterColumn DDL command.

DefaultAccessLevel <atoi>

LogDir <strcpy>

AssertMode <strcpy>

Set the behavior of assertion failures. Multiple modes can be specified if the argument is wrapped in quotes. Possible modes are:

Minidump

Create minidumps (.mdmp) on failure.

Fulldump

Create full dumps (.dmp) on failure.

Exit

Exit on failure.

NoTimestamp

Don't name dump files with timestamps.

NoDate

Same as NoTimestamp.

Zip

Zip the dump files.

Ignore

Enable the ignore button on assertions.

MaxPlayers <atoi>

The maximum number of players that can be connected at any time. The maximum value is AUTH_SIZE_MAX (8191)

LoginsPerMinute <atoi> (greater than 0)

MinPlayers <atoi>

UseQueueServer <atoi>

BlockFreePlayerssIfNoAccountServer <atoi>

EnqueueWithAuthLimiter <Atoi>

NoStats <atoi>

ClientProject <strcpy>

MapServerParams <strcpy>

DiffDebug <atoi>

ContainerSizeDebug <atoi>

UseLogServer <atoi> (implied if LogServer is set)

LogServer <strcpy>

LogRelayVerbose <atoi>

ChatServer <strcpy>

ShardName <strcpy>

ChangeDbOwnerFrom <strcpy>

MaxLevel <atoi>

MaxCoHLevel <atoi>

MaxCoVLevel <atoi>

MaxDualSlots <atoi> (1-12)

BackupDays <atoi> (less than or equal to 30)

OfflineProtectLevel <atoi>

OfflineIdleDays <atoi>

CompleteBrokenTasks <atoi>

DroppedPacketLogging <atoi>

Log when packets are dropped or received out of order.

AuthBadPacketReconnect <atoi>

BeaconMasterServer <strcpy>

Hostname for beaconserver.

MasterBeaconServer <strcpy>

Alias of BeaconMasterServer.

DoNotLaunchBeaconMasterServer <strcpy>

Don't launch beaconserver.

DoNotLaunchMasterBeaconServer <strcpy>

Alias of DoNotLaunchBeaconMasterServer.

BeaconRequestServerCount <atoi>

Number of beaconrequestservers to launch. Negative values correspond to 2. Default is -1.

RequestBeaconServerCount <atoi>

Alias of BeaconRequestServerCount.

DoNotPreloadCrashReportDLL <atoi>

BeaconRequestCacheDir <strncpy>

DoNotLaunchBeaconClients <atoi>

DoNotLaunchMapServerTSR <atoi>

DoNotLaunchMapServerTSRs <atoi>

RaidTimeZoneDelta <atof>

DisableContainerBackups <atoi>

Disable on-disk container backups.

XPScale <atof>

Experience multiplier.

AuctionInvMaxLastLoginDays <atoi>

Auction entries for accounts that have not logged in in this many days are not sent. Default is 60.

AuthnameLimiterEnabled <atoi>

AuthnameLimiterAccessLevel <atoi>

BlockedMapKey <strncpy>

A comma delimited list of map keys to not load.

DisabledZoneEvents <strcpy>

A comma delimited list of disabled zone events.

ClientCommands <strcpy>

MissionserverMaxSendQueueSize <atoi>

The maximum amount of bytes allowed in the send queue to the missionserver. Default is DB_MISSIONSERVER_MAX_SENDQUEUE_SIZE_DEFAULT (1000000).

MissionserverMaxSendQueuePublishSize <atoi>

The maximum amount of bytes allowed in the publish queue to the missionserver. Default is DB_MISSIONSERVER_MAX_SENDQUEUE_SIZE_DEFAULT (500000).

Locale <atoi>

Must be an index or shorthand language code. Possible values:

0/en: English
1/test: Test Locale
2/zh: Traditional Chinese
3/ko: Korean
4/ja: Japanese
5/de: German
6/fr: French
7/es: Spanish

OverrideAuthBit <TODO: authUserData.c authUserSetFieldByName>

IsBetaShard <atoi>

On beta shards, users can use the broken mission fix every 10 minutes, rather than every 3 days. Appended to MapServerParams as -IsBetaShard.

IsVIPShard <atoi>

Whether or not this shard is a VIP shard. Only accounts marked as VIP can log into this shard.

OwnsGoingRogue <atoi>

GoingRogueNagAndPurchase <atoi>

Show the nag dialogs and buy button for Going Rogue.

KarmaEventHistoryDays <atoi>

How many days of past karma event history to read on load. Default is 30.

NameLockTimeout <atoi> (> 600)

SetLogLevel <atoi>

IsLoggingMaster <atoi>

If truthy, this server will propagate the configured loglevels to all of the connected servers.

MARTYEnabled <atoi>

Enable/disable the MARTY anti-cheat. Appended to MapServerParams as -MARTY_enabled

DebugSendPlayersDelayMS <atoi>

When sending the list of characters to a client, delay the SQL query by this many milliseconds.

DefaultLoyaltyPointsFakeAuth <atoi>

DefaultLoyaltyLegacyPointsFakeAuth <atoi>

ForceOverloadProtection <atoi>

Forces overload protection to be enabled.

OverloadProtection_LauncherHighWaterMarkPercent <atof>

Launcher upper bound for overload protection. When the percentage of launchers that cannot launch a server rises above this percentage, engage overload protection.

OverloadProtection_LauncherLowWaterMarkPercent <atof>

Launcher lower bound for overload protection. When the percentage of launchers that cannot launch a server drops below this percentage, disengage overload protection.

OverloadProtection_SQLQueueHighWaterMark <atoi>

SQL upper bound for overload protection. When the size of the SQL queue grows larger than this, engage overload protection.

OverloadProtection_SQLQueueLowWaterMark <atoi>

SQL lower bound for overload protection. When the size of the SQL queue drops below this, disengage overload protection.

MapserverIdleExit <atoi>

Shut down mapservers if they are idle for this many minutes. Default is 0 (idle shutdown is disabled). Keep in mind that maps without Transient in their maps.db entry will never shut down, even after being idle. Appended to MapServerParams as -idleExitTimeout

MapserverIdleUpkeep <atoi>

Number of minutes a mapserver must be idle before performing idle maintenance. Idle maintenance will attempt to minimize the memory footprint of the mapserver by compacting the working set. Default is 20 minutes. Appended to MapServerParams as -idleUpkeep

MapserverDailyUpkeep <atoi> (start 0-24) <atoi> (end 0-24)

Specify an hour range (24-hour clock) for when to perform daily maintenance on static mapservers. Daily maintenance is disabled by default. Appended to MapServerParams as -dailyUpkeep <start> <end>

SendDoorsToAllMaps <atoi>

Whether door updates should be sent to all mapservers. This is a legacy behavior; by default, updates are only sent to static maps and supergroup bases, and not mission maps, raid maps and arena maps.

MetricsEnable <atoi>

Enable ZeroMQ metrics. Disabled by default.

MetricsIPAddress <strcpy>

IP address for the ZeroMQ instance.

MetricsPortNumber <atoi>

Port for the ZeroMQ instance.

MetricsMQType <atoi>

This is "the socket type of the metrics system's ZeroMQ connection."

MetricsHighWaterMark <atoi>

The high water mark of the ZeroMQ connection.

AdvertisedIp <strcpy>