Skip to content

Commit c77ac6f

Browse files
committed
[doc] Add some FAQs
1 parent fa3b227 commit c77ac6f

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed

README.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,52 @@ List of new features:
4242
* New interfaces for autoRefs and teams
4343
* A graphical client can be integrated
4444

45+
### FAQ
46+
#### How to start a new game?
47+
* Reset match (button)
48+
* Select team names
49+
* Switch sides, if necessary (button)
50+
* Select division (button switch)
51+
* Set goalie id
52+
* divB: set ball placement capability
53+
54+
#### How to end a game?
55+
Press 'End of Game' button during stop.
56+
Purpose: Notify team AI about end of game and log it in log files.
57+
58+
#### How to give a goal?
59+
New Event (button) -> Select Goal -> Insert parameters
60+
61+
#### How to correct the current state of a team?
62+
Most of the state can be changed with the edit buttons.
63+
This should only be used in case of misbehavior! Goals, yellow cards, etc. should be given through the respective events ('New event' button)
64+
65+
#### How does the undo button work?
66+
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.
67+
The state will be persisted with each change. After a crash or restart, the whole history will be restored.
68+
69+
#### How to disable certain game events?
70+
Go to 'Configure Behaviors' (button) and select the game event in the dialog.
71+
A game event can be set to be:
72+
* Always accepted
73+
* Only accepted when there is a majority between all connected autoRefs
74+
* Ignored (logged as an ignored event in the table)
75+
76+
#### How does the continue button work?
77+
Based on the current game events, the next command will be determined.
78+
This command is sent, when the continue button is pressed.
79+
The next command is also shown in the top right corner.
80+
81+
#### How can I see if my team is connected?
82+
Open connections to teams are shown as an icon next to 'Team Yellow' and 'Team Blue'.
83+
If there is no connection, no icon is shown.
84+
85+
#### How to override/cancel a game event from an autoRef?
86+
TODO
87+
88+
#### The controller crashes on start. What can I do?
89+
Try deleting the history.json file in the working directory. It may got corrupted.
90+
4591
## Development
4692

4793
### Requirements

0 commit comments

Comments
 (0)