Skip to content

Commit 93ff003

Browse files
committed
[doc] Update readme
1 parent f4d16d8 commit 93ff003

File tree

2 files changed

+28
-20
lines changed

2 files changed

+28
-20
lines changed

README.md

Lines changed: 28 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -48,54 +48,62 @@ List of new features:
4848

4949
### FAQ
5050
#### How to start a new game?
51-
* Reset match (button)
51+
* Go to Settings (top left button)
52+
* Start new game
5253
* Select team names
5354
* Switch sides, if necessary (button)
54-
* Select division (button switch)
55-
* Set goalkeeper id
55+
* Select division, if necessary (button switch)
56+
* Set goalkeeper ids
57+
* Choose which team will start with kickoff
5658
* divB: set ball placement capability
5759

5860
#### How to end a game?
59-
Press 'End of Game' button during stop.
61+
* Stop the game
62+
* Make sure you are in the second half, extra second half or in shootout
63+
* An 'End of Game' button should show up on the top
64+
6065
Purpose: Notify team AI about end of game and log it in log files.
6166

6267
#### How to give a goal?
63-
New Event (button) -> Select Goal -> Insert parameters
68+
If an autoRef has send a 'possible goal', this event can be accepted on the right.
69+
70+
To add a goal manually:
71+
* New Event (on the top)
72+
* Select Goal
73+
* Insert parameters
74+
* Add
6475

6576
#### How to correct the current state of a team?
66-
Most of the state can be changed with the edit buttons.
67-
This should only be used in case of misbehavior! Goals, yellow cards, etc. should be given through the respective events ('New event' button)
77+
Most of the state can be changed with the edit buttons. Either in the settings modal, or in the team overview.
78+
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.
6879

69-
#### How does the undo button work?
70-
With every interaction in the UI and every new game event from an autoRef, the current state will be copied. The last ~20 states will be saved. Undo rolls the state back to the previous state.
71-
The state will be persisted with each change. After a crash or restart, the whole history will be restored.
80+
#### How to revert a change?
81+
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.
82+
The button reverts this line and all following.
7283

7384
#### How to disable certain game events?
74-
Go to 'Configure Behaviors' (button) and select the game event in the dialog.
85+
Go to 'Configure Behaviors' in the settings modal and select the game event.
7586
A game event can be set to be:
7687
* Always accepted
77-
* Only accepted when there is a majority between all connected autoRefs
88+
* Only accepted when there is a majority between all connected autoRefs (if only one autoRef is connected, it will always get a majority)
7889
* Ignored (logged as an ignored event in the table)
7990

8091
#### How does the continue button work?
8192
Based on the current game events, the next command will be determined.
8293
This command is sent, when the continue button is pressed.
83-
The next command is also shown in the top right corner.
94+
The button shows the command that it will trigger.
8495

8596
#### How can I see if my team is connected?
86-
Open connections to teams are shown as an icon next to 'Team Yellow' and 'Team Blue'.
87-
If there is no connection, no icon is shown.
88-
89-
#### How to override/cancel a game event from an autoRef?
90-
All game events that happened since the last running state are listed on the left side with a button to remove this game event again.
97+
Active connections to teams are shown as an icon in the team overview.
9198

9299
#### The controller crashes on start. What can I do?
93-
Try deleting the history.json file in the working directory. It may got corrupted.
100+
Try deleting the gc-state.json file in the working directory. It may got corrupted.
94101

95102
## Integration into your own framework
96103
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.
97104

98-
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).
105+
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.
106+
The API is defined in [internal/app/controller/events.go](internal/app/controller/events.go).
99107

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

doc/screenshot_interface.png

455 KB
Loading

0 commit comments

Comments
 (0)