Lumina 1.0.0-preview1

This is a prerelease version of Lumina.

There is a newer version of this package available.
See the version list below for details.

dotnet add package Lumina --version 1.0.0-preview1

NuGet\Install-Package Lumina -Version 1.0.0-preview1

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="Lumina" Version="1.0.0-preview1" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

paket add Lumina --version 1.0.0-preview1

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: Lumina, 1.0.0-preview1"

#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 Lumina as a Cake Addin
#addin nuget:?package=Lumina&version=1.0.0-preview1&prerelease

// Install Lumina as a Cake Tool
#tool nuget:?package=Lumina&version=1.0.0-preview1&prerelease

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Lumina

Lumina is an (attempt) at creating a small, performant library for interacting with FINAL FANTASY XIV game data in a convenient manner.

Usage

Read File

Currently only regular files are supported, models and textures are coming soon™

var lumina = new Lumina( "path/to/sqpack/folder" );

var file = lumina.GetFile( "exd/root.exl" );

File.WriteAllBytes( "root.exl", file.GetDataSection( 0 ) );

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 is compatible. netcoreapp3.1 was computed.

Product

.NET

.NET Core

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

.NETCoreApp 3.0
- SharpZipLib (>= 1.2.0)

NuGet packages (5)

Showing the top 5 NuGet packages that depend on Lumina:

Package	Downloads
Lumina.Excel Typed definitions to access excel sheet data in FINAL FANTASY XIV.	50.9K
FFXIVWeather.Lumina FFXIV weather forecast library for C# applications operating on a system with a local game installation.	6.8K
Lumina.Generated Generated structures for Lumina.	4.9K
ExdSheets Better bindings for Lumina's sheets based on EXDSchema. Use this in place of GeneratedSheets. Instantiate a ExdSheets.Module to get started.	1.9K
NetStone.GameData.Lumina Lumina game data bindings for NetStone.	365

GitHub repositories (7)

Showing the top 5 popular GitHub repositories that depend on Lumina:

Repository	Stars
goatcorp/Dalamud FFXIV plugin framework and API	1.3K
imchillin/Anamnesis A standalone tool that allows the user a greater degree of flexibility for making creative and interesting screenshots.	838
aers/FFXIVClientStructs Resources for reverse-engineering the FFXIV client's native classes.	246
imchillin/CMTool	206
Universalis-FFXIV/Universalis A crowdsourced market board API for FFXIV.	190