Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/3d-group/unity-simple-localization

Simple localization package for Unity game engine
https://github.com/3d-group/unity-simple-localization

hacktoberfest localization npm unity unity3d upm-package utilities

Last synced: 29 days ago
JSON representation

Simple localization package for Unity game engine

Host: GitHub
URL: https://github.com/3d-group/unity-simple-localization
Owner: 3d-group
License: mit
Created: 2020-10-11T20:04:52.000Z (about 4 years ago)
Default Branch: main
Last Pushed: 2024-02-21T04:08:11.000Z (9 months ago)
Last Synced: 2024-09-28T23:59:07.553Z (about 1 month ago)
Topics: hacktoberfest, localization, npm, unity, unity3d, upm-package, utilities
Language: C#
Homepage:
Size: 106 KB
Stars: 4
Watchers: 2
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        [![npm package](https://img.shields.io/npm/v/com.3d-group.unity-simple-localization)](https://www.npmjs.com/package/com.3d-group.unity-simple-localization)

[![openupm](https://img.shields.io/npm/v/com.3d-group.unity-simple-localization?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.3d-group.unity-simple-localization/)

[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)

# Localization

Simple localization package for Unity game engine.

- [How to use](#how-to-use)

- [Install](#install)

  - [via npm](#via-npm)

  - [via OpenUPM](#via-openupm)

  - [via Git URL](#via-git-url)

  - [Tests](#tests)

- [Configuration](#configuration)

## How to use

Create localization singleton

![inspector_create_png](Documentation~/images/inspector_create.PNG)

Add translations (json files as TextAssets)

![inspector_create_png](Documentation~/images/inspector_config.PNG)

Use from scripts with

```c#

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:

![inspector_create_png](Documentation~/images/inspector_create_text.PNG)

## Install

### via npm

Open `Packages/manifest.json` with your favorite text editor. Add a [scoped registry](https://docs.unity3d.com/Manual/upm-scoped.html) and following line to dependencies block:

```json

{

  "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](https://openupm.com/packages/com.3d-group.unity-simple-localization). You can install it eg. via [openupm-cli](https://github.com/openupm/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:

```json

{

  "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](https://docs.unity3d.com/2017.4/Documentation/Manual/testing-editortestsrunner.html).

Open `Packages/manifest.json` with your favorite text editor. Add following line **after** the dependencies block:

```json

{

  "dependencies": {

  },

  "testables": [ "com.3d-group.unity-simple-localization" ]

}

```

## Configuration

Add translations in the inspector.

1. Add translation json files to your projects Assets folder

2. Drag resulting TextAsset files to Localization inspector field

Translation file format:

```json

{

  "TRANSLATION_KEY": "translation"

}

```

## License

MIT License

Copyright © 2020 3D Group