Package com.github.ocraft.s2client.bot.syntax

Interface SettingsSyntax

All Superinterfaces:

GameParticipantSyntax, ReplaySyntax, StartGameSyntax

public interface SettingsSyntax
extends GameParticipantSyntax, ReplaySyntax

Method Summary

Modifier and Type	Method	Description
SettingsSyntax	loadLadderSettings(java.lang.String[] args)	Used to load ladder settings.
SettingsSyntax	loadSettings(java.lang.String[] args)	Used to load settings.
SettingsSyntax	setDataDir(java.nio.file.Path dataDirPath)	Override the path to find the data package.
SettingsSyntax	setDataVersion(java.lang.String version)	Set the correct data version of a replay to allow faster replay loading.
SettingsSyntax	setEglPath(java.nio.file.Path eglPath)	Sets the path the to hardare rendering library.
SettingsSyntax	setFeatureLayers(SpatialCameraSetup settings)	Indicates whether feature layers should be provided in the observation.
SettingsSyntax	setMultithreaded(java.lang.Boolean value)	Specifies whether bots or replays onStep function should be run in parallel.
SettingsSyntax	setOsMesaPath(java.nio.file.Path osMesaPath)	Sets the path the to software rendering library.
SettingsSyntax	setPortStart(java.lang.Integer portStart)	Sets the first port number to use.
SettingsSyntax	setProcessPath(java.nio.file.Path path)	Sets the path to the StarCraft II binary.
SettingsSyntax	setRealtime(java.lang.Boolean value)	Specifies whether the game should run in realtime or not.
SettingsSyntax	setRender(SpatialCameraSetup settings)	Indicates whether render layers should be provided in the observation.
SettingsSyntax	setStepSize(java.lang.Integer stepSize)	Sets the number of game loops to run for each step.
SettingsSyntax	setTimeoutMS(java.lang.Integer timeoutInMillis)	Sets the timeout for network operations.
SettingsSyntax	setTmpDir(java.nio.file.Path tmpDirPath)	Overrides the directory that temp files are created in.
SettingsSyntax	setTraced(java.lang.Boolean value)	Enables logging on client of all protocol requests/responses to com.github.ocraft.s2client.api.log.DataFlowTracer logger on level TRACE (JSON format).
SettingsSyntax	setUseGeneralizedAbilityId(java.lang.Boolean value)	Uses generalized abilities where possible.
SettingsSyntax	setVerbose(java.lang.Boolean value)	Enables logging on game server of all protocol requests/responses to std::err.
SettingsSyntax	setWindowLocation(java.lang.Integer x, java.lang.Integer y)	Sets the game window location.
SettingsSyntax	setWindowSize(java.lang.Integer width, java.lang.Integer height)	Sets the game window dimensions.

Methods inherited from interface com.github.ocraft.s2client.bot.syntax.GameParticipantSyntax

setParticipants

Methods inherited from interface com.github.ocraft.s2client.bot.syntax.ReplaySyntax

addReplayObserver, loadReplayList, setReplayPath, setReplayRecovery

Methods inherited from interface com.github.ocraft.s2client.bot.syntax.StartGameSyntax

connect, connectToLadder, launchStarcraft

Method Detail

loadSettings

SettingsSyntax loadSettings(java.lang.String[] args)

Used to load settings. Settings will be discovered in the following order:

1. If command line arguments are provided it will use them. Invoke binary with --help to see expected arguments.
2. (Recommended) If the StarCraft II binary has been run the function will auto discover its location.

Parameters:

args - Provided in main signature.

loadLadderSettings

SettingsSyntax loadLadderSettings(java.lang.String[] args)

Used to load ladder settings.

Parameters:

args - Provided in main signature.

setMultithreaded

SettingsSyntax setMultithreaded(java.lang.Boolean value)

Specifies whether bots or replays onStep function should be run in parallel. If set to true make sure your bots are thread-safe if they reach into shared code.

Parameters:

value - True to multi-thread, false otherwise.

setRealtime

SettingsSyntax setRealtime(java.lang.Boolean value)

Specifies whether the game should run in realtime or not. If the game is running in real time that means the coordinator is not stepping it forward. The game is running and your bot reaches into it asynchronously to read state.

Parameters:

value - True to be realtime, false otherwise.

setStepSize

SettingsSyntax setStepSize(java.lang.Integer stepSize)

Sets the number of game loops to run for each step.

Parameters:

stepSize - Number of game loops to run for each step.

setProcessPath

SettingsSyntax setProcessPath(java.nio.file.Path path)

Sets the path to the StarCraft II binary.

Parameters:

path - Absolute file path.

setDataVersion

SettingsSyntax setDataVersion(java.lang.String version)

Set the correct data version of a replay to allow faster replay loading. Saves a few seconds if replay is not up to date. Works only in combination with correct process path set by "setProcessPath".

Parameters:

version - Look in "ocraft-s2client-protocol/src/main/resources/versions.json" for the property "data-hash". Or read it from ReplayInfo.dataVersion.

setTimeoutMS

SettingsSyntax setTimeoutMS(java.lang.Integer timeoutInMillis)

Sets the timeout for network operations.

Parameters:

timeoutInMillis - timeout in milliseconds.

setPortStart

SettingsSyntax setPortStart(java.lang.Integer portStart)

Sets the first port number to use. Subsequent port assignments are sequential.

Parameters:

portStart - First port number.

setFeatureLayers

SettingsSyntax setFeatureLayers(SpatialCameraSetup settings)

Indicates whether feature layers should be provided in the observation.

Parameters:

settings - Configuration of feature layer settings.

See Also:

SpatialCameraSetup

setRender

SettingsSyntax setRender(SpatialCameraSetup settings)

Indicates whether render layers should be provided in the observation.

Parameters:

settings - Configuration of render layer settings.

See Also:

SpatialCameraSetup

setWindowSize

SettingsSyntax setWindowSize(java.lang.Integer width,
                             java.lang.Integer height)

Sets the game window dimensions.

Parameters:

width - Width of game window.

height - Height of game window.

setWindowLocation

SettingsSyntax setWindowLocation(java.lang.Integer x,
                                 java.lang.Integer y)

Sets the game window location.

Parameters:

x - X position of game window.

y - y position of game window.

setUseGeneralizedAbilityId

SettingsSyntax setUseGeneralizedAbilityId(java.lang.Boolean value)

Uses generalized abilities where possible.

Example: BUILD_TECHLAB_BARRACKS, BUILD_TECHLAB_FACTORY, BUILD_TECHLAB_STARPORT ability ids are generalized to BUILD_TECHLAB ability id in the observation.

setVerbose

SettingsSyntax setVerbose(java.lang.Boolean value)

Enables logging on game server of all protocol requests/responses to std::err.

setTraced

SettingsSyntax setTraced(java.lang.Boolean value)

Enables logging on client of all protocol requests/responses to com.github.ocraft.s2client.api.log.DataFlowTracer logger on level TRACE (JSON format).

setTmpDir

SettingsSyntax setTmpDir(java.nio.file.Path tmpDirPath)

Overrides the directory that temp files are created in.

Defaults to: /tmp/

Parameters:

tmpDirPath - Path to tmp dir.

setDataDir

SettingsSyntax setDataDir(java.nio.file.Path dataDirPath)

Override the path to find the data package. Required if the binary is not in the standard versions folder location.

Defaults to: ../../

Parameters:

dataDirPath - Path to data dir.

setOsMesaPath

SettingsSyntax setOsMesaPath(java.nio.file.Path osMesaPath)

Sets the path the to software rendering library. Required for using the rendered interface with software rendering

Example: /usr/lib/x86_64-linux-gnu/libOSMesa.so

Parameters:

osMesaPath - Path to OsMesa library.

setEglPath

SettingsSyntax setEglPath(java.nio.file.Path eglPath)

Sets the path the to hardare rendering library. Required for using the rendered interface with hardware rendering.

Example: /usr/lib/nvidia-384/libEGL.so

Parameters:

eglPath - Path to egl library.