https://github.com/hburn7/banchosharp

C# library for communicating with osu!Bancho
https://github.com/hburn7/banchosharp

Last synced: 3 months ago
JSON representation

C# library for communicating with osu!Bancho

• Host: GitHub
• URL: https://github.com/hburn7/banchosharp
• Owner: hburn7
• License: gpl-3.0
• Created: 2022-10-04T20:29:15.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2024-09-20T01:38:41.000Z (4 months ago)
• Last Synced: 2024-11-01T16:09:08.476Z (3 months ago)
• Language: C#
• Homepage:
• Size: 312 KB
• Stars: 11
• Watchers: 1
• Forks: 2
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

• awesome-osu-tournaments - BanchoSharp - C# library that manages connecting to osu!Bancho and automatically manages multiplayer lobbies. Used by Brigitta and Bancho Multiplayer Bot. (Community Resources / Development)

README

        
# BanchoSharp

## Synopsis

The solution for connecting to osu!Bancho in C#. This library provides various events and tools for working with osu!Bancho, [osu!](https://osu.ppy.sh/home)'s IRC server.

## Getting Started

* Add the [NuGet package](https://www.nuget.org/packages/BanchoSharp) to your project.

* Instantiate the client with the necessary credentials and subscribe to any relevant events.

> ```cs

> string username = "bob";

> string password = "12345";

>

> IBanchoClient client = new BanchoClient(new BanchoClientConfig(new IrcCredentials(username, password)));

> 

> client.OnAuthenticated += () => 

> {

>     // Do stuff here - user is now authenticated with osu!Bancho

> }

> ````

* BanchoBot events are also directly subscribable. These are events that fire when a message is received from BanchoBot containing important information.

>```cs

> // NOTE: BanchoBotEvents and MultiplayerLobbies are WIP features.

> client.BanchoBotEvents.OnTournamentLobbyCreated += (lobby) => 

> {

>    // Send notifcation, etc. 

> }

>```