Crate rlbot

RLBot is a framework for creating offline Rocket League bots. This crate lets you write bots using a simple, safe interface that should feel comfortable to Rust developers.

Most types in this crate are exported directly from RLBot, so for anything not documented here, you’ll need to use RLBot’s docs as the authoritative reference.

There are two ways to use this crate:

1. run_bot – This is the high-level interface. It plays a single match from start to finish. It expects the app to have been launched by the RLBot framework, and runs its own game loop under framework control.
2. init – This is the low-level interface. You can use this to directly access the innards of RLBot for scripting, integration tests, or any other custom use-case.

Examples

This crate comes with a few examples to get you started.

• examples/bot – Demonstrates use of the run_bot API.
• examples/simple – Demonstrates use of the init API with plain structs.
• examples/simple_flatbuffer – Demonstrates use of the init API with FlatBuffers.
• examples/gravity – Demonstrates use of the RLBot::set_game_state API

Modules

ffi

flat

Structs

Color

A color that can be used to draw in a RenderGroup.

Packeteer

An iterator-like object that yields packets from the game as they occur.

Physicist

An iterator-like object that yields physics ticks from the game as they occur.

RLBot

The low-level interface to RLBot. All RLBot calls that are available can be made through this struct.

RenderGroup

A render group in the process of being built.

Traits

Bot

A bot that can run within the RLBot framework. Instances of Bot are used by the run_bot function.

Functions

init

Initializes RLBot and returns a ready-to-use RLBot object.

run_bot

Runs a bot under control of the RLBot framework.