Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kiritsu/osusharp
Unofficial wrapper for the osu! API (V1, V2) written in C# and compatible with .NET 6 - Not really maintained due to lack of time and very bad design
https://github.com/kiritsu/osusharp
api azure azure-pipelines ci cs csharp hacktoberfest library net-5 nuget oppai osu pp wrapper
Last synced: about 2 months ago
JSON representation
Unofficial wrapper for the osu! API (V1, V2) written in C# and compatible with .NET 6 - Not really maintained due to lack of time and very bad design
- Host: GitHub
- URL: https://github.com/kiritsu/osusharp
- Owner: Kiritsu
- License: apache-2.0
- Created: 2019-03-25T08:14:30.000Z (almost 6 years ago)
- Default Branch: dev
- Last Pushed: 2023-12-30T18:35:13.000Z (about 1 year ago)
- Last Synced: 2024-05-16T04:57:22.036Z (8 months ago)
- Topics: api, azure, azure-pipelines, ci, cs, csharp, hacktoberfest, library, net-5, nuget, oppai, osu, pp, wrapper
- Language: C#
- Homepage:
- Size: 1.43 MB
- Stars: 22
- Watchers: 1
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# OsuSharp
[](https://badge.fury.io/nu/OsuSharp)
[](https://dev.azure.com/allanmercou/OsuSharp/_build/latest?definitionId=11&branchName=dev)
**OsuSharp is a wrapper written in C# for the osu! API.**
- Compatible with .NET 6
## Installation
You can install the stable version of the wrapper with NuGet (only supports API v1 for packages prior to 6.0.0):
```
PM> Install-Package OsuSharp
```
You can also compile from source:
```git
git clone https://github.com/Kiritsu/OsuSharp.git
```
## Basic Usage
You can use the following example to get started with the library:
> Program.cs
```cs
public static class Program
{
public static void Main(string[] args)
{
CreateHostBuilder(args).Build().Run();
}
public static IHostBuilder CreateHostBuilder(string[] args)
{
return Host.CreateDefaultBuilder(args)
.ConfigureOsuSharp((ctx, options) => options.Configuration = new OsuClientConfiguration
{
ClientId = 123,
ClientSecret = "my-super-secret"
})
.ConfigureServices((ctx, services) => services.AddSingleton());
}
}
```
> IOsuService.cs
```cs
internal interface IOsuService
{
IAsyncEnumerable GetLastRankedBeatmapsetsAsync(int count);
Task GetUserAvatarUrlAsync(string username);
}
```
> OsuService.cs
```cs
public class OsuService : IOsuService
{
private readonly IOsuClient _client;
public OsuService(IOsuClient client)
{
_client = client;
}
public async IAsyncEnumerable GetLastRankedBeatmapsetsAsync(int count)
{
var builder = new BeatmapsetsLookupBuilder()
.WithGameMode(GameMode.Osu)
.WithConvertedBeatmaps()
.WithCategory(BeatmapsetCategory.Ranked);
await foreach (var beatmap in _client.EnumerateBeatmapsetsAsync(builder, BeatmapSorting.Ranked_Desc))
{
yield return beatmap;
count--;
if (count == 0)
{
break;
}
}
}
public async Task GetUserAvatarUrlAsync(string username)
{
var user = await _client.GetUserAsync(username);
return user.AvatarUrl.ToString();
}
}
```
## Contributing
If you want to contribute, feel free to use Issues or Pull Requests!
### Todo:
```
Beatmapset Discussions
- /beatmapsets/discussions/posts (Get Beatmapset Discussion Posts)
- /beatmapsets/discussions/votes (Get Beatmapset Discussion Votes)
- /beatmapsets/discussions/ (Get Beatmapset Discussions)
Changelog
- /changelog/{stream}/{build} (Get Changelog Build)
- /changelog (Get Changelog Listing)
- /changelog/{changelog} (Lookup Changelog Build)
Chat
- /chat/new (Create New PM)
Comments
- /comments (Get Comments)
- /comments/{comment} (Get a Comment)
Forum
- /forums/topics/{topic}/reply (Reply Topic)
- /forums/topics (Create Topic)
- /forums/topics/{topic} (Get Topic and Posts)
- /forums/topics/{topic} (Edit Topic)
- /forums/posts/{topic} (Edit Post)
Home
- /search (Search | Users AND/OR Wiki pages)
Multiplayer
- /rooms/{room}/playlist/{playlist}/scores (Get Scores)
News
- /news (Get News Listing)
- /news/{news} (Get News Post)
Ranking
- /spotlights (Get Spotlights)
Wiki
- /wiki/{locale}/{path}
Undocumented
- /beatmapsets/events
- /matches
- /matches/{match}
- /rooms/{mode?}
- /rooms/{room}/leaderboard
- /rooms/{room}
- /beatmapsets/lookup (doesn't seem to work?)
- /friends
```
### Done already
```
Users
- /me/{mode} (Get Own Data)
- /users/{user}/kudosu (Get User Kudosu)
- /users/{user}/scores/{types} (Get User Scores)
- /users/{user}/beatmapsets/{type} (Get User Beatmaps)
- /users/{user}/recent_activity (Get User Recent Activity)
- /users/{user}/{mode?} (Get User)
Beatmaps
- /beatmaps/{beatmap} (Get Beatmap)
- /beatmaps/{beatmap}/scores/users/{user} (Get a User Beatmap score)
- /beatmaps/{beatmap}/scores/users/{user}/all (Get all User Beatmap score)
- /beatmaps/{beatmap}/scores (Get Beatmap scores)
- /beatmaps/lookup (Lookup Beatmap)
- /beatmaps/{beatmap}/attributes (Get Beatmap Attributes)
Beatmapsets
- /beatmapsets/{beatmapset} (Get Beatmapset)
- /beatmapsets/search/{filters?} (Search beatmapsets)
Scores
- /scores/{mode}/{score} (Get Score)
- /scores/{mode}/{score}/download (Get Replay ; Needs Authorization Code Grant)
OAuth Tokens
- /oauth/tokens/current (Revoke current token)
Misc
- /seasonal-backgrounds (Get Current Seasonal Backgrounds ; No Auth)
Ranking
- /rankings/{mode}/{type} (Get Ranking)
```
## Thanks
Thanks to the following contributors:
- [Naamloos](https://github.com/Naamloos)
- [Kamdzy](https://github.com/Kamdzy)
- [Bond-009](https://github.com/Bond-009)
- [jacksonrakena](https://github.com/jacksonrakena)
- [Piotrekol](https://github.com/Piotrekol)
- [Quahu](https://github.com/Quahu)
- [Kieran](https://github.com/k-boyle)
- [Francesco149](https://github.com/Francesco149) for Oppai.
- [TheOmyNomy](https://github.com/TheOmyNomy)
Thanks to JetBrains for giving an open source license for their products!
