intllib/README.md

52 lines
1.6 KiB
Markdown
Raw Permalink Normal View History

2013-02-27 07:27:51 +01:00
2016-05-08 21:48:32 +02:00
# Internationalization Lib for Minetest
2020-03-09 16:50:22 +01:00
## DEPRECATED - Use Minetest's new translation API instead!
2020-03-09 16:48:28 +01:00
You should not use this mod when writing new mods, and you should update mods to no longer depend on this mod.
Minetest 5.0 has builtin support for client-side translation, accessed by `minetest.get_translator()`
## Aboud
2016-05-08 21:48:32 +02:00
By Diego Martínez (kaeza).
Released under Unlicense. See `LICENSE.md` for details.
2013-02-27 07:27:51 +01:00
This mod is an attempt at providing internationalization support for mods
(something Minetest currently lacks).
Should you have any comments/suggestions, please post them in the
[forum topic][topic]. For bug reports, use the [bug tracker][bugtracker]
on Github.
2013-02-27 07:27:51 +01:00
## How to use
2016-05-08 21:48:32 +02:00
If you are a regular player looking for translated texts, just
[install][installing_mods] this mod like any other one, then enable it
in the GUI.
2016-05-08 21:48:32 +02:00
The mod tries to detect your language, but since there's currently no
portable way to do this, it tries several alternatives:
2016-05-08 21:48:32 +02:00
* `language` setting in `minetest.conf`.
* `LANGUAGE` environment variable.
* `LANG` environment variable.
* If all else fails, uses `en`.
2016-05-08 21:48:32 +02:00
In any case, the end result should be the [ISO 639-1 Language Code][ISO639-1]
of the desired language.
2016-05-08 21:48:32 +02:00
### Mod developers
2013-02-27 07:27:51 +01:00
If you are a mod developer looking to add internationalization support to
your mod, see `doc/developer.md`.
2013-02-27 07:27:51 +01:00
### Translators
If you are a translator, see `doc/translator.md`.
[topic]: https://forum.minetest.net/viewtopic.php?id=4929
[bugtracker]: https://github.com/minetest-mods/intllib/issues
[installing_mods]: https://wiki.minetest.net/Installing_mods
[ISO639-1]: https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes