NorthEdge.MagicLoaderGenerator 1.3.0

MagicLoader generator

Description

This library is intended to facilitate the generation of translation files to be used by MagicLoader in order to mod Oblivion: Remastered.

Project and Solution templates are available by using dotnet new as follows:
dotnet new install NorthEdge.MagicLoaderGenerator.Templates (the first time or when updating)
dotnet new mlg-sln -n MyMod for a complete solution or dotnet new mlg-mod -n MyMod for a console project only.

Configuration

The configuration of an application using this library is broken down in several parts. See the sample configuration file.

Filesystem

These parameters control the output of the generator. See:
IModOutputGenerator
FolderOutputGenerator
ZipOutputGenerator
MagicLoaderMod

ModDirectoryStructure

Default value: OblivionRemastered\Content\Dev\ObvData\Data\MagicLoader\

This parameter describes the directory structure generated by the mod.

It is intended to reflect the directory structure of the game so that end-users of the mod can extract the mod archive at the root directory of their game installation.

OutputDirectory

Default value: MagicLoader

This parameter controls where the generator will output the mod file it produces.\

It can be a relative path to the working directory of the executable or an absolute path.

InputDirectory

Default value: Input

This parameter controls where the configuration will look for existing MagicLoader files.\

It can be a relative path to the working directory of the executable or an absolute path.

Localization

These parameters control the loading of the localization data.

LocalizationSource

Default value: Localization

This parameter controls the source of the localization data.

It can be a relative path to the working directory of the executable or an absolute path.
The library only supports loading JSON files extracted using FModel. The expected structure is one folder per language (see Languages below) containing a file named Game.json.
This translation data will not be provided.

IncludedSections

Default value: [ "ST_FullNames" ]

This parameter controls which sections of the game localization data are loaded.

Possible values are : ST_FullNames ST_ResponseTexts ST_ScriptContent ST_BookContent ST_LogEntries ST_HardcodedContent ST_AltarDynamicTexts ST_Descriptions ST_AltarStaticTexts ST_MissingEntries
See: LocalizationFile

MagicLoader can expand translation keys using the following syntax $[[<translation key>]] e.g. $[[LOC_FN_Miscarcand01]]. However, please note that it might not expand keys other than FullNames (starting with LOC_FN_).

This syntax will be used by the default transformer TranslateFileTransform if a localization key is not found for a specific language. For instance, LOC_FN_SancreTor has no translation in French or German.

Languages

Default value: [ "de", "en", "es", "fr", "it", "ja", "pl", "pt", "ru", "zh-Hans" ]

This parameter which languages are loaded by the localization provider which in turn changes the files generated by the mod.

They should have the matching directory in the Localization folder. See LanguagesEnum

Localizations

Default value: []

This parameter allows extra localization data to be added to the localization provider from the configuration.

The keys are the localization keys and, they must start with LOC_FN_. The values are dictionaries with the language codes as keys (see Languages above) and the translation as values. Example:

  "Localizations": {
    "LOC_FN_SoulLevelNameFilled": {
      "de": "Gefüllt",
      "en": "Filled",
      "es": "Completada",
      "fr": "Remplie",
      "it": "Riempito",
      "ja": "満たされた",
      "pl": "Wypełniony",
      "pt": "Cheia",
      "ru": "Заполненный",
      "zh-Hans": "充满"
    }
  }

Mod

These parameters control the output of the generator by describing files and the localization keys to include.

ModName

Default value: MagicLoaderMod

This parameter controls the root directory of the generator output as well as the name of the ZIP archives when using ZipOutputGenerator.

If ModFiles (see below) contains more than one entry, this value will also be used to create a folder inside ModDirectoryStructure.

ModFiles

This parameter describes a dictionary of files to generate using a list of localization keys.

The keys of the dictionary represent the name of the files generated by the mod. The values contain dictionaries representing the sections handled by MagicLoader as their keys and a list of localization keys as their value. The two supported sections are FullNamesEditEntries (FullNames_Edit) and FullNameEntries: (FullNames).
See MagicLoaderFile

Changelog

Version 1.1

• Initial stable release

Version 1.2

• Add an overload to MagicLoaderMod::Generate to handle variants
• Allow extra localization data to be added from the configuration
• Added support to import existing localization files into the mod

Version 1.2.1

• Fix an issue with the ZIP creation in ZipOutputGenerator where the ZipArchive wasn't disposed properly before writing the stream to the filesystem

Version 1.3

• Add optional logging to the MagicLoaderMode::Generate method and implementations of IModOutputGenerator