Sallys_Workshop-Localyssation icon

Localyssation

**Originally by TheMysticSword** Localization mod for players and translators. Need language patch to work. Check main page for detail.

Last updated 5 days ago
Total downloads 1081
Total rating 5 
Categories Mods
Dependency string Sallys_Workshop-Localyssation-2.2.2
Dependants 8 other packages depend on this package

This mod requires the following mods to function

BepInEx-BepInExPack-5.4.2100 icon
BepInEx-BepInExPack

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

Preferred version: 5.4.2100
Nessie-EasySettings-1.1.8 icon
Nessie-EasySettings

A mod API for easily adding options to the settings menu.

Preferred version: 1.1.8

README

Localyssation

Version Downloads

A work-in-progress localization library mod for ATLYSS. Check Github page for newest update.

Requirements

  • BepInEx 5.4
  • EasySettings 1.1.8+

:warning: Important note :warning:

This mod REQUIRES a translation patch of your language to show in-game translation, it is NOT intended to include translations on its own, while translators can make translation patches with this mod (see below).

Currently listed translation patch(es):

Language Author Patch Link
简体中文 莎莉工作室(Sallys's Workshop) Github [Thunder Store]
繁體中文 jasonpepe LocalyssationZHTW
Español Alhenix LocalyssationESLA
한국어 KR_Kemonoz AtlyssKr
Brasileiro Guachenim Thunder Store

How to use

  1. Install BepInEx.
  2. Install EasySettings and Localyssation.
  3. Put a translation patch inside the plugins folder.

Current features

  • Add Localyssation options in the mods tab of settings (Install EasySettings if missing).
    • Where you can change languages or fonts (unifont by default).
  • Show correct texts in chat box and chat bubbles, if the words can be found in font bundle you use.
  • Load translation patches found in the BepInEx plugins folder.
    • A patch consists of the following things:
      • localyssationLanguage.json with information about the language.
      • strings.yml with text keys and corresponding translated text.
      • A folder to keep them together.
    • Including translation for mods (if the modder provides).
  • Useful features for translators' convenience.
    • Exporting original strings.yml to begin with.
    • Generate .md files for items and quests by detail inside the mod folder.
      • ScriptableItem.md: icons, translation keys and names
      • ScriptableQuest.md: givers, translation keys, types, subtypes, and names
    • Option to show KEY of empty translations in game.
    • Reload strings with hot key in game.

Report a bug / missing translation

Use issue feature on GitHub please. Create an Issue

For translators or mod creaters

Feel free to create your own translation patch for your language. Send issues to let me put your patch link in this README.

Go to this wiki page for guidance of installing the mod and creating your own language translation patch, as well as making your own Font Bundles (make sure using profitable & embeddable fonts to avoid potential legal issues).

Localyssation supports mod translation after 2.0.0, check this wiki page for more information.

Also, this mod can't help with the texts inside pictures. Try texture swapping if you'd like to translate them.

Credit

Originally created by TheMysticSword, then forked and maintained by TowardtheStars as part of the CHS translation project held by team Sally's Workshop(莎莉小店).