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.
The following services supported by Gw2Sharp:
- WebAPI v2 - introduction, endpoints
- Render service - introduction
- Mumble service - introduction
- Chat links - introduction
This project targets .NET Core 3.1 and .NET Standard 2.0 for compatibility with older .NET Frameworks. It supports the C# 8.0 nullable reference types feature for your convenience, but it's not required when consuming the library.
You can find the library on NuGet, or you can install it by running the following command in the package manager console:
Install-Package Gw2SharpWhenever a new commit is pushed, a workflow will run on GitHub Actions. This will result in a new CI build that will be automatically uploaded to a separate NuGet feed on Azure Artifacts. Note that these builds are not considered to be stable, they are meant only for testing purposes. Therefore, these packages are also compiled in debug configuration and have their symbols included
First, you'll have to create a new nuget.config file and add the package source to it:
<add key="Gw2Sharp-Nightly" value="https://pkgs.dev.azure.com/Archomeda/Gw2Sharp/_packaging/Nightly/nuget/v3/index.json" />Afterwards, you can install a specific version by choosing one in your package manager. Keep in mind that versions uploaded to this feed will not be available forever.
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.
Visual Studio 2019 (16.5) or later is required.
If the .NET Core SDK 3.1 isn't installed automatically for some reason, make sure to install that as well.
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.