Skip to content

Commit bf551b2

Browse files
committed
Update documentation
1 parent 87af59f commit bf551b2

File tree

4 files changed

+34
-42
lines changed

4 files changed

+34
-42
lines changed

README.md

Lines changed: 32 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@
66

77
# ssl-game-controller
88

9-
The [ssl-refbox](https://github.com/RoboCup-SSL/ssl-refbox) replacement that was introduced at RoboCup 2019.
9+
The game controller for matches in the RoboCup Small Size league, introduced at RoboCup 2019 as a replacement of
10+
the [ssl-refbox](https://github.com/RoboCup-SSL/ssl-refbox).
1011

1112
![Screenshot of Interface](./doc/screenshot_interface.png)
1213

@@ -27,23 +28,27 @@ docker run -p 8081:8081 \
2728
robocupssl/ssl-game-controller
2829
```
2930

30-
The controller will generate a default configs to [config/](./config/) on the first start. Afterwards, you can change all settings there.
31+
The controller will generate a default config to [config/](./config/) on the first start. Afterwards, you can change all
32+
settings there.
3133

32-
For example, if you want to add a new team name temporarily, you can add it to [config/engine.yaml](./config/engine.yaml). If you want to add your team persistently, add it to `defaultTeams` in [internal/app/engine/config.go](internal/app/engine/config.go) and create a Pull Request on GitHub.
34+
For example, if you want to add a new team name temporarily, you can add it
35+
to [config/engine.yaml](./config/engine.yaml). If you want to add your team persistently, add it to `defaultTeams`
36+
in [internal/app/engine/config.go](internal/app/engine/config.go) and create a pull request on GitHub.
3337

3438
### Runtime Requirements
35-
* No software dependencies (except for development, see below)
36-
* 64bit Linux, Windows, OSX (build your 32bit binaries yourself...)
37-
* Display Resolution of 1920x1080 is recommended
38-
* A reasonable Web-Browser (mostly tested on Chrome)
39-
* (optional) To view the field, you need the [ssl-vision-client](https://github.com/RoboCup-SSL/ssl-vision-client)
39+
40+
* No software dependencies (except for development, see below)
41+
* pre-build binaries: 64bit Linux, Windows, OSX
42+
* A reasonable Web-Browser (mostly tested on Chrome)
4043

4144
### External Runtime Dependencies
42-
[ssl-vision](https://github.com/RoboCup-SSL/ssl-vision) - Receive Geometry packages for correct field dimensions
43-
If not available, make sure to configure to correct dimensions in [config/ssl-game-controller.yaml](config/ssl-game-controller.yaml).
45+
46+
[ssl-vision](https://github.com/RoboCup-SSL/ssl-vision) - Receive Geometry packages for correct field dimensions.
47+
If not available, make sure to configure the correct dimensions
48+
in [config/ssl-game-controller.yaml](config/ssl-game-controller.yaml).
4449

4550
tracker-source implementation that produces
46-
[TrackerWrapperPacket](https://github.com/RoboCup-SSL/ssl-vision/blob/master/src/shared/proto/messages_robocup_ssl_wrapper_tracked.proto) -
51+
[TrackerWrapperPacket](https://github.com/RoboCup-SSL/ssl-vision/blob/master/src/shared/proto/messages_robocup_ssl_wrapper_tracked.proto) -
4752
Get ball and robot positions.
4853
Required for:
4954
* Check ball placement progress
@@ -52,7 +57,8 @@ Required for:
5257
* Check for "no progress"
5358
* Check if keeper may be changed via team protocol
5459

55-
The [TIGERs AutoRef](https://github.com/TIGERs-Mannheim/AutoReferee) is a tracker-source implementation.
60+
The [TIGERs AutoRef](https://github.com/TIGERs-Mannheim/AutoReferee) and
61+
the [ER-Force AutoRef](https://github.com/robotics-erlangen/autoref) are tracker-source implementations.
5662
If no tracker-source is available, the above features will not work.
5763

5864
### Reference Clients
@@ -120,39 +126,36 @@ under the same port as the UI.
120126
## Development
121127

122128
### Requirements
123-
You need to install following dependencies first:
124-
* Go
125-
* Node
126-
* Yarn
127-
128-
See [.circleci/config.yml](.circleci/config.yml) for required versions.
129129

130-
### Install dependencies
131-
```bash
132-
yarn install
133-
```
130+
You need to install following dependencies first:
131+
132+
* Go
133+
* Node
134+
135+
See [.circleci/config.yml](.circleci/config.yml) for required versions.
136+
137+
### Frontend
138+
139+
See [frontend/README.md](frontend/README.md)
134140

135141
### Run
142+
136143
Run the backend:
137-
```bash
138-
go run cmd/ssl-game-controller/main.go
139-
```
140144

141-
Run the UI:
142145
```bash
143-
# compile and hot-reload
144-
yarn serve
146+
go run cmd/ssl-game-controller/main.go
145147
```
146148

147149
### Build self-contained release binary
150+
148151
```bash
149152
./install.sh
150153
```
151154

152155
### Test with autoRefs
153156
To quickly run the GC together with autoRefs and other popular components, run:
154157
```shell
155-
docker-compose up
158+
docker compose up
156159
```
157160

158161
### Update generated protobuf code

doc/screenshot_interface.png

-329 KB
Loading

frontend/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# ssl-game-controller frontend v2
1+
# ssl-game-controller frontend
22

33
## Project Setup
44

generateProto.sh

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -38,18 +38,7 @@ set -x
3838

3939
protoc -I"./proto" -I"$GOPATH/src" --go_out="$GOPATH/src" proto/*.proto
4040

41-
# generate javascript code
42-
pbjs -t static-module -w es6 -o src/proto.js \
43-
proto/ssl_gc_common.proto \
44-
proto/ssl_gc_geometry.proto \
45-
proto/ssl_gc_game_event.proto \
46-
proto/ssl_gc_referee_message.proto \
47-
proto/ssl_gc_change.proto \
48-
proto/ssl_gc_state.proto \
49-
proto/ssl_gc_api.proto \
50-
proto/ssl_gc_engine.proto
51-
52-
# generate typescript code for frontend v2
41+
# generate typescript code for frontend
5342
target_dir="./frontend/src/proto"
5443
mkdir -p "${target_dir}"
5544
protoc -I"./proto" \

0 commit comments

Comments
 (0)