Update to new RocketSim

Drop support for reading RLGym types directly

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "rlviser-py"
-version = "0.5.0"
+version = "0.6.0"
 edition = "2021"
 description = "Python implementation that manages a UDP connection to RLViser"
 license = "MIT"

README.md

@@ -1,7 +1,47 @@
 ## rlviser-py
 
-Python implementation that manages a UDP connection to RLViser, it launches the [RLViser binary](https://github.com/VirxEC/rlviser) from the current working directory upon first calling any render function. 
-
-Currently able to visualize RLGym GameState objects, but requires the boost pad locations to be sent first.
+Python implementation that manages a UDP connection to RLViser, it launches the [RLViser binary](https://github.com/VirxEC/rlviser) from the current working directory upon first calling any render function.
 
 The backbone of RLGym's `env.render()` functionality.
+
+### Example usage
+
+```python
+import time
+
+import rlviser_py as vis
+import RocketSim as rs
+
+# Create example arena
+arena = rs.Arena(rs.GameMode.SOCCAR)
+
+# Set boost pad locations
+vis.set_boost_pad_locations([pad.get_pos().as_tuple() for pad in arena.get_boost_pads()])
+
+# Setup example arena
+car = arena.add_car(rs.Team.BLUE)
+car.set_state(rs.CarState(pos=rs.Vec(z=17), vel=rs.Vec(x=50), boost=100))
+arena.ball.set_state(rs.BallState(pos=rs.Vec(y=400, z=100), ang_vel=rs.Vec(x=5)))
+car.set_controls(rs.CarControls(throttle=1, steer=1, boost=True))
+
+# Run for 3 seconds
+TIME = 3
+
+steps = 0
+starttime = time.time()
+for i in range(round(TIME * arena.tick_rate)):
+ arena.step(1)
+
+ # Render the current game state
+ pad_states = [pad.get_state().is_active for pad in arena.get_boost_pads()]
+ car_data = [(car.id, car.team, car.get_config(), car.get_state()) for car in arena.get_cars()]
+ vis.render(steps, arena.tick_rate, pad_states, arena.ball.get_state(), car_data)
+
+ # sleep to simulate running real time (it will run a LOT after otherwise)
+ time.sleep(max(0, starttime + steps / arena.tick_rate - time.time()))
+ steps += 1
+
+# Tell RLViser to exit
+print("Exiting...")
+vis.quit()
+```

pytest.py

@@ -16,10 +16,11 @@
 car.set_controls(rs.CarControls(throttle=1, steer=1, boost=True))
 
 # Run for 3 seconds
+TIME = 3
 
 steps = 0
 starttime = time.time()
-for i in range(round(3 * arena.tick_rate)):
+for i in range(round(TIME * arena.tick_rate)):
  arena.step(1)
 
  # Render the current game state

rlviser_py.pyi

@@ -3,20 +3,9 @@ from typing import List, Tuple
 def set_boost_pad_locations(locations: List[Tuple[float, float, float]]) -> ...:
  pass
 
-try:
- from RocketSim import BallState, CarConfig, CarState, Team
+from RocketSim import BallState, CarConfig, CarState, Team
 
- def render(tick_count: int, tick_rate: float, boost_pad_states: List[bool], ball: BallState, cars: List[Tuple[int, Team, CarConfig, CarState]]) -> ...:
- pass
-except ImportError:
- pass
-
-try:
- from rlgym.rocket_league.engine.game_state import GameState
-
- def render_rlgym(tick_count: int, tick_rate: float, gym_state: GameState) -> ...:
- pass
-except ImportError:
+def render(tick_count: int, tick_rate: float, boost_pad_states: List[bool], ball: BallState, cars: List[Tuple[int, Team, CarConfig, CarState]]) -> ...:
  pass
 
 def quit() -> ...: