Game Data
The majority of the communication between RLBot and its clients consists of MatchConfigurations, FieldInfos, GamePackets, BallPrediction, and Controllers.
All supported languages have access to the same data, though syntax and conventions will vary. The exact data can be found in the flatbuffer schema gamedata.fbs. The schema data is well-documented and explains most game data in detail.
In short:
- MatchConfiguration: Contains the details about the match, its participants, its mutators, etc. It is sent to all clients on match start.
- FieldInfo: Contains static information about the map, including boost pad locations and goal locations. It is sent to all clients on match start.
- GamePacket: Contains live game data, such as ball position and velocity, player positions and velocity, boost pad timers, current scores and time left, and much more. It is send to all clients at 120 Hz.
- BallPrediction: A highly accurate array of the ball's coming states, assuming no car hits it. It is sent alongside the game packet. See BallPrediction.
- Controller: Contains a combination of pressed buttons. The bots send this to the RLBot server as often as possible in reponse to the GamePacket. If a tick is missed, the controller from previous tick is used.
Notable v5 Renames from v4
Several fields were renamed from v4 to v5. The flatbuffer schema is the authoritative reference, but here are the most impactful:
| v4 Name | v5 Name | Notes |
|---|---|---|
GameTickPacket |
GamePacket |
|
game_cars |
players |
|
game_boosts |
boost_pads |
|
game_info |
match_info |
|
ball |
balls |
Now a list (multi-ball support) |
num_* fields |
(removed) | Use len(list) instead |
is_round_active |
match_phase |
Compare against MatchPhase.Active |
is_kickoff_pause |
match_phase |
Compare against MatchPhase.Kickoff |
is_match_ended |
match_phase |
Compare against MatchPhase.Ended |
has_wheel_contact |
air_state |
Compare against AirState.OnGround |
spawn_id |
player_id |
In ControllableTeamInfo |
MatchSettings |
MatchConfiguration |
|
FieldInfoPacket |
FieldInfo |
|
CollisionShape |
shape |
Now a direct union type |
Language-Specific Guides
V4 (legacy):