Skip to content

Commit

Permalink
Update the overlays documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
klaasnicolaas committed Jun 15, 2024
1 parent 0880b0d commit 87f058d
Showing 1 changed file with 30 additions and 11 deletions.
41 changes: 30 additions & 11 deletions stream_overlays/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@

Here you will find an overview of all available overlays. The plugin will automatically create panels for each overlay on the stream page in RotorHazard, so you can easily find the urls to use.

Links to the overlays:

- [Dutch Drone Squad](#overlay---dutch-drone-squad)
- [Liga Colombiana Drone Racing](#overlay---liga-colombiana-drone-racing)

## Overlay - Dutch Drone Squad

This overlay is designed by the [Dutch Drone Squad](https://dutchdronesquad.nl) and consists of a top bar, node overlay and leaderboards for class and overall.
Expand All @@ -10,33 +15,45 @@ This overlay is designed by the [Dutch Drone Squad](https://dutchdronesquad.nl)

The title in the top bar consists of a heat name and event name which dynamically adapts to what is set in RotorHazard.

![alt Screenshot of topbar](https://raw.githubusercontent.com/dutchdronesquad/rh-stream-overlays/main/assets/overlays/topbar-dds.png)

URL to use: `RH-IP:5000/stream/overlay/dds/topbar`

![alt Screenshot of topbar](https://raw.githubusercontent.com/dutchdronesquad/rh-stream-overlays/main/assets/overlays/topbar-dds.png)

### Node

[![Watch the video](https://raw.githubusercontent.com/dutchdronesquad/rh-stream-overlays/main/assets/overlays/node-dds.png)](https://www.youtube.com/watch?v=ZpV0veJErvE)
_Click on the image to watch a video of the overlay in action_
The node overlay shows the pilot name, lap time, total time and lap number. The color of the node changes based on what is set in RotorHazard for each pilot. Replace `[NUMBER]` with the node id you want to show.

URL to use: `RH-IP:5000/stream/overlay/dds/node/[NUMBER]`

[![Watch the video](https://raw.githubusercontent.com/dutchdronesquad/rh-stream-overlays/main/assets/overlays/node-dds.png)](https://www.youtube.com/watch?v=ZpV0veJErvE)
_Click on the image to watch a video of the overlay in action_

### Leaderboard - Class Ranking

The table adapts to the type of race format: **standard**, **fastest lap** or (top 3) **consecutive**.
The leaderboard class overlay shows the ranking of the pilots in a specific class. The pilots are shown in sets of 8 and the next set or pilots are shown every 10 seconds.

[![Watch the video](https://raw.githubusercontent.com/dutchdronesquad/rh-stream-overlays/main/assets/overlays/ranking_class-dds.png)](https://youtu.be/xqIuBfLjtJE)
_Click on the image to watch a video of the overlay in action_
The table adapts to the type of race format: **standard**, **fastest lap** or (top 3) **consecutive**. Replace `[CLASS ID]` with the class id you want to show or use `0` for the current class.

> [!IMPORTANT]
> Currently you only see data if you use **Ranking: From Race Format**
URL to use: `RH-IP:5000/stream/overlay/dds/leaderboard/[CLASS ID]/class`

[![Watch the video](https://raw.githubusercontent.com/dutchdronesquad/rh-stream-overlays/main/assets/overlays/ranking_class-dds.png)](https://youtu.be/xqIuBfLjtJE)
_Click on the image to watch a video of the overlay in action_

### Leaderboard - Overall Ranking

[![Watch the video](https://raw.githubusercontent.com/dutchdronesquad/rh-stream-overlays/main/assets/overlays/ranking_overall-dds.png)](https://youtu.be/kTtoHACqsg0)
_Click on the image to watch a video of the overlay in action_
The leaderboard overall overlay shows the overall ranking of the pilots, with a maximum of 32 pilots. Replace `[CLASS ID]` with the class id you want to show or use `0` for the current class.

> [!IMPORTANT]
> Currently you only see data if you use **Ranking: From Race Format**
URL to use: `RH-IP:5000/stream/overlay/dds/leaderboard/[CLASS ID]/overall`

[![Watch the video](https://raw.githubusercontent.com/dutchdronesquad/rh-stream-overlays/main/assets/overlays/ranking_overall-dds.png)](https://youtu.be/kTtoHACqsg0)
_Click on the image to watch a video of the overlay in action_

## Overlay - Liga Colombiana Drone Racing

This overlay is designed by the [Liga Colombiana Drone Racing](https://ligacolombianadroneracing.com) and consists of a top bar and a node overlay.
Expand All @@ -51,7 +68,9 @@ URL to use: `RH-IP:5000/stream/overlay/lcdr/topbar`

### Node

[![Watch the video](https://raw.githubusercontent.com/dutchdronesquad/rh-stream-overlays/main/assets/overlays/node-lcdr.png)](https://www.youtube.com/watch?v=i46IejMjN_Q)
_Click on the image to watch a video of the overlay in action_
The node overlay shows the pilot name, lap time, total time and lap number. The color of the node changes based on what is set in RotorHazard for each pilot. Replace `[NUMBER]` with the node id you want to show.

URL to use: `RH-IP:5000/stream/overlay/lcdr/node/[NUMBER]`

[![Watch the video](https://raw.githubusercontent.com/dutchdronesquad/rh-stream-overlays/main/assets/overlays/node-lcdr.png)](https://www.youtube.com/watch?v=i46IejMjN_Q)
_Click on the image to watch a video of the overlay in action_

0 comments on commit 87f058d

Please sign in to comment.