README-crates-io.md

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.

Documentation: We have it.

Stability: As you might notice, we're still on version 0.x. Breaking changes are still possible at this stage. Join the Discord to keep up-to-date!

Compatibility: We target the latest version of RLBot, and the latest stable version of Rust.

Usage

Your code will look a little something like this:

use rlbot::ffi;

fn main() -> Result<(), Box<Error>> {
    rlbot::run_bot(MyBot { /* ... */ })
}

struct MyBot { /* ... */ }

impl rlbot::Bot for MyBot {
    fn tick(&mut self, packet: &ffi::LiveDataPacket) -> ffi::PlayerInput {
        // ...
    }
}

This library comes with plenty of examples to get you started. For a list of examples, check out the docs.

Installing the framework

RLBot is needed to use this RLBot binding, of course. If the framework is not found in any of Windows's DLL search locations, init() will return this error:

Os { code: 2, kind: NotFound, message: "The system cannot find the file specified." }

RLBot is written in Python, so you can get a copy with pip:

pip install rlbot

Then add RLBot's DLL directory to your PATH. On my system it ended up here:

C:\Python36\Lib\site-packages\rlbot\dll