Skip to content

osu! information extractor, ranging from selected map info to live play data

License

Notifications You must be signed in to change notification settings

oRomxn/StreamCompanion

 
 

Repository files navigation

StreamCompanion

StreamCompanion is a program directed towards osu! streamers, with functions such as a pp counter and map information

Functions

  • Grabbing song title anywhere you are in osu!
  • A simplistic map and PP web displays
  • Customizable map outputs
  • Key counter - how many times you clicked these 2 osu! keys since...(beginning of the stream?)
  • Play/Retry counter
  • Mods display
  • osu!Post integration
  • Magic(and more)

Help!

StreamCompanion has a wiki explaining most of its functionality. Give it a read if you are having problems or wish to know what SC can do.

Any contributions / constructive criticism is appreciated

Built in web overlays support

After starting StreamCompanion navigate to http://localhost:20727/ to see default web overlays. All overlays live in Files/Web/overlays/ folder and you're free to create/edit these as you see fit.
Default Live Overlay can be configured to some extent in settings Visualizer tab without having to tinker with js/css.
WebOverlayPreview

Plugins

StreamCompanion supports and treats plugins as first-class citizen - majority of its functionality is written using this system
If you wish to create plugin/use SC for something and have no clue where to start - create a Github issue or ask on Discord

License

This software is licensed under MIT. You can find the full text of the license here.

About

osu! information extractor, ranging from selected map info to live play data

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • C# 86.5%
  • JavaScript 4.9%
  • C++ 3.9%
  • HTML 2.1%
  • CSS 1.2%
  • Inno Setup 0.7%
  • Other 0.7%