Skip to content

Commit 9462185

Browse files
authored
Update README with visualization instructions
Added instructions for installing and using the Python viewer for visualizing recorded actions.
1 parent 8a75958 commit 9462185

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,22 @@ Add the `Input Recording` source:
1212

1313
That's it! Now every time you record, a `.parquet` file will be created with the same name as your recording, containing the state of your gamepad recorded at 500Hz. This will also work if you disconnect your gamepad midway, connect a new one etc.
1414

15+
## Visualize recorded actions
16+
17+
Install the Python viewer with
18+
```bash
19+
pip install -e python_viewer
20+
```
21+
22+
Then use it with
23+
```bash
24+
irv <path/to/video_file.mp4> # this command will automatically look for the associated .parquet file
25+
irv <path/to/video_file.mp4> --path-parquet <path/to/annotations.parquet> # or explicitely provide the path to the parquet annotations
26+
```
27+
28+
You should see a [rerun](https://github.com/rerun-io/rerun) window like this one:
29+
![image](https://github.com/user-attachments/assets/b8a9a280-b1fb-4076-a427-1c8dc0dc0bad)
30+
1531
## TODOs:
1632
- [ ] Support mouse/keyboard recordings
1733
- [ ] Add a GUI to select output format and input device to be recorded

0 commit comments

Comments
 (0)