Expand description
This is a Rust interface for the RLBot v5 socket api. 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.
All of the types in the flat module are generated from the
flatbuffers spec. Documentation for these types are carried over from the
spec. For further documentation about how RLBot works, see the resources
linked on the RLBot Wiki.
The two main different ways of using this crate follows:
- The
agentsAPI - This is a higher-level interface. The run_x_agent functions initializes an agent for you. Relevant examples: atba_agent, atba_hivemind, high_jump_script. RLBotConnection– This is a lower-level wrapper around the actual tcp connection to core (RLBotServer). It allows you to usesend_packetandrecv_packetto manually communicate with RLBot. For documentation on how to do this, refer to the socket specification. Relevant examples: start_match, stop_match, packet_logger and atba_raw
Re-exports§
pub use rlbot_flat::glam;
Modules§
- agents
- Agent frameworks: batteries-included event loops for the three RLBot interface kinds.
- flat
- This module contains all of the types that are generated from the RLBot flatbuffers schema
- render
- state_
builder - This module contains extension methods for easy construction of statesetting-related structs.
- util
Structs§
- RLBot
Connection - A wrapper around a TCP connection to core.
- Starting
Info - The three packets every interface waits for after connecting.
Enums§
- Packet
Build Error - Something went wrong while serializing an outgoing packet.
- Packet
Parse Error - Something went wrong while unpacking a packet received from core.
- RLBot
Error - Something went wrong while talking to core over the socket.