Skip to content

Commit a98d59f

Browse files
authored
Add section about integrating the GC elsewhere
1 parent c02c109 commit a98d59f

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,14 @@ All game events that happened since the last running state are listed on the lef
8888

8989
#### The controller crashes on start. What can I do?
9090
Try deleting the history.json file in the working directory. It may got corrupted.
91-
91+
92+
## Integration into your own framework
93+
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.
94+
95+
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](internal/app/controller/events.go).
96+
97+
An example can be found here: https://github.com/TIGERs-Mannheim/AutoReferee/blob/master/modules/moduli-referee/src/main/java/edu/tigers/sumatra/referee/SslGameControllerProcess.java
98+
9299
## Development
93100

94101
### Requirements
@@ -136,4 +143,4 @@ go get github.com/gobuffalo/packr/packr
136143
# install the binary
137144
cd cmd/ssl-game-controller
138145
packr install
139-
```
146+
```

0 commit comments

Comments
 (0)