Getting Started

Installation

1. Before installing the system itself, it is necessary to install UniTask - a tool for multithreading and asynchronous operations in Unity. UPM will not be able to install this dependency automatically.

2. After UniTask has been installed via UPM, the package itself should be installed using the git URL: https://github.com/DaniilDGG/DGG-Localization.git.

Package Installation Process via UPM:

Configuration

Once the package installation is complete, you can proceed to the configuration.

The first step is to specify the languages used in the localization file:

Along with this, after opening the window, if no loader is able to detect the localization files, a LocalizationProfile will be automatically created in Resources and an empty localization file will be created in StreamingAssets. By default, this file is named localization.loc.

After changing the path, you need to click Apply. The path is relative to the StreamingAssets folder. If the file is not found at the specified path, it will be automatically created.

You can create additional LocalizationProfiles to split the localization into multiple files if needed.

Important! The system will not detect the LocalizationProfile if it is placed outside the Resources folder.

System is working!

Once you have created the necessary localization files and configured the required languages, the system is fully operational.

Use the localization window to define key-localization pairs.

After that, you can place the built-in components to localize your text components, or, if necessary, write your own implementations.

In addition, it is not necessary to go to the top menu each time to open the localization window. Simply click on "Open Localization", and the window will open immediately with the localization key specified in the component.