Read RLBOT_SERVER_IP environment variable and default to "127.0.0.1"

Author: VirxEC

rlbot/interface.py

@@ -11,7 +11,9 @@
 from rlbot.utils.logging import get_logger
 
 MAX_SIZE_2_BYTES = 2**16 - 1
-# The default port we can expect RLBotServer to be listening on.
+# The default IP to connect to RLBotServer on
+RLBOT_SERVER_IP = "127.0.0.1"
+# The default port we can expect RLBotServer to be listening on
 RLBOT_SERVER_PORT = 23234
 
 
@@ -173,6 +175,7 @@ def connect(
         wants_match_communications: bool,
         wants_ball_predictions: bool,
         close_between_matches: bool = True,
+        rlbot_server_ip: str = RLBOT_SERVER_IP,
         rlbot_server_port: int = RLBOT_SERVER_PORT,
     ):
         """
@@ -191,7 +194,7 @@ def connect(
             next_warning = 10
             while time.time() < begin_time + self.connection_timeout:
                 try:
-                    self.socket.connect(("127.0.0.1", rlbot_server_port))
+                    self.socket.connect((rlbot_server_ip, rlbot_server_port))
                     self.is_connected = True
                     break
                 except ConnectionRefusedError:

rlbot/managers/bot.py

@@ -3,7 +3,7 @@
 from typing import Optional
 
 from rlbot import flat
-from rlbot.interface import SocketRelay, RLBOT_SERVER_PORT
+from rlbot.interface import RLBOT_SERVER_IP, RLBOT_SERVER_PORT, SocketRelay
 from rlbot.managers.rendering import Renderer
 from rlbot.utils import fill_desired_game_state
 from rlbot.utils.logging import DEFAULT_LOGGER, get_logger
@@ -161,12 +161,14 @@ def run(
         Runs the bot. This operation is blocking until the match ends.
         """
 
+        rlbot_server_ip = os.environ.get("RLBOT_SERVER_IP", RLBOT_SERVER_IP)
         rlbot_server_port = int(os.environ.get("RLBOT_SERVER_PORT", RLBOT_SERVER_PORT))
 
         try:
             self._game_interface.connect(
                 wants_match_communications=wants_match_communications,
                 wants_ball_predictions=wants_ball_predictions,
+                rlbot_server_ip=rlbot_server_ip,
                 rlbot_server_port=rlbot_server_port,
             )
 

rlbot/managers/hivemind.py

@@ -4,7 +4,7 @@
 from typing import Optional
 
 from rlbot import flat
-from rlbot.interface import SocketRelay, RLBOT_SERVER_PORT
+from rlbot.interface import RLBOT_SERVER_IP, SocketRelay, RLBOT_SERVER_PORT
 from rlbot.managers import Renderer
 from rlbot.utils import fill_desired_game_state
 from rlbot.utils.logging import DEFAULT_LOGGER, get_logger
@@ -173,12 +173,14 @@ def run(
         Runs the bot. This operation is blocking until the match ends.
         """
 
+        rlbot_server_ip = os.environ.get("RLBOT_SERVER_IP", RLBOT_SERVER_IP)
         rlbot_server_port = int(os.environ.get("RLBOT_SERVER_PORT", RLBOT_SERVER_PORT))
 
         try:
             self._game_interface.connect(
                 wants_match_communications=wants_match_communications,
                 wants_ball_predictions=wants_ball_predictions,
+                rlbot_server_ip=rlbot_server_ip,
                 rlbot_server_port=rlbot_server_port,
             )
 

rlbot/managers/match.py

@@ -6,8 +6,8 @@
 import psutil
 
 from rlbot import flat, version
-from rlbot.interface import RLBOT_SERVER_PORT, SocketRelay
-from rlbot.utils import gateway, fill_desired_game_state
+from rlbot.interface import RLBOT_SERVER_IP, RLBOT_SERVER_PORT, SocketRelay
+from rlbot.utils import fill_desired_game_state, gateway
 from rlbot.utils.logging import DEFAULT_LOGGER
 from rlbot.utils.os_detector import CURRENT_OS, MAIN_EXECUTABLE_NAME, OS
 
@@ -199,6 +199,7 @@ def connect(
         wants_match_communications: bool,
         wants_ball_predictions: bool,
         close_between_matches: bool = True,
+        rlbot_server_ip: str = RLBOT_SERVER_IP,
         rlbot_server_port: int = RLBOT_SERVER_PORT,
     ):
         """
@@ -213,6 +214,7 @@ def 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,
         )
 

rlbot/managers/script.py

@@ -3,7 +3,7 @@
 from typing import Optional
 
 from rlbot import flat
-from rlbot.interface import SocketRelay, RLBOT_SERVER_PORT
+from rlbot.interface import RLBOT_SERVER_IP, RLBOT_SERVER_PORT, SocketRelay
 from rlbot.managers import Renderer
 from rlbot.utils import fill_desired_game_state
 from rlbot.utils.logging import DEFAULT_LOGGER, get_logger
@@ -130,12 +130,14 @@ def run(
         Runs the script. This operation is blocking until the match ends.
         """
 
+        rlbot_server_ip = os.environ.get("RLBOT_SERVER_IP", RLBOT_SERVER_IP)
         rlbot_server_port = int(os.environ.get("RLBOT_SERVER_PORT", RLBOT_SERVER_PORT))
 
         try:
             self._game_interface.connect(
                 wants_match_communications=wants_match_communications,
                 wants_ball_predictions=wants_ball_predictions,
+                rlbot_server_ip=rlbot_server_ip,
                 rlbot_server_port=rlbot_server_port,
             )
 

rlbot/version.py

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