FixItFelix-TranslationsHelper icon

TranslationsHelper

Mod made for modders to simplify generating translation files for their prefabs.

Last updated 3 months ago
Total downloads 1075
Total rating 2 
Categories Libraries Client-side Utility
Dependency string FixItFelix-TranslationsHelper-1.1.1
Dependants 0 other packages depend on this package

This mod requires the following mods to function

ValheimModding-Jotunn-2.15.2 icon
ValheimModding-Jotunn

Jötunn (/ˈjɔːtʊn/, 'giant'), the Valheim Library was created with the goal of making the lives of mod developers easier. It enables you to create mods for Valheim using an abstracted API so you can focus on the actual content creation.

Preferred version: 2.15.2
denikson-BepInExPack_Valheim-5.4.2202 icon
denikson-BepInExPack_Valheim

BepInEx pack for Valheim. Preconfigured and includes unstripped Unity DLLs.

Preferred version: 5.4.2202

README

Translations Helper

Mod for helping modders that maintain huge amounts of prefabs and want to provide translations files for those. This mod will help you pre-generate all translations files that you need to provide with your .dll in English language. Any prefabs that have a missing m_name or m_description will be printed with a String ("[token name]") that shows missing translation.

At Krumpac's Reforge mod pack we are using this mod to keep track of the 1600 added prefabs and all their translations, which would be a lot of work without automation.

Features

Load this together with your other .dlls and in-game use F5 (using -console) and type print_translations_to_file, this will generate all available (non-vanilla) prefabs into 1 file per BepInExPlugin that adds this prefab.

Valheim Types supported

Output available for in-game Valheim types:

  • ItemDrop
  • Piece
  • Character
  • Smelter
  • Fermenter
  • CookingStation
  • Incinerator
  • OfferingBowl
  • SapCollector
  • Beehive
  • HoverText

For the simpler types the mod will use the m_name and m_description fields located inside those types, the pre-generated translation String is taken from any available text that comes with the prefab or the mod that introduced it. More complex types that have additional texts or switches will also have those printed.

Filter output

You can also specify 1 argument to the console command to apply prefix filtering for the outputs:

print_translations_to_file my_mod_prefix_

This will then just output prefabs that have their internal name starting with "my_mod_prefix_" and will also just generate files for .dlls where this prefix is available.

Examples

Example file output (taken from mod Rune Magic):

File name:

BepInEx/config/TranslationsPrinterOutput/RuneMagic.English.yaml

Example content (excerpt):

RuneFocus: "Rune Focus"
RuneFocus_Description: "Use this on Runestones you discover to absorb their power and shape it to your own ends."
runemagic_BlastingRune: "Rune of Blasting"
runemagic_BlastingRune_Description: "Who needs a pickaxe when you can blast stone apart with magic?  Though, do remember to stand clear..."
runemagic_CalmWatersRune: "Rune of Calm Waters"
runemagic_CalmWatersRune_Description: "A smooth sea doesn't make a skilled sailor, but it does help keep your ship in one piece."
runemagic_CanopyRune: "Canopy Rune"
runemagic_CanopyRune_Description: "It's no warm inn with a roaring fire, but it'll keep the damp off."
runemagic_DryLandRune: "Rune of Dry Land"
runemagic_DryLandRune_Description: "Rising sea levels are no longer a concern."

Miscellaneous

Attributions
Contact