wiki:mult-client.properties

mult-client.properties

In the conf subdirectory of the multistage software installation there is a file called mult-client.properties which contains a set of configurable properties of the multistage client.

defaultHost

#Host address of the multistage server 
#[localhost|IP|FQN]
defaultHost=localhost

defaultHost is used to tell the client software where to look for the server. It should be set to the address of the computer which is running the multistage server. Most commonly the IP address of the server is entered, but the server's fully qualified name will also work. The word 'localhost' can be used if the client is being run on the same machine as the server. If no defaultHost is specified, clients will need to type the server's address into the Client Startup dialog when they start the client program.

defaultMode

#[testing|manual] default=manual
defaultMode=manual

defaultMode is used to tell the client software whether to start in manual mode or testing mode. Testing mode enables the automated testing of the client, which usually involves the clients playing automatically with random movement. Manual mode is the standard use, which requires each client to play the game manually.

defaultSeed

#Seed used for random generator: for automated test only
defaultSeed=0

defaultSeed is a parameter used by the automated testing services to seed its random number generator. If 'replicated' random behavior is desired, seeding the random number generator with some other number would make it generate the same random sequence each time the automated test is run. This property is irrelevant to clients running in manual mode.

naming

#Whether to run the client with random naming.
#It should be random only when try to run automated tests. 
#[random|manual] 
naming=random

naming is another parameter meant to ease testing of multistage extensions. When naming is set to 'random', the client name is randomly generated, and the 'submit' button of the Client Startup dialog is automatically pressed shortly after the program loads. Manual naming is the standard use, which requires clients to enter their own name. Note that manual naming is required for clients to be able to reauthenticate to an already-running experiment.

confirmDelay

#In milliseconds: automated test only 
confirmDelay=2000

confirmDelay is another parameter for automated testing. It specifies the number of milliseconds the software waits before automatically pressing the 'ok' button on the (optional) match-ending confirmation dialog. It has no meaning in manual mode.

moveDelay

#In milliseconds: automated test only
moveDelay=1000

moveDelay is another parameter for automated testing. It specifies the number of milliseconds the software waits before automatically making a move and submitting a response during gameplay. The move delay has no meaning in manual mode.

maximize

#Whether to keep client window maximized 
#[true|false]
maximize=false

maximize is a parameter which controls whether a client's window is forced to be maximized or not. If maximize is set to true, the client's window is maximized and its size cannot be changed. If maximize is false, the client's window starts normally, and is able to be resized and repositioned.

allowClose

#Whether to allow client to close the GUI window
#[true|false]
allowClose=true

allowClose is a parameter which controls whether a client is allowed to close the GUI window. If allowClose is set to true, the clients are allowed to close the GUI window (by pressing alt+F4, clicking on the icon in the upper right corner, right clicking on the GUI in the taskbar and choosing 'close', etc). If allowClose is set to false, the client is blocked from closing the GUI (although, in Windows if the client closes the command prompt window launched by the client-multistage.bat the client will still disconnect).

serializePath

#set this to some write-safe path (must be set for reauthentication to work)
serializePath=e:\\multistageSerialize

serializePath is a parameter which tells the multistage reauthentication service a location on the client's machine where it is allowed to write temporary information about the state of the game to allow authentication to work. Without setting this parameter, the reauthentication procedures may not work.

Last modified 4 years ago Last modified on Oct 18, 2013 4:14:47 PM