Skip to content

Commit f1a03b6

Browse files
committed
Update CI documentation
1 parent e7d80e2 commit f1a03b6

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ The game-controller can easily be integrated into your own AI framework, if you
109109

110110
Download the release binary from the Github release and run it from inside your framework.
111111
Then, attach to the WebSocket API that is used by the UI as well to control the game.
112-
The API is defined in [proto/ssl_gc_api.proto](./proto/ssl_gc_api.proto).
112+
The API is defined in [proto/ssl_gc_api.proto](./proto/ssl_gc_api.proto) and available at the path `/api/control`.
113113

114114
If you don't want to run the controller in real time, you can change the time acquisition mode in the `ssl-game-controller.yaml` file:
115115

@@ -122,7 +122,9 @@ This is especially useful, if you run integration tests on your build server in
122122
The GC does not receive vision or tracker packages and does not produce referee messages.
123123
Instead, you should set the correct geometry in `ssl-game-controller.yaml` and send the tracker packages via the CI protocol along the timestamp.
124124
The referee messages are send from the GC to you via the CI protocol as well.
125-
The communication is asynchronous.
125+
For every `CiInput` there will be one or more `CiOutput` responses.
126+
This is, because some changes will generate multiple messages.
127+
`CiOutput` messages will also be pushed to the CI client for manual changes from the UI or UI API.
126128

127129
For details, see: [ssl-ci-test-client](./cmd/ssl-ci-test-client/README.md)
128130

0 commit comments

Comments
 (0)