Merge pull request #34 from RLBot/cfg

Beta 48

Author: NicEastvillage

.gitignore

@@ -175,6 +175,7 @@ pyrightconfig.json
 
 # End of https://www.toptal.com/developers/gitignore/api/python
 
+uv.lock
 .vscode/
 *.obj
 RLBotServer*

README.md

@@ -30,10 +30,11 @@ The following is how to setup a development environment for this project, NOT ho
   - `pip uninstall rlbot_flatbuffers`
   - `pip install --editable <path/to/rlbot_flatbuffers>`
 
-This project is formatted using [Black](https://github.com/psf/black).
+This project is formatted using [Ruff](https://docs.astral.sh/ruff/formatter/).
 
-- Install: `pip install black`.
-- Use: `black .`
+- Install: `pip install ruff`.
+- Sort imports: `ruff check --select I --fix`
+- Format code: `ruff format`
 
 ## Testing
 

pyproject.toml

@@ -23,3 +23,12 @@ Repository = "https://github.com/RLBot/python-interface"
 
 [tool.setuptools.dynamic]
 version = {attr = "rlbot.version.__version__"}
+
+[dependency-groups]
+dev = [
+    "ruff>=0.12.5",
+    "toml>=0.10.2",
+]
+
+[tool.ruff.format]
+docstring-code-format = true

rlbot/__init__.py

@@ -1 +1 @@
-from .version import __version__
+from .version import __version__ as __version__

rlbot/config.py

@@ -3,7 +3,6 @@
 from typing import Any, Literal
 
 import rlbot.flat as flat
-from rlbot.utils.logging import DEFAULT_LOGGER as logger
 from rlbot.utils.os_detector import CURRENT_OS, OS
 
 
@@ -112,7 +111,7 @@ def load_match_config(config_path: Path | str) -> flat.MatchConfiguration:
                     )
                 )
             case "human":
-                players.append(flat.PlayerConfiguration(flat.Human(), team, 0))
+                players.append(get_human(team))
             case t:
                 raise ConfigParsingException(
                     f"Invalid player type {repr(t)} for player {len(players)}."
@@ -323,6 +322,13 @@ def load_psyonix_config(
     )
 
 
+def get_human(team: int) -> flat.PlayerConfiguration:
+    """
+    Creates a `PlayerConfiguration` for a human player on the given team.
+    """
+    return flat.PlayerConfiguration(flat.Human(), team)
+
+
 def load_script_config(path: Path | str) -> flat.ScriptConfiguration:
     """
     Reads the script toml file at the provided path and creates a `ScriptConfiguration` from it.

rlbot/interface.py

@@ -323,7 +323,7 @@ def disconnect(self):
             self.logger.critical("RLBot is not responding to our disconnect request!?")
             self._running = False
 
-        assert (
-            not self._running
-        ), "Disconnect request or timeout should have set self._running to False"
+        assert not self._running, (
+            "Disconnect request or timeout should have set self._running to False"
+        )
         self.is_connected = False

rlbot/managers/match.py

@@ -94,6 +94,42 @@ def connect(
             rlbot_server_port=rlbot_server_port or self.rlbot_server_port,
         )
 
+    def run(self, *, background_thread: bool = False):
+        """
+        Handle incoming messages until disconnected.
+
+        - background_thread: If `True`, a background thread will be started to process messages.
+        """
+        self.rlbot_interface.run(background_thread=background_thread)
+
+    def connect_and_run(
+        self,
+        *,
+        wants_match_communications: bool,
+        wants_ball_predictions: bool,
+        close_between_matches: bool = True,
+        rlbot_server_ip: str = RLBOT_SERVER_IP,
+        rlbot_server_port: Optional[int] = None,
+        background_thread: bool = False,
+    ):
+        """
+        Connects to the RLBot server specifying the given settings.
+
+        - wants_match_communications: Whether match communication messages should be sent to this process.
+        - wants_ball_predictions: Whether ball prediction messages should be sent to this process.
+        - close_between_matches: Whether RLBot should close this connection between matches, specifically upon
+            `StartMatch` and `StopMatch` messages, since RLBot does not actually detect the ending of matches.
+        - background_thread: If `True`, a background thread will be started to process messages.
+        """
+        self.connect(
+            wants_match_communications=wants_match_communications,
+            wants_ball_predictions=wants_ball_predictions,
+            close_between_matches=close_between_matches,
+            rlbot_server_ip=rlbot_server_ip,
+            rlbot_server_port=rlbot_server_port,
+        )
+        self.run(background_thread=background_thread)
+
     def wait_for_first_packet(self):
         while self.packet is None or self.packet.match_info.match_phase in {
             flat.MatchPhase.Inactive,
@@ -117,12 +153,12 @@ def start_match(
             self.ensure_server_started()
 
         if not self.rlbot_interface.is_connected:
-            self.connect(
+            self.connect_and_run(
                 wants_match_communications=False,
                 wants_ball_predictions=False,
                 close_between_matches=False,
+                background_thread=True,
             )
-            self.rlbot_interface.run(background_thread=True)
 
         self.rlbot_interface.start_match(config)
 
@@ -136,7 +172,7 @@ def start_match(
 
     def disconnect(self):
         """
-        Disconnect from the RLBotServer.
+        Disconnect from RLBotServer.
         Note that the server will continue running as long as Rocket League does.
         """
         self.rlbot_interface.disconnect()
@@ -167,8 +203,8 @@ def shut_down(self, use_force_if_necessary: bool = True):
 
         self.logger.info("Shutting down RLBot...")
 
-        # In theory this is all we need for the server to cleanly shut itself down
         try:
+            # In theory this is all we need for the server to cleanly shut itself down
             self.rlbot_interface.stop_match(shutdown_server=True)
         except BrokenPipeError:
             match gateway.find_server_process(self.main_executable_name)[0]:

rlbot/utils/maps.py

@@ -83,7 +83,7 @@
     "FuturaGarden": "UF_Day_P",
     "DFHStadium_Anniversary": "stadium_10a_p",
     "Holyfield": "Labs_Holyfield_Space_P",
-    "DriftWoods_Night": "woods_night_p"
+    "DriftWoods_Night": "woods_night_p",
 }
 
 STANDARD_MAPS = [
@@ -138,5 +138,6 @@
     "Neotokyo_Arcade",
     "FuturaGarden",
     "DFHStadium_Anniversary",
-    "DriftWoods_Night"
+    "DriftWoods_Night",
+    "NeoTokyo_Comic",
 ]

rlbot/version.py

@@ -1 +1 @@
-__version__ = "2.0.0-beta.47"
+__version__ = "2.0.0-beta.48"

tests/atba/atba.bot.toml

@@ -14,7 +14,7 @@ root_dir = ""
 run_command = "..\\..\\venv\\Scripts\\python atba.py"
 # The command RLBot will call to start your bot on linux
 # If this isn't set, RLBot may attempt to run the Windows command under Wine
-run_command_linux = "../../venv/bin/python atba.py"
+run_command_linux = "../../.venv/bin/python atba.py"
 
 [details]
 description = "Made possible by RLBot"