scuffedaim.osuapi 1.0.0

dotnet add package scuffedaim.osuapi --version 1.0.0
                    
NuGet\Install-Package scuffedaim.osuapi -Version 1.0.0
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="scuffedaim.osuapi" Version="1.0.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="scuffedaim.osuapi" Version="1.0.0" />
                    
Directory.Packages.props
<PackageReference Include="scuffedaim.osuapi" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add scuffedaim.osuapi --version 1.0.0
                    
#r "nuget: scuffedaim.osuapi, 1.0.0"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package scuffedaim.osuapi@1.0.0
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=scuffedaim.osuapi&version=1.0.0
                    
Install as a Cake Addin
#tool nuget:?package=scuffedaim.osuapi&version=1.0.0
                    
Install as a Cake Tool

osu_API Project README

Project Overview

The osuApi library provides a .NET wrapper for interacting with the osu! api v2.

Project Features

  • Supports Beatmap, Score and User api endpoints

Prerequisites

  1. .NET Framework
    • Ensure you have .NET Framework version 8.0 or higher installed on your system.

Installation

# Clone the repository
git clone https://github.com/yourusername/osu_api.git

# Install the NuGet packages
dotnet restore

Usage

Basic Usage Example:

using osu_api;
var api = new ApiClient("client id", "client secret");
await api.AuthenticateAsync();
var score = await api.GetScoreAsync("MYID");
Console.WriteLine(score.PP);

Version Compatibility

This version of osu_API is compatible with .NET Framework versions greater than or equal to 8.0.

Contributing

Contributions are welcome under the GNU GPLv3 license terms.

Known Issues

  • API Response Parsing
    Ensure your environment includes an internet connection for API requests.

  • Rate Limiting

By using this library, you agree to the terms of the GNU GPLv3 license.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.0.0 170 2/15/2025