https://github.com/solstice23/osu-bar-overlay

⌨️ Visualize keyboard history for osu! in bar form
https://github.com/solstice23/osu-bar-overlay

osu osugame overlay stream

Last synced: 6 months ago
JSON representation

⌨️ Visualize keyboard history for osu! in bar form

• Host: GitHub
• URL: https://github.com/solstice23/osu-bar-overlay
• Owner: solstice23
• License: mit
• Created: 2022-03-20T21:05:44.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2023-05-15T14:09:34.000Z (over 2 years ago)
• Last Synced: 2025-04-22T14:08:28.143Z (6 months ago)
• Topics: osu, osugame, overlay, stream
• Language: JavaScript
• Homepage:
• Size: 10.1 MB
• Stars: 17
• Watchers: 2
• Forks: 3
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# osu! bar overlay

Visualize keyboard history for osu! in your stream.

## Example



### In Stream

https://user-images.githubusercontent.com/23134847/168428457-2ec663ab-d224-4821-a346-dc67a8f91911.mp4

### Horizontal

| __light__  |  ![](examples/horizontal_light.gif) |

:-------------------------:|:-------------------------:

| __square__  |  ![](examples/horizontal_square.gif) |

### Vertical

| __light__ | __square__ |

:-------------------------:|:-------------------------:

![](examples/vertical_light.gif)  |  ![](examples/vertical_square.gif)



## Features

- Two styles available: square and light

- Customizable: keys, colors, speed, spacing, etc.

- Receives input from websocket (requires the OBS plugin [input-overlay](https://github.com/univrsal/input-overlay) 5.0 or [gosumemory](https://github.com/l3lackShark/gosumemory))

## Usage

1. Choose one of these input sources below, which provide real-time keyboard input data to the overlay

+ Install [input-overlay](https://github.com/univrsal/input-overlay) plugin 5.0, and turn on the websocket checkbox in plugin settings.

+ Install [gosumemory](https://github.com/l3lackShark/gosumemory), and set a smaller update interval in the gosumemory config file to reduce latency.

2. Download the built files from [release](https://github.com/solstice23/osu-bar-overlay/releases), edit `/config.js` to set your preferences.

3. Add a browser source in the OBS, check "Local file" and set the URL to `E:/osu-bar-overlay/index.html` (your path). Maybe you should set the width and height to proper values to fit the overlay.

4. Enjoy it!

## TODO

- [x] Receive input from [gosumemory](https://github.com/l3lackShark/gosumemory)

- [x] Round corners

- [ ] Fix glitches of the keys when the round corners are enabled in the square style

- [x] More key styles