https://github.com/dubit/unity-localisation
Localisation support
https://github.com/dubit/unity-localisation
Last synced: 4 months ago
JSON representation
Localisation support
- Host: GitHub
- URL: https://github.com/dubit/unity-localisation
- Owner: dubit
- Created: 2018-06-12T09:54:23.000Z (about 8 years ago)
- Default Branch: development
- Last Pushed: 2020-01-02T11:32:32.000Z (over 6 years ago)
- Last Synced: 2025-09-05T23:50:21.928Z (10 months ago)
- Language: C#
- Size: 436 KB
- Stars: 8
- Watchers: 2
- Forks: 1
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# unity-localisation
## What is it?
A library containing classes for adding localisation support to your application.
## Requirements
* Unity 2017 or higher
* .NET 4.X or higher
* C# 6.0 or higher
## Features
* Type safe localisation key/value retrieval.
* Split translations into categories for easier organisation (via code generation)
* Easy to use out of the box components: `LocalisedText`, `LocalisedAudio`, `LocalisedImage`
* Simple API to retrieve localised values by code: `Loc.Get(Category.Key.KeyName);`
## How to use it.
Please refer to the following guides.
* [GettingStarted](./Docs/GettingStarted.md)- for info about setting up your project for localisation
* [BasicUsage](./Docs/BasicUsage.md) - covers most of the basic use cases.
* [Preferences](./Docs/Preferences.md)
## Releasing
* Use [gitflow](https://nvie.com/posts/a-successful-git-branching-model/)
* Create a release branch for the release
* On that branch, bump version number in package json file, any other business (docs/readme updates)
* Merge to master via pull request and tag the merge commit on master.
* Merge back to development.
## DUCK
This repo is part of DUCK (dubit unity component kit)
DUCK is a series of repos containing reusable component, utils, systems & tools.
DUCK packages can be added to a project as git submodules or by using [Unity Package Manager](https://docs.unity3d.com/Manual/upm-git.html).