Update to new flatbuffer spec

Author: VirxEC

pyproject.toml

@@ -8,7 +8,7 @@ description = "A high performance Python interface for communicating with RLBot
 dynamic = ["version"]
 requires-python = ">= 3.11"
 dependencies = [
-    "rlbot_flatbuffers~=0.12.0",
+    "rlbot_flatbuffers~=0.13.0",
     "psutil==6.*",
 ]
 readme = "README.md"

rlbot/interface.py

@@ -27,7 +27,7 @@ class SocketDataType(IntEnum):
     GAME_PACKET = 1
     FIELD_INFO = 2
     START_COMMAND = 3
-    MATCH_SETTINGS = 4
+    MATCH_CONFIGURATION = 4
     PLAYER_INPUT = 5
     DESIRED_GAME_STATE = 6
     RENDER_GROUP = 7
@@ -63,8 +63,8 @@ class SocketRelay:
     on_connect_handlers: list[Callable[[], None]] = []
     packet_handlers: list[Callable[[flat.GamePacket], None]] = []
     field_info_handlers: list[Callable[[flat.FieldInfo], None]] = []
-    match_settings_handlers: list[Callable[[flat.MatchSettings], None]] = []
-    match_communication_handlers: list[Callable[[flat.MatchComm], None]] = []
+    match_config_handlers: list[Callable[[flat.MatchConfiguration], None]] = []
+    match_comm_handlers: list[Callable[[flat.MatchComm], None]] = []
     ball_prediction_handlers: list[Callable[[flat.BallPrediction], None]] = []
     controllable_team_info_handlers: list[
         Callable[[flat.ControllableTeamInfo], None]
@@ -151,17 +151,17 @@ def stop_match(self, shutdown_server: bool = False):
         flatbuffer = flat.StopCommand(shutdown_server).pack()
         self.send_bytes(flatbuffer, SocketDataType.STOP_COMMAND)
 
-    def start_match(self, match_config: Path | flat.MatchSettings):
+    def start_match(self, match_config: Path | flat.MatchConfiguration):
         self.logger.info("Python interface is attempting to start match...")
 
         match match_config:
             case Path() as path:
                 string_path = str(path.absolute().resolve())
                 flatbuffer = flat.StartCommand(string_path).pack()
                 flat_type = SocketDataType.START_COMMAND
-            case flat.MatchSettings() as settings:
+            case flat.MatchConfiguration() as settings:
                 flatbuffer = settings.pack()
-                flat_type = SocketDataType.MATCH_SETTINGS
+                flat_type = SocketDataType.MATCH_CONFIGURATION
             case _:
                 raise ValueError(
                     "Expected MatchSettings or path to match settings toml file"
@@ -310,15 +310,17 @@ def handle_incoming_message(self, incoming_message: SocketMessage):
                     field_info = flat.FieldInfo.unpack(incoming_message.data)
                     for handler in self.field_info_handlers:
                         handler(field_info)
-            case SocketDataType.MATCH_SETTINGS:
-                if len(self.match_settings_handlers) > 0:
-                    match_settings = flat.MatchSettings.unpack(incoming_message.data)
-                    for handler in self.match_settings_handlers:
+            case SocketDataType.MATCH_CONFIGURATION:
+                if len(self.match_config_handlers) > 0:
+                    match_settings = flat.MatchConfiguration.unpack(
+                        incoming_message.data
+                    )
+                    for handler in self.match_config_handlers:
                         handler(match_settings)
             case SocketDataType.MATCH_COMMUNICATION:
-                if len(self.match_communication_handlers) > 0:
+                if len(self.match_comm_handlers) > 0:
                     match_comm = flat.MatchComm.unpack(incoming_message.data)
-                    for handler in self.match_communication_handlers:
+                    for handler in self.match_comm_handlers:
                         handler(match_comm)
             case SocketDataType.BALL_PREDICTION:
                 if len(self.ball_prediction_handlers) > 0:

rlbot/managers/bot.py

@@ -25,7 +25,7 @@ class Bot:
     name: str = ""
     spawn_id: int = 0
 
-    match_settings = flat.MatchSettings()
+    match_config = flat.MatchConfiguration()
     """
     Contains info about what map you're on, game mode, mutators, etc.
     """
@@ -60,9 +60,9 @@ def __init__(self, default_agent_id: Optional[str] = None):
             exit(1)
 
         self._game_interface = SocketRelay(agent_id, logger=self.logger)
-        self._game_interface.match_settings_handlers.append(self._handle_match_settings)
+        self._game_interface.match_config_handlers.append(self._handle_match_config)
         self._game_interface.field_info_handlers.append(self._handle_field_info)
-        self._game_interface.match_communication_handlers.append(
+        self._game_interface.match_comm_handlers.append(
             self._handle_match_communication
         )
         self._game_interface.ball_prediction_handlers.append(
@@ -86,7 +86,7 @@ def _try_initialize(self):
             return
 
         # Search match settings for our name
-        for player in self.match_settings.player_configurations:
+        for player in self.match_config.player_configurations:
             if player.spawn_id == self.spawn_id:
                 self.name = player.name
                 self.logger = get_logger(self.name)
@@ -104,8 +104,8 @@ def _try_initialize(self):
         self._initialized_bot = True
         self._game_interface.send_init_complete()
 
-    def _handle_match_settings(self, match_settings: flat.MatchSettings):
-        self.match_settings = match_settings
+    def _handle_match_config(self, match_config: flat.MatchConfiguration):
+        self.match_config = match_config
         self._has_match_settings = True
         self._try_initialize()
 

rlbot/managers/hivemind.py

@@ -27,7 +27,7 @@ class Hivemind:
     names: list[str] = []
     spawn_ids: list[int] = []
 
-    match_settings = flat.MatchSettings()
+    match_config = flat.MatchConfiguration()
     """
     Contains info about what map you're on, game mode, mutators, etc.
     """
@@ -62,9 +62,9 @@ def __init__(self, default_agent_id: Optional[str] = None):
             exit(1)
 
         self._game_interface = SocketRelay(agent_id, logger=self._logger)
-        self._game_interface.match_settings_handlers.append(self._handle_match_settings)
+        self._game_interface.match_config_handlers.append(self._handle_match_config)
         self._game_interface.field_info_handlers.append(self._handle_field_info)
-        self._game_interface.match_communication_handlers.append(
+        self._game_interface.match_comm_handlers.append(
             self._handle_match_communication
         )
         self._game_interface.ball_prediction_handlers.append(
@@ -88,7 +88,7 @@ def _try_initialize(self):
 
         # Search match settings for our spawn ids
         for spawn_id in self.spawn_ids:
-            for player in self.match_settings.player_configurations:
+            for player in self.match_config.player_configurations:
                 if player.spawn_id == spawn_id:
                     self.names.append(player.name)
                     self.loggers.append(get_logger(player.name))
@@ -108,8 +108,8 @@ def _try_initialize(self):
         self._initialized_bot = True
         self._game_interface.send_init_complete()
 
-    def _handle_match_settings(self, match_settings: flat.MatchSettings):
-        self.match_settings = match_settings
+    def _handle_match_config(self, match_config: flat.MatchConfiguration):
+        self.match_config = match_config
         self._has_match_settings = True
         self._try_initialize()
 

rlbot/managers/match.py

@@ -219,14 +219,14 @@ def connect(
         )
 
     def wait_for_first_packet(self):
-        while self.packet is None or self.packet.game_info.game_status in {
-            flat.GameStatus.Inactive,
-            flat.GameStatus.Ended,
+        while self.packet is None or self.packet.match_info.match_phase in {
+            flat.MatchPhase.Inactive,
+            flat.MatchPhase.Ended,
         }:
             sleep(0.1)
 
     def start_match(
-        self, settings: Path | flat.MatchSettings, wait_for_start: bool = True
+        self, config: Path | flat.MatchConfiguration, wait_for_start: bool = True
     ):
         """
         Starts a match using the given match settings or a path to a match settings toml file.
@@ -244,7 +244,7 @@ def start_match(
             )
             self.rlbot_interface.run(background_thread=True)
 
-        self.rlbot_interface.start_match(settings)
+        self.rlbot_interface.start_match(config)
 
         if not self.initialized:
             self.rlbot_interface.send_init_complete()

rlbot/managers/script.py

@@ -22,7 +22,7 @@ class Script:
     index: int = 0
     name: str = "UnknownScript"
 
-    match_settings = flat.MatchSettings()
+    match_config = flat.MatchConfiguration()
     field_info = flat.FieldInfo()
     ball_prediction = flat.BallPrediction()
 
@@ -45,9 +45,9 @@ def __init__(self, default_agent_id: Optional[str] = None):
             exit(1)
 
         self._game_interface = SocketRelay(agent_id, logger=self.logger)
-        self._game_interface.match_settings_handlers.append(self._handle_match_settings)
+        self._game_interface.match_config_handlers.append(self._handle_match_config)
         self._game_interface.field_info_handlers.append(self._handle_field_info)
-        self._game_interface.match_communication_handlers.append(
+        self._game_interface.match_comm_handlers.append(
             self._handle_match_communication
         )
         self._game_interface.ball_prediction_handlers.append(
@@ -81,10 +81,10 @@ def _try_initialize(self):
         self._initialized_script = True
         self._game_interface.send_init_complete()
 
-    def _handle_match_settings(self, match_settings: flat.MatchSettings):
-        self.match_settings = match_settings
+    def _handle_match_config(self, match_config: flat.MatchConfiguration):
+        self.match_config = match_config
 
-        for i, script in enumerate(match_settings.script_configurations):
+        for i, script in enumerate(match_config.script_configurations):
             if script.agent_id == self._game_interface.agent_id:
                 self.index = i
                 self.name = script.name

rlbot/version.py

@@ -1,4 +1,4 @@
-__version__ = "5.0.0-beta.16"
+__version__ = "5.0.0-beta.17"
 
 
 RESET_SEQ = "\033[0m"
@@ -15,6 +15,9 @@ def _get_color(color: int) -> str:
 )
 
 RELEASE_NOTES = {
+    "5.0.0-beta.17": """
+    - Update to the newest flatbuffers spec
+    """,
     "5.0.0-beta.16": """
     - Read `RLBOT_SERVER_IP` environment variable and default to "127.0.0.1"
     """,

tests/atba/atba.py

@@ -97,10 +97,10 @@ def get_output(self, packet: flat.GamePacket) -> flat.ControllerState:
             self.test_rendering(packet)
 
         if (
-            packet.game_info.game_status
+            packet.match_info.match_phase
             not in {
-                flat.GameStatus.Active,
-                flat.GameStatus.Kickoff,
+                flat.MatchPhase.Active,
+                flat.MatchPhase.Kickoff,
             }
             or len(packet.balls) == 0
         ):
@@ -111,9 +111,9 @@ def get_output(self, packet: flat.GamePacket) -> flat.ControllerState:
 
         if self.match_comms:
             # Limit packet spam
-            if packet.game_info.frame_num - self.last_send >= 360:
+            if packet.match_info.frame_num - self.last_send >= 360:
                 self.send_match_comm(b"", "Hello world!", True)
-                self.last_send = packet.game_info.frame_num
+                self.last_send = packet.match_info.frame_num
 
         ball_location = Vector2(packet.balls[0].physics.location)
 

tests/default.toml

@@ -1,6 +1,6 @@
 [rlbot]
 # use this along with launcher = "custom"
-# game_path = "legendary"
+# launcher_arg = "legendary"
 # "Steam", "Epic", "Custom"
 launcher = "steam"
 # Should RLBot start the bot processes automatically, or will a separate script start them
@@ -17,7 +17,7 @@ skip_replays = false
 # Skip the kickoff countdown
 start_without_countdown = false
 # What should we do if you click run while a match is already in progress?
-# "Restart_If_Different", "Restart", "Continue_And_Spawn"
+# "RestartIfDifferent", "Restart", "ContinueAndSpawn"
 existing_match_behavior = "Restart"
 enable_rendering = false
 enable_state_setting = true
@@ -26,39 +26,39 @@ auto_save_replay = false
 freeplay = false
 
 [mutators]
-# "Five_Minutes", "Ten_Minutes", "Twenty_Minutes", "Unlimited"
-match_length = "Five_Minutes"
-# "Default", "One_Goal", "Three_Goals", "Five_Goals", "Seven Goals", "Unlimited"
+# "FiveMinutes", "TenMinutes", "TwentyMinutes", "Unlimited"
+match_length = "FiveMinutes"
+# "Default", "OneGoal", "ThreeGoals", "FiveGoals", "SevenGoals", "Unlimited"
 max_score = "Default"
 # "One", "Two", "Four", "Six"
 multi_ball = "One"
-# "Unlimited", "Five_Max_First_Score", "Five_Max_Random_Team"
+# "Unlimited", "FiveMaxFirstScore", "FiveMaxRandomTeam"
 overtime = "Unlimited"
-# "Default", "Slo_Mo", "Time_Warp"
+# "Default", "SloMo", "TimeWarp"
 game_speed = "Default"
-# "Default", "Slow", "Fast", "Super_Fast"
+# "Default", "Slow", "Fast", "SuperFast"
 ball_max_speed = "Default"
-# "Default", "Cube", "Puck", "Basketball", "Beachball", "Anniversary", "Haunted", "Ekin", "SpookyCube"
+# "Default", "Cube", "Puck", "Basketball", "Beachball", "Anniversary", "Haunted", "Ekin"
 ball_type = "Default"
-# "Default", "Light", "Heavy", "Super_Light", "Curve_Ball", "Beach_Ball_Curve", "Magnus_FutBall"
+# "Default", "Light", "Heavy", "SuperLight", "CurveBall", "BeachBallCurve", "MagnusFutBall"
 ball_weight = "Default"
 # "Default", "Small", "Medium", "Large", "Gigantic"
 ball_size = "Default"
-# "Default", "Low", "LowishBounciness", "High", "Super_High"
+# "Default", "Low", "LowishBounciness", "High", "SuperHigh"
 ball_bounciness = "Default"
-# "Normal_Boost", "Unlimited_Boost", "Slow_Recharge", "Rapid_Recharge", "No_Boost"
-boost_amount = "Normal_Boost"
-# "No_Rumble", "Default", "Slow", "Civilized", "Destruction_Derby", "Spring_Loaded", "Spikes_Only", "Spike_Rush", "Haunted_Ball_Beam", "Tactical", "BatmanRumble"
-rumble = "No_Rumble"
+# "NormalBoost", "UnlimitedBoost", "SlowRecharge", "RapidRecharge", "NoBoost"
+boost_amount = "NormalBoost"
+# "NoRumble", "Default", "Slow", "Civilized", "DestructionDerby", "SpringLoaded", "SpikesOnly", "SpikeRush", "HauntedBallBeam", "Tactical", "BatmanRumble"
+rumble = "NoRumble"
 # "One", "OneAndAHalf", "Two", "Five", "Ten"
 boost_strength = "One"
-# "Default", "Low", "High", "Super_High", "Reverse"
+# "Default", "Low", "High", "SuperHigh", "Reverse"
 gravity = "Default"
-# "Default", "Disabled", "Friendly_Fire", "On_Contact", "On_Contact_FF"
+# "Default", "Disabled", "FriendlyFire", "OnContact", "OnContactFF"
 demolish = "Default"
-# "Three_Seconds", "Two_Seconds", "One_Second", "Disable_Goal_Reset"
-respawn_time = "Three_Seconds"
-# "Default", "Eleven_Minutes"
+# "Three_Seconds", "TwoSeconds", "OneSecond", "DisableGoalReset"
+respawn_time = "ThreeSeconds"
+# "Default", "ElevenMinutes"
 max_time = "Default"
 # "Default", "Haunted", "Rugby"
 game_event = "Default"

tests/gamemodes/beach_ball.toml

@@ -6,7 +6,7 @@ game_map_upk = "Stadium_P"
 [mutators]
 ball_max_speed = "Fast"
 ball_type = "Beachball"
-ball_weight = "Beach_Ball_Curve"
+ball_weight = "BeachBallCurve"
 ball_size = "Medium"
 ball_bounciness = "High"