RLBot

Common errors

• 'pip' is not recognized as an internal or external command, operable program or batch file.

  cause Python or pip is not correctly added to the system's PATH environment variable, or a virtual environment containing pip is not activated.
  fix During Python installation, ensure 'Add Python to PATH' is selected. If using a virtual environment, activate it with `.\venv\Scripts\activate` (Windows) or `source venv/bin/activate` (Linux/macOS) before running pip commands. You might also need to delete and recreate the virtual environment if an initial setup failed.

• FileNotFoundError: [WinError 2] The system cannot find the file specified

  cause This error, along with 'Access is denied' or other WinError messages, often indicates that antivirus software is interfering with RLBot's files or processes.
  fix Add the RLBot installation directory and your bot project directories to your antivirus software's exclusion list. Also, check if any RLBot-related `.dll` or `.exe` files have been quarantined or deleted by the antivirus. Restart your computer if issues persist.

• Could not find a version that satisfies the requirement PyQt5 (from versions: none)

  cause This error often occurs when the system attempts to use Python 2 instead of Python 3, or when the Python environment is corrupted, and PyQt5 (or other Python 3-specific packages) cannot be found.
  fix Verify your active Python version with `python --version` or `py -3 --version`. Ensure Python 3 is correctly installed and its path is prioritized in your system's environment variables. If using a virtual environment, ensure it's created with Python 3.

Warnings

• breaking Migration from RLBot v4 to v5 involves breaking changes, primarily moving from `.cfg` configuration files to `.toml` format for bot settings and transitioning bot-to-framework communication from DLLs to WebSockets. Old v4 bots may not be compatible with v5 without modifications.
  Fix: Consult the official 'RLBot/python-interface/wiki/Migration' guide. Update bot configuration files to `.toml` format and adapt communication logic if custom low-level interactions were used. For most Python bots, updating the example project ensures compatibility.
• gotcha On Windows 10/11, sometimes `AppData\Local\Microsoft\WindowsApps` is in the system PATH, causing `python.exe` to open the Microsoft Store instead of running your Python installation, leading to unexpected behavior or 'nothing printed' errors.
  Fix: Check your PATH environment variable using `where.exe python` in the command prompt. If the Microsoft Store python.exe is listed first, modify your PATH to prioritize your actual Python installation's directory or remove the problematic entry.
• gotcha RLBot v5 and newer versions require Python 3.12 or later. Using older Python versions will lead to compatibility issues and errors during setup or runtime.
  Fix: Ensure you have Python 3.12 or a later compatible version installed. Activate a virtual environment created with the correct Python version before installing RLBot dependencies.

Install

• pip install rlbot Install core RLBot package

Imports

• BaseAgent

  from rlbot.agents.base_agent import BaseAgent

• SimpleControllerState

  from rlbot.agents.base_agent import SimpleControllerState

• GameTickPacket

  from rlbot.utils.structures.game_data_struct import GameTickPacket

• RLBotServer.exe

  RLBotServer.exe (part of the framework, not a Python import)

  RLBotServer.exe is a core component of the RLBot framework that handles communication with the game and is launched separately, not imported into Python code.

Quickstart

This quickstart demonstrates a basic RLBot agent that drives towards the ball. To run an RLBot, developers typically start by cloning the official `RLBot/python-example` repository, creating a Python virtual environment, installing dependencies from `requirements.txt`, and then modifying the `bot.py` file to implement their desired bot logic. The bot's `get_output` method is called every game tick to produce controller inputs.

import os
from rlbot.agents.base_agent import BaseAgent, SimpleControllerState
from rlbot.utils.structures.game_data_struct import GameTickPacket


class MyBot(BaseAgent):

    def initialize_agent(self):
        # This runs once before the bot starts.
        self.logger.log("MyBot initialized!")

    def get_output(self, packet: GameTickPacket) -> SimpleControllerState:
        # This is called every tick of the game.
        # Implement your bot's logic here.

        controller_state = SimpleControllerState()

        # Example: Drive towards the ball
        ball_location = packet.game_ball.physics.location
        my_car = packet.game_cars[self.index]
        car_location = my_car.physics.location

        # Simple steer towards the ball
        if ball_location.y > car_location.y:
            controller_state.throttle = 1.0
        else:
            controller_state.throttle = -1.0

        # Steering logic (very basic)
        if ball_location.x < car_location.x:
            controller_state.steer = -1.0
        elif ball_location.x > car_location.x:
            controller_state.steer = 1.0
        else:
            controller_state.steer = 0.0

        return controller_state


# To run this bot:
# 1. Ensure you have Rocket League installed and RLBot setup (pip install rlbot).
# 2. Typically, you'd clone an example project (e.g., RLBot/python-example),
#    place this code in its 'bot.py', and run 'python run.py' from that project's root.
#    The RLBot framework will launch Rocket League and your bot automatically.