https://github.com/virxec/rocketsim-rs
Rust bindings for the RocketSim project
https://github.com/virxec/rocketsim-rs
autocxx bindings cpp rust
Last synced: about 2 months ago
JSON representation
Rust bindings for the RocketSim project
- Host: GitHub
- URL: https://github.com/virxec/rocketsim-rs
- Owner: VirxEC
- License: mit
- Created: 2023-01-31T01:15:00.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2025-02-20T17:48:25.000Z (4 months ago)
- Last Synced: 2025-04-12T10:52:45.090Z (about 2 months ago)
- Topics: autocxx, bindings, cpp, rust
- Language: Rust
- Homepage: https://crates.io/crates/rocketsim_rs
- Size: 431 KB
- Stars: 11
- Watchers: 1
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/VirxEC/rocketsim-rs/actions/workflows/build-and-test.yaml)
**Rust bindings for the [RocketSim](https://github.com/ZealanL/RocketSim) project**
## Basic usage
```rust
use rocketsim_rs::{
math::Vec3,
sim::{Arena, CarConfig, CarControls, Team},
};
use std::time::Instant;
// Load in the Rocket League assets from the collision_meshes folder in the current directory
rocketsim_rs::init(None, true);
// Create a new arena with gamemode soccar and a tick rate of 120
let mut arena = Arena::default_standard();
println!("Arena tick rate: {}", arena.get_tick_rate());
let car_id = arena.pin_mut().add_car(Team::Blue, CarConfig::octane());
println!("Car id: {car_id}");
{
// custom initial car state
let mut car_state = arena.pin_mut().get_car(car_id);
car_state.pos = Vec3::new(5., 0., 50.);
car_state.vel = Vec3::new(500., 800., 0.);
car_state.boost = 100.;
println!("Created custom car state");
// Make the car boost
arena
.pin_mut()
.set_car_controls(
car_id,
CarControls {
boost: true,
..Default::default()
},
)
.unwrap();
// If car_id can't be found in arena than this will return Err
arena.pin_mut().set_car(car_id, car_state).unwrap();
println!("Set car ({car_id}) state");
}
{
let mut ball_state = arena.pin_mut().get_ball();
ball_state.pos.z = 1050.;
ball_state.vel = Vec3::new(0., 0., 250.);
arena.pin_mut().set_ball(ball_state);
println!("Set ball state");
}
let ticks = 1800;
let curr_time = Instant::now();
arena.pin_mut().step(ticks);
println!("Simulated {}s in {}ms", ticks as f32 / 120., curr_time.elapsed().as_millis());
{
// get the car state again
let car_state = arena.pin_mut().get_car(car_id);
println!("Got new car state");
// You can debug the whole of the state
// but it takes up a lot of space in stdout
// dbg!(&car_state);
println!("New car location: {}", car_state.pos);
println!("New car boost: {}", car_state.boost);
}
// Cast the ball state position to a glam Vec3A
#[cfg(feature = "glam")]
println!("New ball location: {}", arena.pin_mut().get_ball().pos.to_glam());
#[cfg(not(feature = "glam"))]
println!("New ball location: {}", arena.pin_mut().get_ball().pos);
```
## Benchmarks
Numbers are from a system running Ubuntu 23.10 with a Ryzen 9 5900X and 3600MHz CL18 RAM.
Numbers _will_ vary depending on your system. Only default features are enabled.
- `real_bench`:
```bash
Running on 24 threads
Simulated 11.11 hours in 7.003 seconds
FPS: 685459
```
- `cpu_bench`:
```bash
Running on 24 threads
Simulated 55.56 hours in 0.907 seconds
FPS: 26474106
```
- `thread_bench` (1 thread):
```bash
Simulated 2.31 hours in 12.307 seconds
FPS: 81253.64
```