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

Piotrekol/StreamCompanion

Folders and files

NameName
Last commit message
Last commit date

Latest commit

b6b7396 · Jun 22, 2023
Oct 5, 2021
Jun 17, 2023
Oct 21, 2022
Mar 18, 2023
Mar 18, 2023
Jun 14, 2022
Jun 14, 2022
Jan 29, 2021
Jun 22, 2023
Sep 16, 2020
Jul 30, 2022
Jun 17, 2023
Jun 22, 2023
Sep 30, 2022
Dec 7, 2022
Jun 26, 2018
Sep 30, 2021
Nov 7, 2021
Mar 11, 2018
Sep 16, 2021
Aug 13, 2021
Oct 9, 2021
Apr 25, 2019
Sep 5, 2022
Mar 5, 2019

Repository files navigation

StreamCompanion

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

AppVeyor Discord License Latest GitHub release GitHub downloads StreamCompanionTypesNuget

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.
Still clueless? Ask on Discord.

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.