Configuration Value Reference

From HEWIKI
Jump to: navigation, search

He server.png Documentation on this page is intended for customers of HeroEngine managing their own server(s).

This page contains a list of all of the configuration values for the servers and daemons on the server-side of HeroEngine. For information on how to change these values, see Editing configuration values. Note that this page is only for server-side values. For the client values, see Editing client configuration values.


Contents

Firestorm Daemon

Parm Name Parm Type Description Default value
MaximumNetworkSendBytes integer Maximum chunk of the communication stream given to the non-ASIO network layer in one send call 65536
FireupReconnectDelay integer Base sleep time in milliseconds to pause in between attempts to connect to the fireup daemon 1000
FireupReconnectAttemptMax integer Number of times to attempt connection to fireup daemon; after this many failed attempts, process will exit 10
LogRateInterval integer Length of time in milliseconds to accumulate counts of log messages sent 5000
LogLimitPerInterval integer Maximum number of log messages to send to fireup during any given log rate interval 250
defaultWriteTimeoutMillis integer Non-ASIO communication layer forces a disconnect if it is unable to send data after this many milliseconds 5000
defaultInactivityLimitMillis integer Non-ASIO communication layer forces a disconnect if there has been no activity after this many milliseconds 300000
defaultHeartBeatMillis integer Non-ASIO communication layer sends a heartbeat message after this many milliseconds 60000
deleteConfigFile integer Configuration file for the process is deleted after process run completes unless this is set to 0 1
SleepOnStart integer Time in milliseconds to sleep the process after reading in configurations, to allow for debuggers to attach 0
minimumCycleTime integer Time in milliseconds to schedule each application pump cycle 7
ApplicationDisplayName string Used as a display name for the process in Post Office Router and Stat Station ""
OutwardFacingIPAddress string IP address used to bind client facing listeners 127.0.0.1
ReportedOutwardFacingIPAddress string IP address that client facing listeners report to the Service Directory 127.0.0.1
InwardFacingIPAddress string IP address used to bind internal connection listeners 127.0.0.1
loggingDisabled integer Setting this to a non-zero number will disable logging to Master Control 0
StatsTimerMinimumMillis integer Minimum elapsed time measurable by stats collection 1
StatsUpdateIntervalSeconds integer Frequency in seconds of stats updates to the stat server 10
StatsUpdateMailboxName string Well known mailbox name of the stat server StatStation
StatsUppercaseAccountNames integer A non-zero value means all accounts are reported in upper case to the stat server 1
sendingBandwidth integer the rate at which data will be sent in bytes per millisecond 0
receivingBandwidth integer the rate at which data should be sent in bytes per millisecond 0
sendingDelay integer simulated sending side delay in milliseconds per packet 0
receptionDelay integer simulated receiving side delay in milliseconds per packet 0

PO

defaultPORouterTransport string Transport string which identifies how to communicate with the Post Office Router process tcp:localhost:63333
defaultPORouterProtocol string Encoding method used when communicating to the Post Office Router process packet:MD5
RouterDisconnectRetryPause integer Milliseconds to wait after having been disconnected from the Post Officer Router process, in other to try and reconnect 5000
PostOfficeMatrixGracefulShutdownTimeout integer Milliseconds to wait on shutdowns for connections to gracefully close 30000

Director Params

DirectedProcessDaemonID int daemon id of the process to start 1099 note: Should be different for each
DirectedProcessDaemonName string type of daemon to run HJ_DUDE_SERVER or REPOSITORY_SERVER_DAEMON
DirectedProcessMinimumCount string how many to always have running 2
DirectorEnabled int flag to tell the dynamically spun up processes to be directed 1
DirectorMailboxName string unique well known mailbox per world DIRECTOR_REPOSITORY_STATUS
ServiceDirectoryMatrixTransports string which service directories to talk to <pipe separated Service Directory PO Matrix Tranport strings>
DirectedProcessNumber int passed to the dynamically started daemons to number them configuration value not set
DirectedProcessStartTimeout int time in milliseconds to wait for the newly started daemon to open a connection back to the director 30000
DirectedProcessPortRange string range of tcp/ip ports to bind to for outward facing ports on the directed processes 10001-19999
DirectedProcessHeartbeatRate int time between heartbeats to the directed daemons 30000
ServiceDirectoryPublishRate int time between publishes of directed daemon connection information to the service directories 30000
ServiceDirectoryPublishName string something something
PublicWorldName string world identifier used to tell the Service Directory which world the daemons are running for usually set at the Universe level


Authenticator Daemon

uaccessValidResponses string allowed responses from the subscription; subscription types INTERNAL,PAYING,PREMIUM
uaccessTransport string transport protocol information used to established the authentication connection tcp:localhost:7501
uaccessConnectionResetConsecutiveFailureLimit integer allowed number of consecutive connection failures prior to terminating AUTHENTICATOR process 300
uaccessConnectionResetDelay integer number of milliseconds to sleep before attempting to reconnect to the HEUACCESS service 2000 (milliseconds)
uaccessProtocol string protocol information used to establish the connection line:UNIX
uaccessProductID string product ID, or subscription name, for the world
AuthenticationPrivateKeyFile string file which contains the private key for decrypting encrypted passwords, empty string indicates encrypted passwords is disabled "" or "private_key.pv"

ID Server Daemon

batchIDPassword string password for database connection FS_ID_USER
batchIDUsername string schema and database information which contains the ID lines FS_ID_USER@FSPROD2
HEBatchIDLine string The name of the ID line in the ID_LINE table of the FS_ID schema of the ID database for this World HJDEV

Fire up Daemon

FireupLogLimitPerInterval integer number of log messages that may be received within the log interval, FireupLogRateInterval, after which log messages are dropped 500
FireupLogRateInterval integer length of log interval in milliseconds; used to control limiting log messages received each interval 5000
FireupApplicationConnectionTimeout integer how long, in milliseconds, the connection can stay open and inactive before being considered disconnected 300000
masterControlTransport string information about the transport protocol to be used for the master control connection tcp:localhost:62455

PO Router Daemon

poRouterProtocol string protocol to be used for the post office router connection packet:MD5
poRouterHost string (currently unused)
StatusUpdateInterval integer how often, in milliseconds, to update statistics for Master Control 60000
poRouterConnectionTimeout integer (currently unused) 60000
poRouterHeartbeat integer (currently unused) 60000
poRouterPort integer port number to be used for the post office router connection 63333
poRouterSuspendedTime integer in milliseconds (currently unused) 2000
poRouterTransport string transport level protocol to be used for the post office router listener connection tcp

Repository Dude Manager Daemon

RepositorySecurityDisabled integer Setting this to 1 turns off permissions checking for all repository requests (see Repository Server Daemon) 0
repositoryUsername string The username and database identifier that the process will use to login to the Oracle database of the Repository FS_REPOSITORY_DEV@FSDEV
repositoryPassword string The password for logging in to the Oracle database for the Repository FS_REPOSITORY_DEV
RepositorySecuritySystem string the system used in the access control database when checking permissions (see Repository Server Daemon) repository
InternalRepositoryServer integer this value should remain zero for proper operation of the repository dude manager 0
DirectRepositoryTransport string this value should remain an empty string for the proper operation of the repository dude manager ""
HEaccesscontrolDatabase string Database identifier for the HEaccesscontrol Oracle database (see Repository Server Daemon) FIRESTORM
HEaccesscontrolPassword string Password for logging in to the HEaccesscontrol database (see Repository Server Daemon) FIRESTORM
HEaccesscontrolUsername string The username for logging in to the HEaccesscontrol database (see Repository Server Daemon) FIRESTORM
cacheMaxSize integer Bytes of memory allocated into which repository files are cached while streaming them to clients. NOTE: This must be larger than the largest file in the repository, and should be several multiples of that file size to allow for streaming of multiple files. (see Repository Server Daemon) 268,435,456 bytes
ServiceDirectoryPublishRate integer how often the service directory should publish, in milliseconds (see also Repository Server Daemon) 30000
ServiceDirectoryMatrixTransports string list of all transports to service directories to which connection information is reported (see also Repository Server Daemon)
DudeManagerTransport string The transport string which specifies the port on which to listen for clients tcp::10357
ServiceDirectoryPublishName string the name of the service being provided by this process used when reporting to the service directory
DirectedProcessNumber integer Not used by the repository dude manager daemon 0
DirectedProcessMinimumCount integer Not used by the repository dude manager daemon 2
DirectedProcessStartTimeout integer Not used by the repository dude manager daemon 30000
DirectedProcessPortRange string Not used by the repository dude manager daemon 10001-19999
DirectedProcessHeartbeatRate integer Not used by the repository dude manager daemon 30000
DirectorMailboxName string Not used by the repository dude manager daemon
DirectorEnabled integer this value should remain zero for proper operation of the repository dude manager daemon 0
DirectedProcessDaemonID string Not used by the repository dude manager daemon  ????
PublicWorldName string Name of the world used when reporting to service directories (but see also Repository Server Daemon and Dude Server) INVALID_PUBLIC_WORLD_NAME
DirectedProcessDaemonName string Not used by the repository dude manager daemon UNKNOWN
RepositoryWorkerThreadCount integer number of database connection threads to start to allow simultaneous file requests (see Repository Server Daemon) 10
OutgoingBufferSaneBytes integer Limits size of buffer kept allocated for outgoing channel messages. The system computes an average for that, but averages are capped to this value to prevent an early traffic spike from keeping too much memory reserved. 1,000,111
IncomingChannelMessageMaxBytes integer The maximum size of a message, in bytes, to allow from a client 10,111,000
DudeManagerNoDelay string When set to on, this disables the Nagel algorithm (see Dude Server) "on"
DudeManagerAuthenticationTimeout integer The number of milliseconds to allow for an authentication response when a player logs in (see Dude Server) 10,000
AuthenticationPublicKeyFile string See Encrypted Login. ""
AuthenticationPublicKeySignatureFile string See Encrypted Login. ""
DudeManagerCertificate string If this is set to the filename of an OpenSSL certificate, it turns on OpenSSL encryption (see Dude Server) ""
DudeManagerPendingDudePendingDataLimit integer sets the max allowable queued data for each connected dude. Exceeding this value causes a dude to be disconnected. 268435456
DirectRepositoryMaximumSimultaneousRequests integer maximum allowed number of requests in processing for any given client 2
DirectRepositoryMaximumPendingBytes integer Not used by the repository dude manager daemon 104857600
DirectRepositoryMaximumReadableBytes integer Not used by the repository dude manager daemon 5242880
DirectRepositoryDesiredQueuedSendBytes integer Not used by the repository dude manager daemon 102400
HEaccesscontrolDatabase string Database identifier for the HEaccesscontrol Oracle database (see Repository Server Daemon) FIRESTORM
HEaccesscontrolPassword string Password for logging in to the HEaccesscontrol database (see Repository Server Daemon) FIRESTORM
HEaccesscontrolUsername string The username for logging in to the HEaccesscontrol database (see Repository Server Daemon) FIRESTORM
Gr2ExtensionUploadEnabled integer Controls whether or not gr2s may be uploaded to the repository.


Repository Server Daemon

RepositorySecurityDisabled integer Setting this to 1 turns off permissions checking for all repository requests 0
RepositorySecuritySystem string the system used in the access control database when checking permissions repository
InternalRepositoryServer integer Setting this to 1 configures the process to be used as an Internal Repository Server, otherwise it is a regular Repository Server 0
DirectRepositoryTransport string Defined at runtime, this is the IP address on which to find the listener for clients to connect to
DirectedProcessNumber integer Supplied dynamically by the Director to track which process it is 0
DirectedProcessPortRange string specifies the range of ports on which it is valid to bind the client listener 10001-19999
DirectorEnabled integer setting this to 1 indicates to the server that it should report to a director process 0
DirectedProcessDaemonID string not used by the repository server  ????
PublicWorldName string not used by the repository server INVALID_PUBLIC_WORLD_NAME
DirectedProcessDaemonName string not used by the repository server UNKNOWN
repositoryUsername string The username and database identifier that the process will use to login to the Oracle database of the Repository FS_REPOSITORY_DEV@FSDEV
repositoryPassword string The password for logging in to the Oracle database for the Repository FS_REPOSITORY_DEV
HEaccesscontrolDatabase string Database identifier for the HEaccesscontrol Oracle database FIRESTORM
HEaccesscontrolPassword string Password for logging in to the HEaccesscontrol database FIRESTORM
HEaccesscontrolUsername string The username for logging in to the HEaccesscontrol database FIRESTORM
cacheMaxSize integer Bytes of memory allocated into which repository files are cached while streaming them to clients. NOTE: This must be larger than the largest file in the repository, and should be several multiples of that file size to allow for streaming of multiple files. 268,435,456 bytes
RepositoryWorkerThreadCount integer number of database connection threads to start to allow simultaneous file requests 10
ServiceDirectoryPublishRate integer not used by the repository server daemon 30000
ServiceDirectoryMatrixTransports string not used by the repository server daemon
EnablePipelinedResourceRequests integer setting this to 1 results in pipeline resource requests being enabled for all flavors of repository servers
Pipelined Requests are enabled by default in the Direct Repository Server
0
DisablePipelinedResourceRequests integer setting this to 1 results in pipeline resource requests being disabled for all flavors of repository servers
this setting overrides EnablePipelinedResourceRequests when both are set to 1
0

Service Directory Daemon

masterControlServiceDirectoryTransport string connect string that refers to the port master control has open for service directories to get status information on tcp:localhost:49277
ServiceDirectoryStatisticsPublishRate int How often the service directory publishes its statistics to master control 30000
ServiceDirectoryPublishedDataTimeout int when to time out the list of transports sent to the service directory from the worlds 30000
DudeManagerTransport string transport that the service directory is listening for client connections on tcp::10357
ServiceDirectoryPublishName string not used by the dude manager in the service directory
AddressForCreateProxyMailboxes string part of dude manager's internal workings BoxDude
DudeManagerProtocol string protocol used by the dudemanager for the client connections packet
LogoffMailingListName string mailbox used internally by dude manager DudeLogoffList
DudeManagerPrefix string an optional prefix for all the dude manager mailboxes
DudeManagerDomainID string internal name of the dude manager's connection domain theDudeManager
DisconnectBoxName string name of a mailbox used by the dudemanager DiscoDude
LogonMailingListName string Name of the mailing list used to notify logins internally to the dude manager DudeLogonList
DudeManagerSubscriberWatcher string name of a mailbox used by the dudemanager DudeManagerSubscriberWatcher
MaxQueuedMessagesWhileWaitingAuthentication int Messages from a client are queued until the client is authenticated, if too many come in before authentication, we drop the user 100
ServiceDirectoryPublishRate int used by processes that publish their transports to the service directory 30000
ServiceDirectoryMatrixTransports string pipe separated list of transports of the service directories used by processes publishing transports
LogonDeferTime int time to wait before forwarding logons to the dude manager 150
ServiceDirectoryMasterControlRefreshRate int how often to request the updated list of world statuses from master control 5000
ServiceDirectoryWorldFilter string described below show:.*

Update Server Daemon

repositoryUsername string The username and database identifier that the process will use to login to the Oracle database of the Repository FS_REPOSITORY_DEV@FSDEV
repositoryPassword string The password for logging in to the Oracle database for the Repository FS_REPOSITORY_DEV

Master Control Daemon

terminateDelayMS integer how many milliseconds should pass after shutting down a process before assuming the process is non-responsive and issuing the terminate command 30000
servicePassword string password for the FS_SERVICE database connection incorrectpassword
serviceUsername string schema and database for the FS_SERVICE database connection FS_SERVICE@FSPROD2
accesscontrolPassword string password for connection to access control database FIRESTORM
accesscontrolUsername string schema and database used for connection to access control database FIRESTORM
uaccessValidResponses string allowed responses from the subscription check; subscription types, see Authenticator INTERNAL,PAYING,PREMIUM
uaccessTransport string transport protocol information used to established the uswer authentication connection, see Authenticator tcp:uaccess.play.net:7501
uaccessProtocol string protocol information used to establish the user authentication connection, see Authenticator line:UNIX
uaccessProductID string product ID, or subscription, for the world, see Authenticator
masterControlTransport string transport information used to establish master control listening port, or 'ERROR' if no such host should be established ERROR

Area Server

Area string The area number of the area 0
AreaInstanceNumber string The instance number of the area 0
AreaName string The display name of the area UNKNOWN
AreaSpinUpTimeLimit integer After starting an area process, if it does not register within this number of milliseconds, the area is considered down 60000
BatchIDClientTimeout integer Milliseconds to allow the ID Server to provide the first batch of IDs during startup 7000
CCUMaximum integer 0 {{{5}}}
CharacterSelectionAreaNumber string Area number for initial logins to be transferred to 1
ClientVersion string Deprecated version checking technique must be set
CoordinatorTimeout integer Not used by the Area Server 7000
DOMCoordinatorAppName string Well known mailbox name of the DOM Coordinator DOM_COORDINATOR
DreamIdentOfServer string Can be used to uniquely identify multiple worlds connected to the same dream server <server>
DreamServerMailbox string Well known mailbox name of dream server DREAM_SERVER
EditCommandWriteTriggerCount integer Deprecated configuration variable 100
EditingClientChannelMap string List of channels opened only to edit client and the channel destinations N/A
field_facegen_spec_body_raw string Specifies the field on _characterAppearance in which to place the binary form of the facegen_spec_body field _facegen_spec_body_raw
field_facegen_spec_raw string Specifies the field on _characterAppearance in which to place the binary form of the facegen_spec field _facegen_spec_raw
field_geometry_list_raw string Specifies the field on _characterAppearance in which to place the binary form of the geometry_list field _geometry_list_raw
field_texture_list_raw string Specifies the field on _characterAppearance in which to place the binary form of the texture_list field _texture_list_raw
HEaccesscontrolDatabase string Specifies the database for access control checks FIRESTORM
HEaccesscontrolPassword string Specifies the password for the access control schema FIRESTORM
HEaccesscontrolUsername string Specifies the access control schema name FIRESTORM
HEBatchIDLine string ID Line sent to the ID server when requesting ID batches HE
HslSystemsSecurityDisabled integer Setting this to a non-zero value disables security checks by the external function AccountNameCanDo() 0
InstanceNumber integer Specifies which game instance in a database this area is a part of Note: storing multiple game instances in the same database schema is not currently supported 1
LivePushServerMailbox string Well known mailbox name of the Live Push Director LIVE_PUSH_SERVER_DIRECTOR
LogServerMailbox string Well known mailbox name of the log server LOG_SERVER
MaxEditQueueSize integer Edit instances will write out DAT file updates after this amount in bytes of accumulated edit commands 524288
MaximumCharacterViewDistance int Deprecated in favor of spatial awareness system 1000
NonBandwidthTrackedChannels string List of client channels which do not count against the clients bandwidth limit N/A
NumberOfTimesToRetryCoordinatorMessage integer Maximum number of attempts to contact the DOM Coordinator 10
OnAreaLoad string Name of method to call on $AREA when the area load completes _OnAreaLoad
OnAreaUnload string Name of method to call on $AREA before the area shuts down _OnAreaUnload
PauseLoginsAfterWrites integer Milliseconds to wait on allowing player travel after a DAT file write 5000
PhysicsServerHeartbeatInterval integer Not used by the area server 30000
PhysicsServerRegistrationRetryCount integer Number of times to attempt to get a scene on a physics server 10
PhysicsServerRegistrationRetryDelay integer Milliseconds between scene registration attempts 10000
PhysicsServerStatisticsInterval integer Not used by the area server 10000
PhysicsServerUpdateDuration integer Not used by the area server 10
PlayerClientChannelMap string Channel list to open to all types of clients N/A
PrimaryDestinationString string String to compare when determining what type of endpoint a client channel has N/A
PumpsToWaitAfterCoordinatorMessageFail integer Delay interval in pump cycles between attempts to register with the DOM Coordinator 500
receivingBandwidth integer Not used by the area server 0
receptionDelay integer Not used by the area server 0
ReplicationDistanceRateMillis integer Frequency in milliseconds of distance updates sent to the dude server to adjust replication priorities 1000
RepositoryName string Name of repository to store/retrieve files from HE
ScriptErrorBugCommand string Command to execute to submit script errors to bug tracking SimuBugCatcher /r
ScriptErrorBugOptionsServer string additional options to the command ScriptErrorBugCommand for server side errors (off=do not run)
ScriptErrorBugOptionsClient string additional options to the command ScriptErrorBugCommand for client side errors (off=do not run)
sendingBandwidth integer Not used by the area server 0
sendingDelay integer Not used by the area server 0
StatsCollectUserGOM integer Setting to non-zero value enables collecting user memory usage in the area server GOM 1
StatusUpdateTimer integer Frequency in milliseconds of Master Control statistics updates 60000
TravelFailureRecoveryAreaNumber string Area number where players who fail to travel should be sent Note: this feature is not implemented 2
World string Used to uniquely identify well known mailboxes if two worlds share a post office matrix 0
WorldID string Used to uniquely identify the world at the dream server 0
WriteDATRefresh integer Minimum time period in milliseconds between writes of DAT files 30000
WriteDATTimeout integer After this many milliseconds elapse without further edits, DAT file writing is triggered 600000

Directory Watcher Server

RepositoryName string Name of repository in which to load and save data HE
WatcherWaitTime integer Interval between scans of the repository for changes 10000
repositoryUsername string The username and database identifier that the process will use to login to the Oracle database of the Repository FS_REPOSITORY_DEV@FSDEV
repositoryPassword string The password for logging in to the Oracle database for the Repository FS_REPOSITORY_DEV

DOM Coordinator

JavelinConnectString string complete schema password database and identifier javelin/javelin@somewhere
World string prefix used on well-known mailbox names 0
HEBatchIDLine string selects the line of IDs to draw from when requesting IDs from the ID Server HE
BatchIDClientTimeout integer how long in milliseconds to wait for a response from the ID Server 7000
ServerHeartbeatInterval integer frequency in milliseconds at which to query coordinated servers to make sure that they are still there 120000
CoordinationTimeout integer milliseconds to wait for all servers to validate a DOM change before considering it timed out 1000

Dude Server

HEDudeBatchIDLine string ID line to request from the Batch ID Server to give each connected client a unique ID number HEDUDE
WorldID string When the Dude Manager sends requests to the Dream Manager, this identifies which World that the requests are coming from "0"
BatchIDClientTimeout integer Milliseconds to wait for the ID Server to respond to a batch request, before issuing another batch request 15,000
DudeManagerTransport string The transport string which specifies the port on which to listen for clients. (Note: This value is used only for static processes, and is not used by a dynamically started Directed process) tcp::10357
DirectedProcessNumber integer A sequence number assigned by the Director to uniquely identify the dynamic processes it launches  
DirectedProcessPortRange string The range of ports on which to bind TCP listeners 10001–19999
DirectorMailboxName string Set by the Director, this is the well-known mailbox name on which to report to the Director  
DirectorEnabled integer Setting this to a non-zero value lets a process know if it is a dynamically started process 0
AuthenticationPublicKeyFile string See Encrypted Login. ""
AuthenticationPublicKeySignatureFile string See Encrypted Login. ""
DreamIdentOfServer string Identifies which world is being worked in, to the Dream Manager <server>
DreamServerMailbox string The well-Known Name of the Dream Manager's mailbox DREAM_SERVER
DudeBandwidthByteLimit integer Maximum number of bytes which can be sent to a player in a one-second interval 40,960
DudeBandwidthMaxBurst integer Maximum size of any individual replication message 4,096
DudeManagerAuthenticationTimeout integer The number of milliseconds to allow for an authentication response when a player logs in 10,000
DudeManagerCertificate string If this is set to the filename of an OpenSSL certificate, it turns on OpenSSL encryption ""
DudeManagerNoDelay string When set to on, this disables the Nagel algorithm "on"
DudeManagerPendingDudeDataLimit integer Maximum amount of allowed data, in bytes, queued for sending to a player 268,435,456
EditingClientChannelMap string Specifies the channels which are open to the client (see source code for default)
IncomingChannelMessageMaxBytes integer The maximum size of a message, in bytes, to allow from a client 10,111,000
LivePushServerMailbox string The well-known mailbox name of the Live Push Server Director LIVE_PUSH_SERVER_DIRECTOR
LogServerMailbox string The well-known mailbox name of the Log Server LOG_SERVER
NonBandwidthTrackedChannels string Specifies channels that are not counted against bandwidth to the player (see source code for default)
OutgoingBufferSaneBytes integer Limits size of buffer kept allocated for outgoing channel messages. The system computes an average for that, but averages are capped to this value to prevent an early traffic spike from keeping too much memory reserved. 1,000,111
PlayerClientChannelMap string The list of channels open to a player client (see source code for default)
PrimaryDestinationString string Token which indicates traffic on a channel is directed to a player's current area server (see source code for default)
receivingBandwidth integer (not used by the Dude Server process) 0
receptionDelay integer (not used by the Dude Server process) 0
sendingBandwidth integer (not used by the Dude Server process) 0
sendingDelay integer (not used by the Dude Server process) 0
ReplicationUpdateInterval integer Milliseconds between replication update message 100
ServiceDirectoryPublishName string (not used by dynamically started directed processes)  
PublicWorldName string (not used by the Dude Server process)  
DirectedProcessMinimumCount integer (not used by the Dude Server process) 2
DirectedProcessStartTimeout integer (not used by the Dude Server process) 30,000
DirectedProcessHeartbeatRate integer (not used by the Dude Server process) 30,000
DirectedProcessDaemonID string (not used by the Dude Server process) "????"
DirectedProcessDaemonName string (not used by the Dude Server process) "UNKNOWN"
ServiceDirectoryPublishRate integer (not used by the Dude Server process) 30,000
ServiceDirectoryMatrixTransports string (not used by the Dude Server process)  


Hero Script Compiler Server

NonBandwidthTrackedChannels string list of non bandwidth tracked channels separated by ; (see source code)
EditingClientChannelMap string list of names for client channel map (see source code)
PrimaryDestinationString string the main destination for the channel currentarea
PlayerClientChannelMap string the map name for the player client channel (see source code)
HeroScriptMBServerDefs string well known mailbox name for remote definition queries for the server GOM HeroScriptMBServerDefs
HeroScriptMBClientDefs string well known mailbox name for remote definition queries for the client GOM HeroScriptMBClientDefs
HeroScriptChange string the security function to check when validating a script change SCRIPT_CHANGE
HeroScriptRead string the security function to check when validating a script read SCRIPT_READ
SystemGeneratedPath string the folder in the repository into which system generated files are placed /SystemGenerated/
HeroScriptSystem string the security system to use when validating actions HEROSCRIPT
ExposedConfigs string listing of configurations which are available for script to read
LatestScriptSourcePath string local file system directory in which to place temporary script code while compiling
HeroScriptDelete string the security function used to valid deletion of scripts SCRIPT_DELETE
PumpsToWaitAfterCoordinatorMessageFail integer how long, in pump cycles, to wait before retrying the DOM Coordinator registration 500
RepositoryName string Name of repository in which to load and save data HE
CoordinatorTimeout integer how long, in milliseconds, it should take the DOM Coordinator respond to registration 7000
NumberOfTimesToRetryCoordinatorMessage integer how many attempts to register with the DOM Coordinator are allowed 10
HEBatchIDLine string ID LINE used for creating DOM definitions HE
BatchIDClientTimeout integer how long, in milliseconds, the batch client is given before it times out 7000
CLI_FQN string it not empty, this file will be requested from the repository on startup and executed as a batch of CLI commands
HSCSWellKnownMailboxPrefix string well known prefix for the mailbox (seems to not be used)
HSCSSaveToRepository integer a non-zero number indicates that the script byte code should be saved to the repository, 0 means that it should not be saved 0
HSCSMethodConflictChecking integer a non-zero number indicates that methods should be checked for conflicts, 0 indicates that they should not 1
UncoordinatedConnectString string non-coordinated compiler servers are deprecated
ExtractSourceAtStartup integer deprecated flag which indicates source should be refreshed in the local file cache on startup 1
HeroScriptNodeProperties integer a non-zero number indicates that properties on nodes should be enabled (for the client DOM), 0 indicates that properties should be disabled 1
HeroScriptDefaultCategory string security feature used when validating actions DEFAULT
HeroScriptCreate string the security function used when validing script creation SCRIPT_CREATE

Repository Watcher Server

RepositoryName string Name of repository in which to load and save data HE
WatcherWaitTime integer Interval between scans of the repository for changes 10000
repositoryUsername string The username and database identifier that the process will use to login to the Oracle database of the Repository FS_REPOSITORY_DEV@FSDEV
repositoryPassword string The password for logging in to the Oracle database for the Repository FS_REPOSITORY_DEV

Search Server

NonBandwidthTrackedChannels string list of non bandwidth tracked channels separated by ; (see source code)
EditingClientChannelMap string list of names for client channel map (see source code)
PrimaryDestinationString string the main destination for the channel currentarea
PlayerClientChannelMap string the map name for the player client channel (see source code)
SearchResultTransitChars integer maximum number of characters allowed to be sent back in search results 5000
RepositoryName string Name of repository in which to load and save data HE
GuiXmlPath string search repository location for the GUI XML files /GUIXML/
SearchMillisPerPump integer how many milliseconds to spend on each search pump 20
ServerScriptFiles string local files system search directory for server script files C:/HEROENGINE/SCRIPT/SERVER/
GuiXmlList string FQNs to the files which list all GUIXML files in the repository /GUIXML/GUIXML.LST: /GUIXML/_HEGUIXML.LST
ClientScriptFiles string local file system search directory for client script files C:/HEROENGINE/SCRIPT/CLIENT/

Texture Copy and Mip

RepositoryName string Name of repository in which to load and save data HE
WatcherWaitTime integer Interval between scans of the repository for changes 10000
MipperSmallestMipLevel integer smallest mip level to generate 4
repositoryUsername string The username and database identifier that the process will use to login to the Oracle database of the Repository FS_REPOSITORY_DEV@FSDEV
repositoryPassword string The password for logging in to the Oracle database for the Repository FS_REPOSITORY_DEV

Thumbnail Creator

ThumbnailSizeY integer the vertical size to which the thumbnail should be scaled 64
RepositoryName string Name of repository in which to load and save data HE
WatchedExtension string files matching this extension will have thumbnails created automatically .dds
ThumbnailSizeX integer the horizontal size to which the thumbnail should be scaled 64
WatcherWaitTime integer interval between scans of the repository for changes 10000
ThumbPrefix string sub directory in which to place the generated thumbnail files _thumbs/
repositoryUsername string The username and database identifier that the process will use to login to the Oracle database of the Repository FS_REPOSITORY_DEV@FSDEV
repositoryPassword string The password for logging in to the Oracle database for the Repository FS_REPOSITORY_DEV

World Server

NonBandwidthTrackedChannels string list of non bandwidth tracked channels separated by ; (see source code)
EditingClientChannelMap string list of names for client channel map (see source code)
PrimaryDestinationString string the main destination for the channel currentarea
PlayerClientChannelMap string the map name for the player client channel (see source code)
StatsCollectUserGOM integer Setting to non-zero value enables collecting user memory usage in the server GOM (see Area Server) 1
HslSystemsSecurityDisabled integer Setting this to a non-zero value disables security checks by the external function AccountNameCanDo() 0
WorldID string Used to uniquely identify the world at the dream server 0
WriteDATRefresh integer Minimum time period in milliseconds between writes of DAT files ((see Area Server) 30000
DreamServerMailbox string Well known mailbox name of dream server (see Area Server) DREAM_SERVER
LivePushServerMailbox string Well known mailbox name of the Live Push Director (see Area Server) LIVE_PUSH_SERVER_DIRECTOR
DreamIdentOfServer string Can be used to uniquely identify multiple worlds connected to the same dream server (see Area Server) <server>
LogServerMailbox string Well known mailbox name of the log server (see Area Server) LOG_SERVER
field_texture_list_raw string Specifies the field on _characterAppearance in which to place the binary form of the texture_list field (see Area Server) _texture_list_raw
PhysicsServerHeartbeatInterval integer Not used by the world server (see Area Server) 30000
PhysicsServerRegistrationRetryCount integer Number of times to attempt to get a scene on a physics server (see Area Server) 10
PhysicsServerRegistrationRetryDelay integer Milliseconds between scene registration attempts (see Area Server) 10000
PhysicsServerStatisticsInterval integer Not used by the world server (see Area Server) 10000
PhysicsServerUpdateDuration integer Not used by the world server (see Area Server) 10
HEaccesscontrolDatabase string Specifies the database for access control checks (see Area Server) FIRESTORM
HEaccesscontrolPassword string Specifies the password for the access control schema (see Area Server) FIRESTORM
HEaccesscontrolUsername string Specifies the access control schema name (see Area Server) FIRESTORM
field_facegen_spec_body_raw string Specifies the field on _characterAppearance in which to place the binary form of the facegen_spec_body field (see Area Server) _facegen_spec_body_raw
field_facegen_spec_raw string Specifies the field on _characterAppearance in which to place the binary form of the facegen_spec field (see Area Server) _facegen_spec_raw
field_geometry_list_raw string Specifies the field on _characterAppearance in which to place the binary form of the geometry_list field (see Area Server) _geometry_list_raw
AreaSpinUpTimeLimit integer After starting an area process, if it does not register within this number of milliseconds, the area is considered down (see Area Server) 60000
OnWorldUnload string name of the method called on the $WORLD system node during world shutdown _OnWorldUnload
PumpsToWaitAfterCoordinatorMessageFail integer Delay interval in pump cycles between attempts to register with the DOM Coordinator 500
CoordinatorTimeout integer Not used by the World Server (see Area Server) 7000
FollowerAssetFQN string Not used by World Server \engine\follower.fol
NumberOfTimesToRetryCoordinatorMessage integer Maximum number of attempts to contact the DOM Coordinator (see Area Server) 10
LightAssetFQN string Not used by World Server \engine\light.lit
PhysicsJointAssetFQN string Not used by World Server \engine\physicsJoint.phj
PathfindingAssetFQN string Not used by World Server \engine\pathfinding.pfn
HeightMapAssetFQN string Not used by World Server \engine\heightmap.hms
FlareAssetFQN string Not used by World Server \engine\flare.fla
InstancedAreaDaemonId string Daemon ID of the instanced area server daemon  ????
AreaRepositoryPath string repository directory in which to place newly create area directories /World/Areas/
StatusUpdateTimer integer Frequency in milliseconds of Master Control statistics updates (see Area Server) 60000
HEBatchIDLine string ID Line sent to the ID server when requesting ID batches (see Area Server) HE
DOMCoordinatorAppName string Well known mailbox name of the DOM Coordinator (see Area Server) DOM_COORDINATOR
BatchIDClientTimeout string Milliseconds to allow the ID Server to provide the first batch of IDs during startup (see Area Server) 7000
OnWorldLoad string name of the method called on the $WORLD system node during world startup _OnWorldLoad
ActionMarkAssetFQN string Not used by World Server \engine\actionmark.amk
MirrorAssetFQN string Not used by World Server \engine\mirror.mir
LightningAssetFQN string Not used by World Server \engine\zap.zzp
ServerHeartbeatInterval integer interval in milliseconds between heartbeats to area servers 120000
TriggerAssetFQN string Not used by World Server \engine\trigger.trg
InstanceNumber integer Specifies which game instance in a database this area is a part of Note: storing multiple game instances in the same database schema is not currently supported (see Area Server) 1
PhysicsAssetFQN string Not used by World Server \engine\physics.phy
RepositoryName string Name of repository in which to load and save data HE
CharacterSelectionAreaNumber integer Area number of the character selection area 1
Area integer number of the current area, must remain 0 for proper operation of the world server 0
ClientVersion string no longer used must be set
ScriptErrorBugCommand string Command to execute to submit script errors to bug tracking (See also Area Server) SimuBugCatcher /r
World integer number of the current world 0
TravelFailureRecoveryAreaNumber integer Area number where players who fail to travel should be sent Note: this feature is not implemented (See also Area Server) 2
AreaInstanceNumber integer The instance number of the area, must be zero for proper operation of the world server 0
ScriptErrorBugOptionsServer string additional options to the command ScriptErrorBugCommand for server side errors (off=do not run)
MaxEditQueueSize integer Maximum allowed size of the edit queue 524288
ScriptErrorBugOptionsClient string additional options to the command ScriptErrorBugCommand for client side errors (off=do not run) (see Area Server)
PauseLoginsAfterWrites integer Milliseconds to wait on allowing player travel after a DAT file write (see Area Server) 5000
WriteDATTimeout integer After this many milliseconds elapse without further edits, DAT file writing is triggered (see Area Server) 600000
ReplicationDistanceRateMillis integer Frequency in milliseconds of distance updates sent to the dude server to adjust replication priorities (see Area Server) 1000
HslSystemsSecurityDisabled integer Setting this to a non-zero value disables security checks by the external function AccountNameCanDo() (see Area Server) 0
CCUMaximum integer Maximum allowed Concurrent Connected Users. 0 is unlimited. 0
AreaInstanceCountLimit integer Limit to the maximum number of area server processes the world is allowed to spin up. The default value of zero(0) represents no limit 0
KEEPUP_ENABLED integer When enabled (i.e. 1), the universe will not be considered for automatic spindown. 0(i.e. disabled)
SPINDOWN_IDLE_DELAY integer Specifies the number of seconds that the world must be idle with no connect users before auto spindown. The minimum is 300. 1800
RepositoryServerUpdateNotificationPeriod integer Specifies the number of milliseconds between when the repository is changed and updates are propagated outwards to clients and interested servers (physics) 10000
AUTO_SPINUP integer Specifies whether or not the master control daemon should attempt to automatically spin up this universe when it starts. To enable set to '1'. 0
AUTO_SPINUP_ORDER intenger Specifies the order in which auto_spinup universes should be spun up. Generally a value of 0 is assigned to shared universe services like a shared service directory 0
UniverseWeight integer Specifies the relative weight of a universe for the purposes of dynamic world server load balancing 10
AllowUniverseReconfiguration integer Specifies whether or not Dynamic Server Load Balancing and Reconfiguration is enabled for a universe, by default if not defined reconfiguration is disabled. To enable set to '1'. 0


Live Update Server Director

DOMCoordinatorMailboxName string The well-known mailbox name of the Server DOM Coordinator DOM_COORDINATOR
ClientDOMCoordinatorMailboxName string The well-known mailbox name of the Server DOM Coordinator CLIENT_DOM_COORDINATOR
DirectedProcessDaemonID integer The Daemon ID of this Director's Live Push Daemon n/a
PushLoggingVerbosity string Specifies logging level of detail. Currently, either "NORMAL" or "DETAILED" (case-insensitive). "NORMAL"
AreaLockTimeout integer Specifies how long to wait (in minutes) before automatically unlocking locked areas. Zero never times out. 180 (3 hours)



Stat Center Daemon

StatCenterUpdateIntervalSeconds integer How often the top users data is generated for the statistics tab 5
StatCenterTopCount integer How many users are displayed for each resource 5
StatCenterShowIP integer non-zero to show IP with each user 0
StatCenterShowID integer non-zero to show account ID with each user 0
StatCenterAgeLimitSeconds integer how long to retain the statistics being collected. This should be longer than the rate they are normally sent (StatsUpdateIntervalSeconds) 20
StatCenterLogDebugCount integer The number of log entries to make with stat information from startup 0
StatCenterDetailUser string One account name for which to provide additional data to the statistics tab

Restricted Server Configuration Values

Setting the environment variable CL to /DHEROENGINE_ESPECIAL causes HeroEngine to build a special version of the servers, which activates the following restrictions:

C:\p4\depot\HeroEngine\MAIN>  set CL=/DHEROENGINE_ESPECIAL
C:\p4\depot\HeroEngine\MAIN>  rebuild_stuff hj
Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox