@quenty/clienttranslator

ClientTranslator

Gets local translator for player

View docs →

Installation

npm install @quenty/clienttranslator --save

Usage

Usage is designed to be simple.

Easy-use scenario

• Call Translate(data, "blah") on anything
• Translation is magically replicated to clients and can be saved
• Only one place needed to save the data

Adding localization files

Add files to ReplicatedStorage/i18n. Files will be in string values, and be valid JSON. This allows lookup like this:

{
  "key": {
    "secondary": {
      "node": "My translated value"
    }
  }
}

This will generate an entry like this:

"key.secondary.node" --> My translated value

Which can be output like this:

ClientTranslator:FormatByKey("key.secondary.node") --> My translated value

All substitutions and other formats work like Roblox's does.

Pseudo-localize

There exists a pseudo-locale qlp-pls which can be to visualize pseudo-localized text. This can be used to help detect unlocalized text.

API surface

ClientTranslatorFacade:Init()

Initializes a new instance of the ClientTranslatorFacade.

ClientTranslatorFacade:FormatByKey(key, ...)

Works the same way that Roblox's ClientTranslator:FormatByKey functions. However, functions when not online, and also will utilize a pseudo-locale.