EveShipFit.EsfFormat 1.2.0

dotnet add package EveShipFit.EsfFormat --version 1.2.0
                    
NuGet\Install-Package EveShipFit.EsfFormat -Version 1.2.0
                    
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="EveShipFit.EsfFormat" Version="1.2.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="EveShipFit.EsfFormat" Version="1.2.0" />
                    
Directory.Packages.props
<PackageReference Include="EveShipFit.EsfFormat" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add EveShipFit.EsfFormat --version 1.2.0
                    
#r "nuget: EveShipFit.EsfFormat, 1.2.0"
                    
#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.
#:package EveShipFit.EsfFormat@1.2.0
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=EveShipFit.EsfFormat&version=1.2.0
                    
Install as a Cake Addin
#tool nuget:?package=EveShipFit.EsfFormat&version=1.2.0
                    
Install as a Cake Tool

esf-format

NuGet CI

Discord

Read and write esf/1, the plain-text format for EVE Online ship fits. Text, canonical and binary forms. No dependencies. .NET 8 or later.

dotnet add package EveShipFit.EsfFormat

Usage

using EveShipFit.EsfFormat;

var fit = new EsfFit
{
    Hull = 587, // Rifter
    Name = "Shield Buffer",
    Entries =
    [
        new Entry(2889) { Count = 3, Charge = 21898 }, // 3 guns, a full load of ammo each
        new Entry(null) { Location = Location.High }, // an empty high slot
        new Entry(448) { State = State.Off }, // an offline module
        new Entry(2048), // goes in its own rack
        new Entry(2456) { Count = 5 }, // 5 drones
        new Entry(21898) { Count = 1000, Location = Location.Cargo },
    ],
};

string text = Esf.Save([fit], catalog); // canonical text
byte[] data = Esf.SaveBinary([fit], catalog); // binary
IReadOnlyList<EsfFit> fits = Esf.Load(data, catalog); // text or binary

string url = Esf.ToBase64Url(data); // the binary form in a URL
data = Esf.FromBase64Url(url);

Save() and SaveBinary() take entries in any order, and check every rule of the spec. Load() returns fits in canonical form. All three throw EsfException when a rule is broken. It says where: LineNumber for text, or FitNumber and EntryNumber (counting from 1) for fits.

Fits

An EsfFit is one fit: Hull, Name, tactical Mode and its Entries. Hull is null for a fit without a ship. A document can hold more than one fit.

Each Entry is one line of the fit. null means the default:

property what it is null means
Type The type ID. An empty slot.
Count How many. One; for fighters, a full squadron.
FitName The name of another fit in the list, which this ship or container carries. Carries no fit.
Charge The charge loaded.
ChargeCount How many charges. A full load.
Mutaplasmid The mutaplasmid applied.
Overrides Attribute values by attribute ID.
State State.Off, On or Heat. Active if the type can be, else on.
Location Cargo, Bay or another hold; a rack for an empty slot, or with Slot. Where the type goes by default.
Slot The slot in the Location rack, counting from 1. Not with Count, except for a fighter in a Tube; the item must go in that rack, and each slot is pinned once. Load() never sets it: it returns the rack in slot order, with empty slots between. The next free slot.

EsfFit and Entry are records, and compare by value.

The Catalog

The library holds no game data. You give it an ICatalog: an object that looks up types and attributes in your copy of the SDE.

public sealed class MyCatalog : ICatalog
{
    public TypeRecord? TypeByName(string foldedName) => ...;
    public TypeRecord? TypeById(int typeId) => ...;
    public AttributeRecord? AttributeByName(string foldedName) => ...;
    public AttributeRecord? AttributeById(int attributeId) => ...;

    // Optional. Without them, no hull has tactical modes and no type has mutaplasmids.
    public IReadOnlyList<TypeRecord> Modes(int hullId) => ...;
    public IReadOnlyList<MutaplasmidRecord> Mutaplasmids(int typeId) => ...;
}

Each method and property says what to return and where in the SDE it comes from. Sde has helpers for the parts that take more than a lookup:

var typeNames = Sde.NameIndex(types, t => t.Id, t => t.Name.En, t => t.Published);

// effects: effectID -> effectCategoryID; attributes: attributeID -> value

new TypeRecord(
    t.Id,
    t.Name.En,
    Sde.Kind(group.CategoryId, t.GroupId, effects.Keys),
    Sde.Active(effects),
    t.Capacity ?? 0,
    t.Volume ?? 0,
    Sde.SquadronSize(attributes));

examples/SdeJsonlCatalog.cs is a complete example on the official SDE in JSONL: copy it into your project.

ESI

ESI gives each item in a ship a location_flag. Esi turns it into a location and a slot:

new Entry(typeId) { Location = Esi.Location(flag) ?? Location.Cargo, Slot = Esi.Slot(flag) }

HiSlot2 gives High and slot 3, and ShipHangar gives Maintenance. A flag that is not inside a ship, like Hangar, gives null; the example puts those items in the cargo hold.

Tests

The test cases live in esf-format:

git clone --branch v1.0 https://github.com/EVEShipFit/esf-format
dotnet build tests/EsfFormat.Program -c Release
uv run --project esf-format/tools esf-test -- dotnet tests/EsfFormat.Program/bin/Release/net10.0/esf-program.dll
dotnet format --verify-no-changes
dotnet test
Product Compatible and additional computed target framework versions.
.NET 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.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • net8.0

    • No dependencies.

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.2.0 0 11/16/2026
1.1.0 50 11/14/2026
1.0.0 120 11/1/2026