Initial commit & port to v5

Author: VirxEC

.env

@@ -0,0 +1 @@
+PYTHONPATH=src

.gitignore

@@ -0,0 +1,112 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# virtualenv
+.venv
+venv/
+ENV/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+
+# Intellij
+*.iml
+/.idea
+
+# Build output
+/build
+
+# Gradle files
+/.gradle
+
+# VSCode
+.vscode/
+*.code-workspace

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,21 @@
+# RLBotPythonExample
+
+Example of a Python bot using the RLBot framework
+
+## Quick Start
+
+- Install Python 3.10 or later
+- Create a Python virtual environment
+  - `python -m venv venv`
+- Install the required packages
+  - `pip install -r requirements.txt`
+- Download `RLBotServer.exe` and place it in the root directory
+  - <https://github.com/RLBot/core>
+- Modify `rlbot.toml` to your liking
+  - Note: `dev.toml` also exists with a few changed settings that might be useful for development
+- Start a match with `python run.py`
+
+## Changing the bot
+
+- Bot behavior is controlled by `src/bot.py`
+- Bot appearance is controlled by `src/looks.toml`

dev.toml

@@ -0,0 +1,19 @@
+[rlbot]
+launcher = "steam"
+# We'll run the bot ourself so we don't have restart the match
+# `python src/bot.py` in our case
+auto_start_bots = false
+
+[match]
+# There can only be one rlbot-controlled car in a match
+# unless you feed the bot it's spawn id
+# by setting the `BOT_SPAWN_ID` environment variable
+num_cars = 1
+enable_rendering = true
+
+[mutators]
+match_length = "Unlimited"
+
+[[cars]]
+config = "src/bot.toml"
+team = 0

requirements.txt

@@ -0,0 +1,2 @@
+# rlbot==5.*
+rlbot @ git+https://github.com/VirxEC/python-interface@master

rlbot.toml

@@ -0,0 +1,72 @@
+[rlbot]
+# rocket_league_exe_path = "epicgames/path/to/rocketleague.exe"
+# "Steam", "Epic"
+launcher = "steam"
+# Should RLBot start the bot processes automatically, or will a separate script start them
+auto_start_bots = true
+
+[match]
+# Number of bots/players which will be spawned.
+num_cars = 2
+# Number of scripts which will be spawned.
+num_scripts = 0
+# What game mode the game should load.
+# Accepted values are "Soccer", "Hoops", "Dropshot", "Hockey", "Rumble", "Heatseeker", "Gridiron"
+game_mode = "Soccer"
+# Which map the game should load into
+game_map_upk = "Stadium_P"
+# Automatically skip replays after a goal. Also stops match replays from being saved.
+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"
+existing_match_behavior = "Restart"
+enable_rendering = true
+enable_state_setting = true
+auto_save_replay = false
+# Whether or not to use freeplay instead of an exhibition match
+freeplay = false
+
+[mutators]
+# "Five_Minutes", "Ten_Minutes", "Twenty_Minutes", "Unlimited"
+match_length = "Five_Minutes"
+# "Default", "One_Goal", "Three_Goals", "Five_Goals", "Seven Goals", "Unlimited"
+max_score = "Default"
+# "One", "Two", "Four", "Six"
+multi_ball = "One"
+# "Unlimited", "Five_Max_First_Score", "Five_Max_Random_Team"
+overtime = "Unlimited"
+# "Default", "Slo_Mo", "Time_Warp"
+game_speed = "Default"
+# "Default", "Slow", "Fast", "Super_Fast"
+ball_max_speed = "Default"
+# "Default", "Cube", "Puck", "Basketball", "Beachball", "Anniversary", "Haunted"
+ball_type = "Default"
+# "Default", "Light", "Heavy", "Super_Light", "Curve_Ball", "Beach_Ball_Curve"
+ball_weight = "Default"
+# "Default", "Small", "Large", "Gigantic"
+ball_size = "Default"
+# "Default", "Low", "High", "Super_High"
+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"
+rumble = "No_Rumble"
+# "One", "OneAndAHalf", "Two", "Ten"
+boost_strength = "One"
+# "Default", "Low", "High", "Super_High", "Reverse"
+gravity = "Default"
+# "Default", "Disabled", "Friendly_Fire", "On_Contact", "On_Contact_FF"
+demolish = "Default"
+# "Three_Seconds", "Two_Seconds", "One_Seconds", "Disable_Goal_Reset"
+respawn_time = "Three_Seconds"
+
+[[cars]]
+type = "human"
+team = 0
+
+[[cars]]
+config = "src/bot.toml"
+team = 0
+

run.py

@@ -0,0 +1,12 @@
+from pathlib import Path
+
+from rlbot.managers import MatchManager
+
+MATCH_CONFIG_FILE = "rlbot.toml"
+
+if __name__ == "__main__":
+    root_dir = Path(__file__).parent
+
+    match_manager = MatchManager(root_dir)
+    match_manager.start_match(root_dir / MATCH_CONFIG_FILE, False)
+    match_manager.disconnect()

src/__init__.py

@@ -0,0 +1,118 @@
+from rlbot.flat import ControllerState, GameTickPacket
+from rlbot.managers import Bot
+from rlbot_flatbuffers import BallAnchor
+
+from util.ball_prediction_analysis import find_slice_at_time
+from util.boost_pad_tracker import BoostPadTracker
+from util.drive import steer_toward_target
+from util.sequence import ControlStep, Sequence
+from util.vec import Vec3
+
+
+class MyBot(Bot):
+    active_sequence: Sequence | None = None
+    boost_pad_tracker = BoostPadTracker()
+
+    def initialize_agent(self):
+        # Set up information about the boost pads now that the game is active and the info is available
+        self.boost_pad_tracker.initialize_boosts(self.field_info)
+
+    def get_output(self, packet: GameTickPacket) -> ControllerState:
+        """
+        This function will be called by the framework many times per second. This is where you can
+        see the motion of the ball, etc. and return controls to drive your car.
+        """
+
+        # Keep our boost pad info updated with which pads are currently active
+        self.boost_pad_tracker.update_boost_status(packet)
+
+        if len(packet.balls) == 0:
+            # If there are no balls current in the game (likely due to being in a replay), skip this tick.
+            return ControllerState()
+        # we can now assume there's at least one ball in the match
+
+        # This is good to keep at the beginning of get_output. It will allow you to continue
+        # any sequences that you may have started during a previous call to get_output.
+        if self.active_sequence is not None and not self.active_sequence.done:
+            controls = self.active_sequence.tick(packet)
+            if controls is not None:
+                return controls
+
+        # Gather some information about our car and the ball
+        my_car = packet.players[self.index]
+        car_location = Vec3(my_car.physics.location)
+        car_velocity = Vec3(my_car.physics.velocity)
+        ball_location = Vec3(packet.balls[0].physics.location)
+
+        # By default we will chase the ball, but target_location can be changed later
+        target_location = ball_location
+
+        if car_location.dist(ball_location) > 1500:
+            # We're far away from the ball, let's try to lead it a little bit
+            # self.ball_prediction can predict bounces, etc
+            ball_in_future = find_slice_at_time(
+                self.ball_prediction, packet.game_info.seconds_elapsed + 2
+            )
+
+            # ball_in_future might be None if we don't have an adequate ball prediction right now, like during
+            # replays, so check it to avoid errors.
+            if ball_in_future is not None:
+                target_location = Vec3(ball_in_future.physics.location)
+
+                # BallAnchor(0) will dynamically start the point at the ball's current location
+                # 0 makes it reference the ball at index 0 in the packet.balls list
+                self.renderer.draw_line_3d(
+                    BallAnchor(0), target_location, self.renderer.cyan
+                )
+
+        # Draw some things to help understand what the bot is thinking
+        self.renderer.draw_line_3d(car_location, target_location, self.renderer.white)
+        self.renderer.draw_string_3d(
+            f"Speed: {car_velocity.length():.1f}",
+            car_location,
+            1,
+            self.renderer.white,
+        )
+        self.renderer.draw_line_3d(
+            target_location - Vec3(0, 0, 50),
+            target_location + Vec3(0, 0, 50),
+            self.renderer.cyan,
+        )
+
+        if 750 < car_velocity.length() < 800:
+            # We'll do a front flip if the car is moving at a certain speed.
+            return self.begin_front_flip(packet)  # type: ignore
+
+        controls = ControllerState()
+        controls.steer = steer_toward_target(my_car, target_location)
+        controls.throttle = 1.0
+        # You can set more controls if you want, like controls.boost.
+
+        return controls
+
+    def begin_front_flip(self, packet: GameTickPacket):
+        # Send some quickchat just for fun
+        # There won't be any content of the message for other bots,
+        # but "I got it!" will be display for a human to see!
+        self.send_match_comm(b"", "I got it!")
+
+        # Do a front flip. We will be committed to this for a few seconds and the bot will ignore other
+        # logic during that time because we are setting the active_sequence.
+        self.active_sequence = Sequence(
+            [
+                ControlStep(duration=0.05, controls=ControllerState(jump=True)),
+                ControlStep(duration=0.05, controls=ControllerState(jump=False)),
+                ControlStep(
+                    duration=0.2, controls=ControllerState(jump=True, pitch=-1)
+                ),
+                ControlStep(duration=0.8, controls=ControllerState()),
+            ]
+        )
+
+        # Return the controls associated with the beginning of the sequence so we can start right away.
+        return self.active_sequence.tick(packet)
+
+
+if __name__ == "__main__":
+    # Connect to RLBot and run
+    MyBot().run()