com.crowdin.unity-plugin/README.md

Translate & localize your games to reach new markets. Integrate Crowdin + Unity Localization package to translate content within your tables (strings and assets) and download translations into Unity. With Crowdin, you can invite your community to translat

# Crowdin Unity plugin

![Downloads](https://img.shields.io/npm/dt/com.crowdin.unity-plugin)

Translate & localize your games to reach new markets. Integrate Crowdin + Unity Localization package to translate content within your tables (strings and assets) and download translations into Unity. With Crowdin, you can invite your community to [translate Unity games](https://store.crowdin.com/unity) or hire a translation agency, provide translators with context, speed up the translation process, and more.

Visit our blog and learn more about [Unity localization](https://blog.crowdin.com/2022/04/27/unity-game-localization-with-crowdin/) with Crowdin Plugin.

## Dependencies

[Unity Localization package](https://docs.unity3d.com/Packages/com.unity.localization@1.2/manual/index.html) installed with translations hosted in the **localization tables**.

## Installation

1. Open your Unity project and click the *Window* menu > *Package Manager*
2. Click the *gear* button > *Advanced Project Settings*
3. Create a scoped registry with the following data:
  - Name - `Crowdin registry`
  - URL - `https://registry.npmjs.org`
  - Scope(s) - `com.crowdin`
4. Click *Apply*
5. In the *Package Manager* select the *My Registries* option
6. Select *Crowdin* and click the *install* button at the right bottom of the window.

## Usage

### Connect to Crowdin

1. Open *Tools* > *Crowdin* > *Connect to Crowdin*
2. Provide your Personal Access Token

   To generate a new token in Crowdin, follow these steps:
   - Go to *Account Settings* > *API* tab, *Personal Access Tokens* section, and click *New Token*.
   - Specify *Token Name* and click *Create*.

3. Click *Connect* button
4. Select the project you’d like to work with from the dropdown list
5. Close this window

### Push localization content to Crowdin, Pull translated content

Crowdin Unity plugin allows you to push strings and assets tables to Crowdin.

All the options are available in the *Tools* > *Crowdin* menu

| Action                              | Description                                                                                      |
|-------------------------------------|--------------------------------------------------------------------------------------------------|
| Push strings to Crowdin             | Send all the Strings Localization tables to Crowdin                                              |
| Push assets to Crowdin              | Send all the Assets Localization tables to Crowdin                                               |
| Push string translations to Crowdin | Send existing translations from Strings Localization tables to Crowdin                           |
| Push assets translations to Crowdin | Send existing translations from Assets Localization tables to Crowdin                            |
| Pull string translations to Crowdin | Download latest translations from Crowdin Project and fill Strings Localization tables with them |
| Pull assets translations to Crowdin | Download latest translations from Crowdin Project and fill Assets Localization tables with them  |

### Take Screenshot

Crowdin Unity plugin allows sending the Game Camera Screenshots to Crowdin project to provide better context for translators.