You are viewing a potentially older version of this package. View all versions.
mimimi_turret-WKLocalizationLoader-0.7.0 icon

WKLocalizationLoader

Alternative translation library to load custom localizations.

Date uploaded a day ago
Version 0.7.0
Download link mimimi_turret-WKLocalizationLoader-0.7.0.zip
Downloads 16
Dependency string mimimi_turret-WKLocalizationLoader-0.7.0

This mod requires the following mods to function

BepInEx-BepInExPack-5.4.2305 icon
BepInEx-BepInExPack

BepInEx pack for Mono Unity games. Preconfigured and ready to use.

Preferred version: 5.4.2305

README

Notice:
If you're looking for a ready-to-use White Knuckle translation mod, WKTranslator can be your best bet. Go check it out! It's pretty easy to use and WK Modding Server's dedicated translation channel is a very good place to start your translation and collab with others.

About

This mod is an alternative translation library for loading custom localizations.

Current supported game version: 0.62

This mod does not directly ship the translations itself.
You can obtain a copy of translation templates available at the example translation page in the mod's repo.

Features

Font replacement/fallback
✅ : Supported
❌ : Not supported as of writing this

Functionality Support
Loading font from .ttf file Static fonts only
Loading font from bundle ❌
Font replacement ✅
TMP_FontAsset replacement ❌
TMP_FontAsset fallback ✅

Text translation
✅ : Implemented translation support
❌ : Not supported as of writing this

Texts Support
Vanillia Localization replacement (including Subtitles) ✅
Gamemodes ✅
Levels ✅
Cosmetics ✅
Trinkets/Bindings ✅
Perks ✅
Facility Upgrades ✅
Progression Unlocks ✅
Achievements ✅
Objectives ✅
Paper Notes ✅
OS Documents ✅
UI ✅
QuietOS UI ✅
Command Console ❌

Audio replacement
❌ No plans for audio replacement support as of writing this. There're already plenty of examples of audio replacement mods.

Texture replacement
❌ No plans for texture replacement support as of writing this. Replacing decal textures is difficult and beyond my ability.


How to Use

This mod requires BepInEx to be installed in order to function.

To use this mod, specify the path to the folder where your translation .json files are located in the mod's config.
If a .json file is missing, its associated patch module will simply be disabled and ignored while patching.

A detailed documentaion of this mod is currently WIP.


Notes

This mod is an unofficial translation tool. It it not affiliated with Dark Machine.

It patches the game's code heavily and is likely to break between game updates. I'll try to update it if breaks occur.

None of the code or asset of this mod is ai-generated.

CHANGELOG

0.7.0

  • Update to game version 0.62.
  • Update several translation .json file formats.
  • Add ClosedCaptionSubtitles.json.
  • Decrease default AtlasWidth and AtlasWidth values for FontProperties to 1024.
  • Decrease default BaseDuration value for ModuleSettings of AnnouncementSubtitleTimings and RecordingSubtitleTimings to 0.8.
  • Fix several bugs.
  • Add unsupported game version warning.
  • Add a setting to disable translation patching while translations are being loaded as usual.

0.6.4

  • Add LineHeightOffset property for FontAssetProperties.
  • Add a setting to fix disappearance of high score text on end screen when applying fallback font assets.
  • Raise patch priorities of FontPatch and FontAssetPatch in an attempt to prevent font/text displaying issues.
  • Fix backplate width of file name on QuietOS.
  • Fix duplicate of document TextAsset when untranslated on QuietOS.
  • Fix an error when creating TemplateTranslations with null (empty) translation.
  • Fix module deserialization issues.

0.6.3

  • Initial release