Stupid.RS3.API
1.0.1
See the version list below for details.
dotnet add package Stupid.RS3.API --version 1.0.1
NuGet\Install-Package Stupid.RS3.API -Version 1.0.1
<PackageReference Include="Stupid.RS3.API" Version="1.0.1" />
paket add Stupid.RS3.API --version 1.0.1
#r "nuget: Stupid.RS3.API, 1.0.1"
// Install Stupid.RS3.API as a Cake Addin
#addin nuget:?package=Stupid.RS3.API&version=1.0.1
// Install Stupid.RS3.API as a Cake Tool
#tool nuget:?package=Stupid.RS3.API&version=1.0.1
Stupid.RS3.API Usage Guide
Introduction
The Stupid.RS3.API C# package provides a simple and lightweight API wrapper for interacting with the RuneScape 3 (RS3) API. This guide will walk you through the usage of the package, including how to retrieve player quest information and filter quests based on difficulty and status.
Installation
To install the Stupid.RS3.API package, you can use the NuGet Package Manager in your C# project. Execute the following command in the NuGet Package Manager Console:
Install-Package Stupid.RS3.API
Usage
Retrieving Player Quests
The GetPlayerQuests
method allows you to retrieve a player's quest information. You can optionally filter the quests based on their difficulty and status.
Method Signature
public async Task<List<Quest>> GetPlayerQuests(string name, Difficulty? filterDifficulty = null, QuestStatus? filterStatus = null)
name
(string): The RuneScape 3 username for which you want to retrieve quest information.filterDifficulty
(optional): Filter quests by their difficulty (optional).filterStatus
(optional): Filter quests by their status (optional).
Example Usage
using System;
using Stupid.RS3.API;
namespace RS3QuestRetrieval
{
class Program
{
static async Task Main(string[] args)
{
// Create an instance of the RS3 API client
var rs3Client = new Client();
// Define the player's RuneScape 3 username
string playerName = "YourPlayerName";
// Retrieve the player's quests (no filters applied)
var playerQuests = await rs3Client.GetPlayerQuests(playerName);
// Display the player's quests
foreach (var quest in playerQuests)
{
Console.WriteLine($"Title: {quest.Title}, Status: {quest.Status}, Difficulty: {quest.Difficulty}");
}
}
}
}
Filter by Difficulty and Status
You can filter quests by difficulty and status by providing the optional parameters:
var filteredQuests = await rs3Client.GetPlayerQuests(playerName, Difficulty.Experienced, QuestStatus.COMPLETED);
This example retrieves quests that are of "Experienced" difficulty and have a "COMPLETED" status.
Release Notes
Version 1.0.1
- Added the
GetPlayerQuests
method to retrieve a player's quest information. - Introduced optional filtering based on quest difficulty and status.
- Updated underlying dependencies for improved performance and compatibility.
Version 1.0.0
- Initial release with basic functionality for retrieving player statistics.
- Sets the foundation for future expansion and improvements.
Please note that the above release notes are for version 1.0.1, which is an upcoming release. You can refer to the package's documentation for release notes and updates on the current version.
This guide and the release notes should help you get started with the Stupid.RS3.API package and understand the new features introduced in version 1.0.1.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. 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. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
.NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.0
- Newtonsoft.Json (>= 13.0.3)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
New method for querying player's quests