Building StreamCompanion

Prerequisites

• .NET 8.0.x x64 SDK
• Optional:
  • Visual Studio Community. Not required, but recommended for plugin development.
  • InnoSetup with Inno download plugin. Used for creating Setup files.

I just want to compile it myself

• Step 1: Install .NET SDK mentioned in prerequisites if you haven't already.

• Step 2: Navigate to place where you downloaded full StreamCompanion source code (here) and run buildRelease.cmd inside.

• Step 3: After successful build everything should be ready to use inside build\Release directory.

• Optional Step 4: Copy in-game overlay plugins from build\Release_browserOverlay & build\Release_unsafe to build\Release to have both text and browser in-game overlay plugins available.

Building solution in Visual Studio

• Step 1: Open osu!StreamCompanion.sln located in main folder.

• Step 2: Build whole solution by pressing CTRL+SHIFT+B or right click on top solution node and select build.

• Step 3: StreamCompanion can be now ran either from build folder or from Visual Studio with full debugger capability across plugins if it was built in Debug configuration.