https://github.com/OnfireNetwork/i18n
Internationalization framework for onset packages
https://github.com/OnfireNetwork/i18n
internationalization languages lua onset
Last synced: about 1 month ago
JSON representation
Internationalization framework for onset packages
- Host: GitHub
- URL: https://github.com/OnfireNetwork/i18n
- Owner: OnfireNetwork
- License: apache-2.0
- Created: 2019-11-02T14:12:44.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-01-29T14:04:43.000Z (over 5 years ago)
- Last Synced: 2024-11-12T15:43:19.325Z (7 months ago)
- Topics: internationalization, languages, lua, onset
- Language: Lua
- Size: 19.5 KB
- Stars: 8
- Watchers: 3
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-onset - i18n - Internationalization framework for onset packages. (Packages and Plugins / Libraries)
README
# i18n
Internationalization framework for onset packages
## Example
packages/your_package/i18n/en.json
```json
{
"player_join": "{1} joined the server!",
"player_quit": "{1} left the server!"
}
```
packages/your_package/script.lua
```lua
local _ = function(k,...) return ImportPackage("i18n").t(GetPackageName(),k,...) end
AddEvent("OnPlayerJoin", function(player)
AddPlayerChatAll(_("player_join", GetPlayerName(player)))
end)
AddEvent("OnPlayerQuit", function(player)
AddPlayerChatAll(_("player_quit", GetPlayerName(player)))
end)
```
## Config
By default it uses "en" as language. To select another language for your server you have to create a config.
i18n.json
```json
{
"language": "de"
}
```
In case the server language doesn't exist for a package it falls back to en.
Per player translations aren't implemented yet but i might implement it in the future if s.b. needs this feature.
## Events
On the client-side it takes a moment to download the translations.
Once the translations are ready the event `OnTranslationReady` is fired. (on the server-side with the player as param)