first commit

1 files changed, 96 insertions, 0 deletions

diff --git a/README.txt b/README.txt
new file mode 100644
index 0000000..6677ccd
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,96 @@
+
+Internationalization Lib for Minetest
+By Diego Martínez (a.k.a. "Kaeza").
+Released as WTFPL.
+
+This mod is an attempt at providing internationalization support for mods
+(something Minetest currently lacks).
+
+How do I use it?
+In order to enable it for your mod, copy the following code snippet and paste
+it at the beginning of your source file(s):
+
+  -- Boilerplate to support localized strings if intllib mod is installed.
+  local S
+  if (minetest.get_modpath("intllib")) then
+    dofile(minetest.get_modpath("intllib").."/intllib.lua")
+    S = intllib.Getter(minetest.get_current_modname())
+  else
+    S = function ( s ) return s end
+  end
+
+Note that by using this snippet, you don't need to depend on `intllib'. In
+fact, the mod's `init.lua' is a no-op; you need to explicitly execute intllib's
+`intllib.lua' file.
+Also note that if the intllib "mod" is not installed, the S() function is
+defined so it returns the string unchanged. This is done so you don't have to
+sprinkle tons of `if's (or similar constructs) to check if the lib is actually
+installed.
+
+Next, for each "translatable" string in your sources, use the S() function
+(defined in the snippet) to return the translated string. For example:
+
+  minetest.register_node("mymod:mynode", {
+    description = S("My Fabulous Node"),
+    <...>
+  })
+
+Then, you create a `locale' directory inside your mod directory, with files
+named after the two-letter ISO Language Code of the languages you want to
+support. Here's an example for a Spanish locale file (`es.txt'):
+
+  # Lines beginning with a pound sign are comments and are effectively ignored
+  # by the reader. Note that comments only span until the end of the line;
+  # there's no support for multiline comments.
+  Blank lines not containing an equals sign are also ignored.
+  Hello, World! = Hola, Mundo!
+  String with\nnewlines and \ttabs = Cadena con\nsaltos de linea y\ttabuladores
+  String with an \= equals sign = Cadena con un signo de \= igualdad
+
+Since there's currently no portable way to detect the language, this library
+tries several alternatives, and uses the first one found:
+  - `language' setting in `minetest.conf'
+  - `LANG' environment variable (this is always set on Unix-like OSes).
+  - Default of "en".
+Note that in any case only up to the first two characters are used, so for
+example, the settings "de_DE.UTF-8", "de_DE", and "de" are all equal.
+Windows users have no `LANG' environment variable by default. To add it, do
+the following:
+  - Click Start->Settings->Control Panel.
+  - Start the "System" applet.
+  - Click on the "Advanced" tab.
+  - Click on the "Environment variables" button
+  - Click "New".
+  - Type "LANG" (without quotes) as name and the language code as value.
+  - Click OK until all dialogs are closed.
+Alternatively for all platforms, if you don't want to modify system settings,
+you may add the following line to your `minetest.conf' file:
+  language = <language code>
+
+Also note that there are some problems with using accented, and in general
+non-latin characters in strings. Until a fix is found, please limit yourself
+to using only US-ASCII characters.
+
+Frequently Asked Questions
+--------------------------
+Q: Were you bored when you did this?
+A: Yes.
+
+Q: Why are my texts are not translated?
+A: RTFM...or ask in the topic 8-----)
+
+Q: How come the README is bigger than the actual code?
+A: Because I'm adding silly unfunny questions here...and because there are
+   some users that are too lazy to understand how the code works, so I have
+   to document things.
+
+Q: I don't like this sh*t!
+A: That's not a question.
+
+Thanks for reading up to this point.
+Should you have any comments/suggestions, please post them in the forum topic.
+
+Let there be translated texts! :P
+--
+Yours Truly,
+Kaeza