@corsaircoalition/sergeant-socket

Sergeant Socket

Generally Genius (GG) is a modular generals.io bot framework for development and analysis of game strategies and actions. CorsairCoalition is a collection of components that form the GG framework.

SergeantSocket is an IO module that connects to generals.io via socket.io, publishes all game updates to the Redis message broker, and receives command and actions from other components on Redis.

Configuration

Download config.example.json from the documentation repository and make desired changes.

To setup other components, see the detailed instructions on the project website.

Execution

Install and run the executable:

npm install -g @corsaircoalition/sergeant-socket
sergeant-socket config.json

or run directly from npm library:

npx @corsaircoalition/sergeant-socket config.json

or use docker:

docker run -it -v ./config.json:/config.json ghcr.io/corsaircoalition/sergeantsocket:latest

Usage

Usage: @corsaircoalition/sergeant-socket [options] <configFile>

a modular generals.io bot that implements advanced learning techniques

Options:
  -V, --version       output the version number
  -d, --debug         enable debugging (default: false)
  -h, --help          display help for command