Skip to content

Latest commit

 

History

History
166 lines (133 loc) · 7.82 KB

README.md

File metadata and controls

166 lines (133 loc) · 7.82 KB
Raw

CircleCI Go Report Card Go Doc Release Coverage

ssl-game-controller

The ssl-refbox replacement that will be introduced at RoboCup 2019.

Screenshot of Interface

Usage

If you just want to use this app, simply download the latest release binary. The binary is self-contained. No dependencies are required.

The controller will generate a default config file to config/ssl-game-controller.yaml on the first start. Afterwards, you can change all settings there.

Runtime Requirements

  • No software dependencies (except for development, see below)
  • 64bit Linux, Windows, OSX (32bit would be possible too, but come on, we are in 2018...)
  • Display Resolution of 1920x1080 is recommended
  • A reasonable Web-Browser (mostly tested on Chrome, please do not try IE...)
  • (optional) To view the field, you need the ssl-vision-client

Reference Clients

There are some reference clients:

Comparison to ssl-refbox

The ssl-game-controller replaces the ssl-refbox. With the introduction of automatic referees, there was demand for several new features. To accommodate these, the ssl-refbox has been rewritten to take advantage of modern technologies.

The referee message, that is send to the teams, has no breaking changes. Teams do not need to change their systems. Additional data will be send with the referee messages though. To read those changes, teams can update their .proto files from this repository to take advantage of it.

Teams will also have the possibility to connect to a new interface, where they can change their goalkeeper number during Stoppage. Additionally, there will be an advantage rule, where teams can decide to let the game continue on certain fouls.

List of new features:

  • Modern, scalable Web-UI
  • More control of the state (change almost all values)
  • Automatically save and restore state
  • State history with undo button
  • Includes state that was previously located in all autoRefs
  • New Game Event concept for better interaction with multiple autoRefs
  • Game Log that documents commands and events
  • New interfaces for autoRefs and teams
  • A graphical client can be integrated

FAQ

How to start a new game?

  • Go to Settings (top left button)
  • Start new game
  • Select team names
  • Switch sides, if necessary (button)
  • Select division, if necessary (button switch)
  • Set goalkeeper ids
  • Choose which team will start with kickoff
  • divB: set ball placement capability

How to end a game?

  • Stop the game
  • Make sure you are in the second half, extra second half or in shootout
  • An 'End of Game' button should show up on the top

Purpose: Notify team AI about end of game and log it in log files.

How to give a goal?

If an autoRef has send a 'possible goal', this event can be accepted on the right.

To add a goal manually:

  • New Event (on the top)
  • Select Goal
  • Insert parameters
  • Add

How to correct the current state of a team?

Most of the state can be changed with the edit buttons. Either in the settings modal, or in the team overview. This should only be used in case of misbehavior! Goals, yellow cards, etc. should be given through the respective events ('New event' button) or in the manual view.

How to revert a change?

The game control allows to revert certain actions like game events or stage changes. For these actions, a revert button will show up in the protocol table. The button reverts this line and all following.

How to disable certain game events?

Go to 'Configure Behaviors' in the settings modal and select the game event.
A game event can be set to be:

  • Always accepted
  • Only accepted when there is a majority between all connected autoRefs (if only one autoRef is connected, it will always get a majority)
  • Ignored (logged as an ignored event in the table)

How does the continue button work?

Based on the current game events, the next command will be determined. This command is sent, when the continue button is pressed. The button shows the command that it will trigger.

How can I see if my team is connected?

Active connections to teams are shown as an icon in the team overview.

The controller crashes on start. What can I do?

Try deleting the gc-state.json file in the working directory. It may got corrupted.

Integration into your own framework

The game-controller can easily be integrated into your own AI framework, if you do not want to implement your own controller for testing purposes.

Download the release binary from the Github release and run it from inside your framework. Then, attach to the WebSocket API that is used by the UI as well. The API is defined in internal/app/controller/events.go.

If you don't want to run the controller in real time, you can change the time acquisition mode:

  1. system (default): Use system time
  2. vision: Receive messages from ssl-vision and use the timestamps from these messages as the time source. This is mostly useful, when you produce your own ssl-vision frames from simulation.
  3. ci: Connect your software directly with TCP. You can send the current timestamp [ns] and will receive the resulting referee message. This also avoids the use of multicast. This is especially useful, if you run integration tests on your build server in parallel. For details, see: internal/app/rcon/ciServer.go

Examples

Development

Requirements

You need to install following dependencies first:

  • Go >= 1.10
  • Node
  • Yarn

Prepare

Download and install to GOPATH:

go get -u github.com/RoboCup-SSL/ssl-game-controller/...

Switch to project root directory

cd $GOPATH/src/github.com/RoboCup-SSL/ssl-game-controller/

Download dependencies for frontend

yarn install

Run

Run the backend:

go run cmd/ssl-game-controller/main.go

Run the UI:

# compile and hot-reload
yarn serve

Or use the provided IntelliJ run configurations.

Build self-contained release binary

First, build the UI resources

# compile and minify UI
yarn build

Then build the backend with packr

# get packr
go get github.com/gobuffalo/packr/packr
# install the binary
cd cmd/ssl-game-controller
packr install