Skip to content

Commit b25cf9b

Browse files
committed
Update documentation
1 parent d5f69a0 commit b25cf9b

File tree

3 files changed

+6
-2
lines changed

3 files changed

+6
-2
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,10 @@ Active connections to teams are shown as an icon in the team overview.
100100
#### The controller crashes on start. What can I do?
101101
Try deleting the `state-store.json.stream` file in the working directory. It may got corrupted.
102102

103+
#### How can I use TLS?
104+
Generate a new `server.crt` for the game-controller with [tools/newX509KeyPair.sh](./tools/newX509KeyPair.sh).
105+
See instructions for the client part in the reference clients mentioned above.
106+
103107
## Integration into your own framework
104108
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.
105109

cmd/ssl-auto-ref-client/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ This folder contains a sample client that connects to the autoRef interface of t
55
## Protocol
66
The communication is established with a bidirectional TCP connection. Messages are encoded with [Protocol Buffers](https://developers.google.com/protocol-buffers/). Each message is preceded by an uvarint containing the message size in bytes, see https://cwiki.apache.org/confluence/display/GEODE/Delimiting+Protobuf+Messages for details.
77

8-
The .proto files can be found [here](../../pkg/refproto).
8+
The .proto files can be found in [../../proto](../../proto).
99

1010
The default port is `10007`. The IP to connect to can be determined using the multicast referee messages.
1111

cmd/ssl-team-client/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ This folder contains a sample client that connects to the team interface of the
55
## Protocol
66
The communication is established with a bidirectional TCP connection. Messages are encoded with [Protocol Buffers](https://developers.google.com/protocol-buffers/). Each message is preceded by an uvarint containing the message size in bytes, see https://cwiki.apache.org/confluence/display/GEODE/Delimiting+Protobuf+Messages for details.
77

8-
The .proto files can be found [here](../../pkg/refproto).
8+
The .proto files can be found in [../../proto](../../proto).
99

1010
The default port is `10008` for plain connections and 10108 for TLS encrypted connections. The IP to connect to can be determined using the multicast referee messages.
1111

0 commit comments

Comments
 (0)