2.2 KiB
moonspeak - LÖVE game localization library
moonspeak is a basic internationalization library for the LÖVE engine. It makes your game easy to translate to multiple languages.
moonspeak does the following:
- Loads dictionary files for your game.
- Allows selecting one of the many available languages.
- Translates messages by id (and provides default fallback to English).
Dependencies
moonspeak uses df-serialize to read the dictionary file.
You may either doenload df-serialize manually and place it inside a lib
subdirectory,
or use crush
to do this for you.
Using crush to download moonspeak dependencies
- Clone this repository.
git clone https://gitea.it/1414codeforge/moonspeak
- Move to repository root directory:
cd moonspeak
- Resolve dependencies using crush.
lua crush.lua
You should now see a lib
subdirectory containing the necessary dependencies.
Integrating moonspeak in my project using crush
-
Download the latest crush.lua file and place it in your project's root directory.
-
Create a
.lovedeps
text file in your project's root with the following dependency entry:
{
moonspeak = "https://gitea.it/1414codeforge/moonspeak",
-- ...more dependencies, if necessary...
}
moonspeak
can now be downloaded directly bycrush
to the project'slib
directory:
lua crush.lua
- Now
moonspeak
can berequire()
d in your code, like this:
local moonspeak = require 'lib.moonspeak'
- Any project depending on yours will now fetch
moonspeak
automatically when usingcrush
, following the above procedure.
Documentation
Code is documented with LDoc.
Documentation may be generated running the command:
ldoc init.lua
ldoc
outputs to a local doc
directory, open index.html
with your favorite browser to read it.
License
Zlib, See LICENSE for details.