NetStone 1.2.1

dotnet add package NetStone --version 1.2.1                
NuGet\Install-Package NetStone -Version 1.2.1                
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="NetStone" Version="1.2.1" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add NetStone --version 1.2.1                
#r "nuget: NetStone, 1.2.1"                
#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 NetStone as a Cake Addin
#addin nuget:?package=NetStone&version=1.2.1

// Install NetStone as a Cake Tool
#tool nuget:?package=NetStone&version=1.2.1                

NetStone Nuget

NetStone is a portable and modern .NET FFXIV Lodestone API.

What works

  • Characters
  • Character Search
  • FCs
  • FC Search
  • PvP Teams
  • PvP Team Search
  • Linkshell
  • Linkshell Search
  • CWLS
  • CWLS Search

Eorzea DB support is not planned.

Usage

Set up the client

If you want to use NetStone you need to create one instance of the LodestoneClient and use this instance for all your requests. Note that this operation downloads current definitions and can therefore take an unknown amount of time or even throw and exception.

Example Code
try{
	var lodestoneClient = await LodestoneClient.GetClientAsync();
} catch(HttpRequestException ex){
	...
}

Retrieve character information

Character information is fetched using the character's lodestone ID (the number contained in the Url). If the ID is not known to you, you can use the built in search functionality to look up a character by name and home world. If you need to fetch data for a specific character often it is best practice to save the Lodestone Id. Note that the search can have 0 results and that a character is null if the request failed.

Example code
//Get Lodestone Id if not known
var searchResponse = await lodestoneClient.SearchCharacter(new CharacterSearchQuery()
{
    CharacterName = "Name Surname",
    World = "Lich"
});
var lodestoneCharacter = 
	searchResponse?.Results
	.FirstOrDefault(entry => entry.Name == "Name Surname");
string lodestoneId = lodestoneCharacter.Id;

//If Lodestone id is known
var lodestoneCharacter = await lodestoneClient.GetCharacter(lodestoneId);

Product 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 netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.1 is compatible. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen 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 (1)

Showing the top 1 NuGet packages that depend on NetStone:

Package Downloads
NetStone.GameData.Lumina

Lumina game data bindings for NetStone.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.2.1 338 7/13/2024
1.2.0 299 7/7/2024
1.1.2 529 5/31/2024
1.1.1 1,483 3/30/2024
1.0.0 702 11/4/2021

Changelog.md