Clients Configuration

Clients can be initialized from INI style files and have many options. You may also want to look at ClientCommandLineArgs. There's also the example configuration. The config file is broken up into sections and options. Sections are encolsed in [brackets]. Options are a key and value separated by an equals sign.

Client Section

The most important section is the Client section. This defines the top level options for the client's Conductor class.

  • serviceNames: a comma separated list of service names. Each service name is expected to point to a section in the config file.
  • name: the name of the client.
  • connectionFactories: like the serviceNames (comma separated and pointing to a section in the file), but they define outgoing connection factories that the server can use.
  • logs: specify the logging mechanisms. Deprecated, don't use,
  • logLevel: specify the verbosity of the logging mechanism. (nonfunctional currently)
  • consolePort: (new in 0.31, optional configure an ssh console on this port that leads into the server. Must also include consoleUsers option.
  • consoleUsers: (new in 0.31) a comma separated list of username:password pairs that will be allowed to log in to the console.

Graphics Section

This specifies the properties of the graphics output.

  • optionsWindow: True or False. If True, the standard Ogre3D graphics options window will be opened and most of the rest of the options in this section will be ignored in favor of what the user selects there.
  • system: The first part of the rendering system to use
  • Colour Depth: how many bits per pixel. Generally, 32 or 24.
  • Display Frequency: ?
  • FSAA: Set to the level of antialiasing you want.
  • fullScreen: Yes or No.
  • RTT Preferred Mode: FBO (are there other options?)
  • VSync: Yes or No. Specifies whether the frame rate maxes out at your monitor's refresh rate.
  • resolution: The size of the ogre window (or full screen) in pixels.

Service Definition

These sections are pointed to by the serviceNames option in the main config section. They have a several generic options that apply to all services.

  • type: specify a module and class of the service to instantiate.

Services

mv3d.client.sim.SimService?

mv3d.client.asset.AssetService?

  • assetServices: a comma separated list of URLs to specify parent asset servers

mv3d.client.player.PlayerService?

  • servers: A list of strings (URLs) to specify the player servers to talk to.
  • autoConnect: set to True, this will attempt to automatically log in to the server specified by ac-server.
  • ac-server: the server to use when autoConnect is True
  • defaultLogin: the credentials to use as default when connecting
  • defaultPC: the name (or the first part of it) of a PC to connect to automatically.

Connection Factories

[pydoc:mv3d.net.client.mv3d.net.client.PBConFactory]

  • defaultCredentials: the default login to use when connecting externally.
  • loginServices: a comma separated list of URLs that will act as login services.

[pydoc:mv3d.net.client.JSONConFactory]

  • protocol: either http or https and specifies the default protocol for this service to use.

Back to TechnicalDocumentation.