solstice23 / osu-bar-overlay

⌨️ Visualize keyboard history for osu! in bar form

MIT License

16 stars 3 forks source link

osu osugame overlay stream

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 5.0 or gosumemory)

Usage

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

Install input-overlay plugin 5.0, and turn on the websocket checkbox in plugin settings.
Install gosumemory, and set a smaller update interval in the gosumemory config file to reduce latency.

Download the built files from release, edit /config.js to set your preferences.
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.
Enjoy it!

TODO

[x] Receive input from gosumemory
[x] Round corners
[ ] Fix glitches of the keys when the round corners are enabled in the square style
[x] More key styles