GW2SDK 1.0.0-preview.15

.NET 6.0 .NET Standard 2.0 .NET Framework 4.6.2
This is a prerelease version of GW2SDK.
There is a newer prerelease version of this package available.
See the version list below for details. 
dotnet add package GW2SDK --version 1.0.0-preview.15
NuGet\Install-Package GW2SDK -Version 1.0.0-preview.15
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="GW2SDK" Version="1.0.0-preview.15" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add GW2SDK --version 1.0.0-preview.15
#r "nuget: GW2SDK, 1.0.0-preview.15"
#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. 
// Install GW2SDK as a Cake Addin
#addin nuget:?package=GW2SDK&version=1.0.0-preview.15&prerelease

// Install GW2SDK as a Cake Tool
#tool nuget:?package=GW2SDK&version=1.0.0-preview.15&prerelease

About

GW2SDK provides classes for interacting with the Guild Wars 2 API and game client. This package enables you to fetch information about the game, the player's account, PvP seasons, WvW matches and the in-game economy. It also provides realtime information from the game client such as the player's current character and the current map.

Key features

  • Gw2Client provides access to the Guild Wars 2 API
  • GameLink provides realtime information from the game client (Windows only)

How to use

You can use the Gw2Client for many different purposes, such as fetching the current prices of all tradable items in the game, or the GameLink to receive realtime information from the game client. Below are some examples of how to use the Gw2Client and GameLink to fetch information about the game and the player's account.

using System;
using System.Net.Http;
using System.Threading.Tasks;
using GuildWars2;

namespace PackageReadme;

internal class Gw2ClientProgram
{
    public static async Task Main(string[] args)
    {
        // Create an instance of the Gw2Client, which depends on HttpClient
        using var httpClient = new HttpClient();
        var gw2 = new Gw2Client(httpClient);

        // Print a table header
        PrintTableHeader();

        // Fetch the current prices of all items
        await foreach (var (itemPrice, _) in gw2.Commerce.GetItemPricesBulk())
        {
            // The item price contains the item's ID, which can be used to fetch the item's name
            var (item, _) = await gw2.Items.GetItemById(itemPrice.Id);

            // Print the item's name and its current highest buyer and lowest seller
            PrintTableRow(item.Name, itemPrice.BestBid, itemPrice.BestAsk);
        }

        void PrintTableHeader()
        {
            /*
            ================================================================================================================================================================
            | Item                                               | Highest buyer                                      | Lowest seller                                      |
            ================================================================================================================================================================
             */
            Console.WriteLine(new string('=', 160));
            Console.WriteLine($"| {"Item",-50} | {"Highest buyer",-50} | {"Lowest seller",-50} |");
            Console.WriteLine(new string('=', 160));
        }

        void PrintTableRow(string item, Coin highestBuyer, Coin lowestSeller)
        {
            /*
             | <item>                                             | <highestBuyer>                                     | <lowestSeller>                                     |
             */
            Console.WriteLine($"| {item,-50} | {highestBuyer,-50} | {lowestSeller,-50} |");
        }
    }
}

The GameLink can be used to receive realtime information from the game client. Below is an example of how to use the GameLink to receive information about the player's current character and the current map.

using System;
using System.Linq;
using System.Net.Http;
using System.Threading.Tasks;
using GuildWars2;

namespace PackageReadme;

internal class GameLinkProgram
{
    public static async Task Main(string[] args)
    {
        if (!GameLink.IsSupported())
        {
            Console.WriteLine("GameLink is only supported on Windows!");
            return;
        }

        Console.WriteLine("GameLink is starting! (Ensure the game is running and that you are loaded into a map.)");


        // Pre-fetch all maps from the API, they are used to display the player's current map
        using var http = new HttpClient();
        var gw2 = new Gw2Client(http);
        var (maps, _) = await gw2.Exploration.GetMapSummaries();

        // Choose an interval to indicate how often you want to receive fresh data from the game
        // For example, at most once every second
        // Default: no limit, every change in the game state will be available immediately
        var refreshInterval = TimeSpan.FromSeconds(1);
        
        // Open the game link with the chosen refresh interval
        var gameLink = GameLink.Open(refreshInterval);
        
        // Subscribe to the game link to start receiving game state updates
        var subscription = gameLink.Subscribe(
            tick =>
            {
                // Each 'tick' contains information about the player's character and actions, among other things
                var player = tick.GetIdentity();

                // The identity can be missing due to JSON errors, always check for null
                if (player != null)
                {
                    // Use the player's map ID to find the map name in the pre-fetched list of maps
                    var map = maps.Single(map => map.Id == player.MapId);

                    // Print the player's name and current map
                    Console.WriteLine($"[{tick.UiTick}] Your name is {player.Name}.");
                    Console.WriteLine(
                        $"[{tick.UiTick}] You are currently in {map.Name} ({tick.Context.ServerAddress})."
                    );
                    Console.WriteLine();
                }
            }
        );

        // Wait for the user to press Enter
        Console.ReadLine();

        // Stop the data stream and close the game link
        subscription.Dispose();
        gameLink.Dispose();
    }
}

Additional documentation

Feedback & contributing

GW2SDK is released as open source under the MIT license. You are welcome to create an issue if you find something is missing or broken, or a discussion for other feedback, questions or ideas. Check out the GitHub page to find more ways to contribute.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 is compatible.  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 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. 
.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 is compatible.  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. 
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-rc.2 92 4/6/2024
1.0.0-rc.1 64 3/30/2024
1.0.0-preview.15 48 3/25/2024
1.0.0-preview.14 96 3/25/2024
1.0.0-preview.13 322 2/18/2024
1.0.0-preview.12 413 12/11/2023
1.0.0-preview.11 103 12/5/2023
1.0.0-preview.10 162 11/12/2023
1.0.0-preview.9 150 11/5/2023
1.0.0-preview.8 70 11/4/2023
1.0.0-preview.7 116 10/30/2023
1.0.0-preview.6 73 10/29/2023
1.0.0-preview.5 103 10/28/2023
1.0.0-preview.4 158 10/23/2023
1.0.0-preview.3 91 10/21/2023
1.0.0-preview.2 64 10/18/2023
1.0.0-preview.1 69 10/15/2023

https://github.com/sliekens/gw2sdk/releases/tag/v1.0.0-preview.15