summaryrefslogtreecommitdiffstats
path: root/MCServer/Plugins/TransAPI/README.md
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--MCServer/Plugins/TransAPI/README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/MCServer/Plugins/TransAPI/README.md b/MCServer/Plugins/TransAPI/README.md
new file mode 100644
index 000000000..b037a6732
--- /dev/null
+++ b/MCServer/Plugins/TransAPI/README.md
@@ -0,0 +1,20 @@
+TransAPI
+========
+
+A plugin translation API for MCServer.
+
+TransAPI is designed to be used with the [client library](https://github.com/bearbin/transapi-client), however there is also a stable API available for use.
+
+API
+---
+
+ GetLanguage ( cPlayer )
+ Returns the user's preferred language (or server default if not set). (ISO 639-1 language code)
+
+ GetConsoleLanguage ( )
+ Returns the preferred language for console text. (ISO 639-1 language code)
+
+Commands
+--------
+
+ * /language [lang] - Takes a language code (ISO 639-1) and sets the user's preferred language to that. (tranapi.setlang)