@socialgorithm/uatc

UATC - Ultimate Algorithm Test Client

This is a small test package for testing the socialgorithm platform.

Getting started

Running from NPX executable

This is the quickest way to get started:

npx @socialgorithm/uatc help

Building and running from Sources

To install and run this util clone this repo and:

npm i
npm run build
node ./dist/uatc.js help

This expects that @socialgorithm/uabc is installed globally.

You will also need a player(s) that is ready to connect and play games.

Commands

uatc init - Spits out a scaffolding config file.

uatc play - Play a tournament.

uatc start-servers - Starts the game servers.

uatc stop-servers - Stops the game servers.

uatc validate-servers - Prints the status of the game servers

Config

This package is configured via a uatc.js file in the directory your running the command.

The best way to create this is to run uatc init which will give you the basic scaffolding.

Config:

{
	playTournament: {                                       // The config for the play mode. 
		players: [                                      // A collection of players to run against the game
			{
				command: 'node example.js',     // The command to run to start this player. See uabc file arg
				number: 5,                      // The number of players of this type to connect
				name: 'example'                 // The name to use when connecting to the game
			}
		],
		tournamentServerAddress: 'http://localhost:3141',
		autoplay: true,
		tournamentSettings: {                           // Settings to use when playing the tournament
			timeout: 100,
			numberOfGames: 50,
			type: "DoubleElimination",
			autoPlay: false
		}
	},
	servers: {      // config for the servers
		tournament: {
			location: '../tournament-server',       // relative location of the server. Must be npm installed and built
			startupCommand: 'node ./dist/index.js', // ensure this command starts the server rather than runs a script that spawns it like an npm command
			expectedPort: 3141                      // where it is expected to be once started. Used for validation
		},
		game: {
			location: '../tic-tac-toe-game-server',
			startupCommand: 'node ./dist/index.js',
			expectedPort: 5433
		}
	}
}