https://github.com/Piotrekol/StreamCompanion

osu! information extractor, ranging from selected map info to live play data
https://github.com/Piotrekol/StreamCompanion

catch-the-beat osu osugame osumania taiko

Last synced: 6 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/Piotrekol/StreamCompanion
• Owner: Piotrekol
• License: mit
• Created: 2016-04-07T14:22:24.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2025-03-09T11:41:48.000Z (7 months ago)
• Last Synced: 2025-03-09T12:25:45.388Z (7 months ago)
• Topics: catch-the-beat, osu, osugame, osumania, taiko
• Language: C#
• Homepage:
• Size: 9.63 MB
• Stars: 383
• Watchers: 13
• Forks: 59
• Open Issues: 25
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

          
### ![StreamCompanion](images/logo.png)

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

 

[![AppVeyor](https://img.shields.io/appveyor/build/Piotrekol/StreamCompanion/master)](https://ci.appveyor.com/project/Piotrekol/streamcompanion)

[![Discord](https://img.shields.io/discord/452057328532062219?label=Discord)][discord]

[![License](https://img.shields.io/github/license/Piotrekol/StreamCompanion)][license]

[![Latest GitHub release](https://img.shields.io/github/v/release/Piotrekol/StreamCompanion)](https://github.com/Piotrekol/StreamCompanion/releases/latest)

![GitHub downloads](https://img.shields.io/github/downloads/Piotrekol/StreamCompanion/total)

[![StreamCompanionTypesNuget](https://img.shields.io/nuget/v/streamCompanionTypes?label=StreamCompanionTypes)](https://github.com/Piotrekol/StreamCompanionTypes)

## 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][osuPost] integration

  - Magic(and more)

## Help!

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

Still clueless? Ask on [Discord][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](images/webOverlay.jpg)

## Plugins

StreamCompanion supports and treats plugins as first-class citizen - [majority of its functionality is written using this system](./plugins)  

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][discord]

## License

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

   [license]: 

   [osuPost]: 

   [wiki]: 

   [discord]: