FreeRealmsLocaleTools 1.0.0

FreeRealmsLocaleTools

A .NET library which allows developers to read and write text entries from Free Realms locale files. It also includes other utilities such as acquiring the name IDs of text entries and modifying locale metadata.

Background

Locale files are located in the "./locale" and "./tcg/locale" directories of a Free Realms client, in the form of <locale>_data.dat and <locale>_data.dir files (i.e., en_us_data.dat/en_us_data.dir). The .dat file consists of text entries while the .dir file contains metadata and information on each entry in the .dat file. Combined, the client uses these files to display text based on the user's locale configuration.

Examples of an en_us_data.dat and en_us_data.dir file can be seen here.

Usage

See documentation for API reference, samples, and tutorials.

Installation

This project is available as a NuGet package.

dotnet add package FreeRealmsLocaleTools

Code Samples

Adding a Locale Entry

using FreeRealmsLocaleTools.LocaleParser;

LocaleFileInfo localeFile = new("data/en_us_data.dat", "data/en_us_data.dir");
int nameId = localeFile.AddEntry("Illusion: Necronomicus - 15 minutes");
Console.WriteLine(localeFile.IdToEntry[nameId]);
localeFile.WriteEntries();

Console output:

2841312400      ucdt    Illusion: Necronomicus - 15 minutes

Generating a CSV of Name IDs → Text

using CsvHelper;
using FreeRealmsLocaleTools.LocaleParser;
using System.Globalization;

LocaleFileInfo localeFile = new("data/en_us_data.dat", "data/en_us_data.dir");
using StreamWriter writer = new("names.csv");
using CsvWriter csv = new(writer, CultureInfo.InvariantCulture);
csv.WriteRecords(localeFile.IdToEntry.Select(x => new { Id = x.Key, x.Value.Text }));

First 5 lines of names.csv:

Id,Text
1,Default Housing NPC
2,You receive #count([*item*])
3,You receive #count([*experience*]) and #count([*coins*])
4,coin

Reading Locale Metadata

using FreeRealmsLocaleTools.LocaleParser;

LocaleMetadata metadata = LocaleFile.ReadMetadata("data/en_us_data.dir");
Console.WriteLine($"Locale = {metadata.Locale}");
Console.WriteLine($"Count = {metadata.Count}");
Console.WriteLine($"Date = {metadata.Date}");

Console output:

Locale = en_US
Count = 113286
Date = Thu Mar 13 10:10:13 PDT 2014

Supported Locales

Credits

Icon by photo3idea_studio.