Chorizite.DatReaderWriter 1.0.0

.NET 8.0 .NET Standard 2.0 .NET Framework 4.8

dotnet add package Chorizite.DatReaderWriter --version 1.0.0

NuGet\Install-Package Chorizite.DatReaderWriter -Version 1.0.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="Chorizite.DatReaderWriter" Version="1.0.0" />

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

<PackageVersion Include="Chorizite.DatReaderWriter" Version="1.0.0" />
                    

                            Directory.Packages.props

<PackageReference Include="Chorizite.DatReaderWriter" />
                    

                            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 Chorizite.DatReaderWriter --version 1.0.0

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

#r "nuget: Chorizite.DatReaderWriter, 1.0.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 Chorizite.DatReaderWriter@1.0.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=Chorizite.DatReaderWriter&version=1.0.0
                    

                            Install as a Cake Addin

#tool nuget:?package=Chorizite.DatReaderWriter&version=1.0.0
                    

                            Install as a Cake Tool

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

DatReaderWriter

DatReaderWriter is an open-source library for reading and writing .dat files used by the game Asheron's Call. This tool allows players and developers to access and modify game data files for various purposes, such as creating mods or analyzing game content.

Features
Installation
Basic Usage
Todo
Contributing
Thanks
License

Features

Read/Write AC end-of-retail .dat files (Including creating new dats!)
Full Dat BTree seeking / insertion / removal / range queries
Built-in caching options
net8.0;netstandard2.0;net48 nuget packages
Most DBObj file formats are in the dats.xml, which could be potentially used to generate readerwriters in other languages

Basic Usage

Install Chorizite.DatReaderWriter package from nuget.org
See Tests for further usage.

Getting Started

// Open a set of dat file for reading. This will open all the eor dat files as a single collection.
// (client_portal.dat, client_cell_1.dat, client_local_English.dat, and client_highres.dat)
var datPath = @"C:\Turbing\Asheron's Call\";
var dats= new DatCollection(EORCommonData.DatDirectory, DatAccessType.ReadWrite);

// read files
LayoutDesc? layoutDesc = dats.Get<LayoutDesc>(0x21000000u);

// check iteration of portal dat
Console.WriteLine($"Portal Iteration: {dats.Portal.Iteration.CurrentIteration}");

// get ids of all Animations
IEnumerable<uint> allAnimationIds = dats.GetAllIdsOfType<Animation>();

// determine type from a file id
var type = dats.Local.TypeFromId(0x21000000u);
Assert.AreEqual(DBObjType.LayoutDesc, type);

// write a file with a new iteration
StringTable? stringTable = dats.Get<StringTable>(0x23000001u) ?? throw new Exception("StringTable not found");
stringTable.StringTableData.Add(0x1234u, new StringTableData() {
    Strings = ["foo", "bar"]
});
var newIteration = dats.Local.Iteration.CurrentIteration + 1;
if (!dats.TryWriteFile(stringTable, newIteration)) throw new Exception($"Failed to write StringTable");

// Dispose dat collection to flush any changes and close the files
dats.Dispose();

Update spell names and descriptions

var portalDat = new PortalDatabase(Path.Combine(config.clientDir, "client_portal.dat"), DatAccessType.ReadWrite);
var spellTable = portalDat.SpellTable ?? throw new Exception("Failed to read spell table");

// update spell name / description (no need to worry about updating Components with newly
// encrypted values, they will be transparently decrypted/encrypted during (un)packing).
spellTable.Spells[1].Name = "Strength Other I (updated)";
spellTable.Spells[1].Description = "Increases the target's Strength by 10 points. (updated)";

//write the updated spell table
if (!portalDat.TryWriteFile(spellTable)) {
    throw new Exception("Failed to write spell table");
}

// close dat
portalDat.Dispose();

Rewrite all MotionTables to be 100x speed

var portalDat = new PortalDatabase(Path.Combine(config.clientDir, "client_portal.dat"), DatAccessType.ReadWrite);

// loop through all motion tables and update framerates
foreach (var mTable in portalDat.MotionTables) {
    // build a list of all animations
    var anims = new List<AnimData>();
    anims.AddRange(mTable.Cycles.Values.SelectMany(c => c.Anims));
    anims.AddRange(mTable.Modifiers.Values.SelectMany(c => c.Anims));
    anims.AddRange(mTable.Links.Values.SelectMany(v => v.MotionData.Values.SelectMany(c => c.Anims)));

    // update all animation framerates
    foreach (var anim in anims) {
        anim.Framerate *= 100f;
    }

    // write MotionTable back to the dat
    portalDat.TryWriteFile(mTable);
}

// close dat
portalDat.Dispose();

Todo

Support for older dat formats
Clean up source gen so the library can be generated in other languages (kaitai struct?)
DBObjs left to implement:
- RenderMaterial

Contributing

We welcome contributions from the community! If you would like to contribute to DatReaderWriter, please follow these steps:

Fork the repository.
Create a new branch (git checkout -b feature-branch).
Make your changes.
Commit your changes (git commit -am 'Add some feature').
Push to the branch (git push origin feature-branch).
Create a new Pull Request.

Thanks

In no particular order, thanks to ACE team, GDLE team, gmriggs, OptimShi, paradox, and Yonneh. Used lots of projects as a reference for different parts.

License

This project is licensed under the MIT License. See the LICENSE.txt file for details.

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 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.
.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 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 is compatible. 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.

.NETFramework 4.8
- System.Buffers (>= 4.6.1)
- System.IO.Pipelines (>= 9.0.5)
- System.Memory (>= 4.6.3)
.NETStandard 2.0
- System.Buffers (>= 4.6.1)
- System.IO.Pipelines (>= 9.0.5)
- System.Memory (>= 4.6.3)
net8.0
- System.Buffers (>= 4.6.1)
- System.IO.Pipelines (>= 9.0.5)
- System.Memory (>= 4.6.3)

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Chorizite.DatReaderWriter:

Package	Downloads
Chorizite.Core Chorizite core library	2.5K

GitHub repositories

This package is not used by any popular GitHub repositories.

Version	Downloads	Last Updated
1.0.0	355	5/14/2025