pyviser 0.10.5

RLViser - Rocket League replay visualizer

PyViser

A pip-installable version of VirxEC/rlviser with minor modifications to facilitate the build process.

Purpose

The goal of this repository is to provide pre-built pip-installable wheels to PyPI for easy installation of RLViser. For the original code or most up-to-date developments, please see VirxEC's repository.

Installation

pip install pyviser

Platform Support

Currently only macOS (Apple Silicon/ARM64) is supported via pip install.

Windows and Linux support is in development. If you're interested in helping get these platforms working, contributions are very welcome! Please see the GitHub repository for more information.

For other platforms, you can build from source by cloning the repository and using maturin build --release.

About RLViser

RLViser is a lightweight visualizer for rocketsim-rs binds that listens for UDP packets.

Any language can communicate with the visualizer by sending UDP packets in the correct format, but rocketsim-rs has a GameState.to_bytes() function that does this automatically.

Usage

To see an example of how to communicate with the visualizer, see the example in the rocketsim-rs repository.

You can also choose to use the integrated support in RLGym 2.0 and RLGym-PPO or use the RLViser-Py library to interface directly from Python via RocketSim classes.

Controls

NOTICE: These controls WON'T WORK until you've toggled the menu off. The menu is open by default upon launch.

Key	Action
Esc	Toggle menu
1 - 8	Change car camera focus
9	Director camera
0	Free camera
W	Move forward
A	Move left
S	Move backward
D	Move right
Space	Move up
Left Ctrl	Move down
Left Shift	Slow
R	State set ball towards goal
P	Toggle pause/play
+	Increase game speed +0.5x
-	Decrease game speed -0.5x
=	Set game speed to 1x
Left click1	Drag cars and ball

¹ - Requires the menu toggled ON to free the cursor, you can drag cars and the ball to move them in the world. Requires the agent on the other side to support state setting.

Modes

Currently, both standard soccer and hoops are supported.

Credits

All credit for the original RLViser goes to VirxEC. This repository simply provides pip-installable builds of their excellent work.