cytraen / gw2sharp

A cross-platform .NET wrapper library for the Guild Wars 2 API written in C#

Gw2Sharp

Gw2Sharp is a cross-platform .NET wrapper library for the official Guild Wars 2 API written in C#.

This library has been written to be as close as possible to the official API structure, with a few exceptions to make life easier. Make sure to read the introductory guide to get started.

Supported services

The following services supported by Gw2Sharp:

• WebAPI v2 - introduction, endpoints
• Render service - introduction
• Mumble service - introduction
• Chat links - introduction

Requirements

This project targets .NET 5, .NET Core 3.1 and .NET Standard 2.0 for compatibility with older .NET Frameworks (check the .NET Standard 2.0 compatibility table) It supports the C# 8.0 nullable reference types feature for your convenience, but it's not required when consuming the library.

Installing

You can find the library on NuGet. Or, alternatively, you can install it by running dotnet add package Gw2Sharp in a console, or Install-Package Gw2Sharp in the package manager console.

Usage

For basic usage, check out the introductory guide.
You can find the other guides there as well to help you get started on the advanced usage of Gw2Sharp, such as caching and exception handling.

Compiling

Visual Studio 2019 (16.10) or later is required, along with the .NET 5 SDK and .NET Core 3.1 SDK. If they aren't installed automatically for some reason, make sure to install them manually.

Contributing

Contributing is always welcome, but please keep them in scope of this project. I'm looking for all contributions that fixes bugs. But regarding implementing new features, it's better to raise an issue first explaining why that new feature should be added.

If you're adding something new, do add some tests for it as well. I'm aiming for this project to be as stable as possible.