com.3d-group.unity-simple-localization
v1.0.0
Published
Simple localization for Unity game engine.
Downloads
10
Maintainers
Readme
Localization
Simple localization package for Unity game engine.
How to use
Create localization singleton
Add translations (json files as TextAssets)
Use from scripts with
var translation = Localization.Translate("TRANSLATION_KEY");
To add translations for existing Text / Text mesh pro UI components, add TranslateTextOnStart component
For new text components you can use editor options like this:
Install
via npm
Open Packages/manifest.json
with your favorite text editor. Add a scoped registry and following line to dependencies block:
{
"scopedRegistries": [
{
"name": "npmjs",
"url": "https://registry.npmjs.org/",
"scopes": [
"com.3d-group"
]
}
],
"dependencies": {
"com.3d-group.unity-simple-localization": "1.0.0"
}
}
Package should now appear in package manager.
via OpenUPM
The package is also available on the openupm registry. You can install it eg. via openupm-cli.
openupm add com.3d-group.unity-simple-localization
via Git URL
Open Packages/manifest.json
with your favorite text editor. Add following line to the dependencies block:
{
"dependencies": {
"com.3d-group.unity-simple-localization": "https://github.com/3d-group/unity-simple-localization.git"
}
}
Tests
The package can optionally be set as testable. In practice this means that tests in the package will be visible in the Unity Test Runner.
Open Packages/manifest.json
with your favorite text editor. Add following line after the dependencies block:
{
"dependencies": {
},
"testables": [ "com.3d-group.unity-simple-localization" ]
}
Configuration
Add translations in the inspector.
- Add translation json files to your projects Assets folder
- Drag resulting TextAsset files to Localization inspector field
Translation file format:
{
"TRANSLATION_KEY": "translation"
}
License
MIT License
Copyright © 2020 3D Group