This is a read-only mirror of https://gitea.it/1414codeforge/moonspeak. Please direct any pull-request, issue or discussion to the main repo.
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Lorenzo Cogotti 7bcb995e9d [README] Clarify and integrate documentation. 2 years ago
.gitignore [.gitignore] Add crush lib directory to .gitignore. 2 years ago
.lovedeps [crush,.lovedeps] Add crush support. 2 years ago
LICENSE [*] Initial commit. 2 years ago
README.md [README] Clarify and integrate documentation. 2 years ago
crush.lua [crush] Update crush.lua. 2 years ago
init.lua [init] handle the case in which translate() gets called with no dictionary. 2 years ago

README.md

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

  1. Clone this repository.
git clone https://git.doublefourteen.io/lua/moonspeak
  1. Move to repository root directory:
cd moonspeak
  1. 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

  1. Download the latest crush.lua file and place it in your project's root directory.

  2. Create a .lovedeps text file in your project's root with the following dependency entry:

{
    moonspeak = "https://git.doublefourteen.io/lua/moonspeak",

    -- ...more dependencies, if necessary...
}
  1. moonspeak can now be downloaded directly by crush to the project's lib directory, along with any other dependency:
lua crush.lua
  1. You may now use moonspeak in your project by require()-ing it.
local moonspeak = require 'lib.moonspeak'
  1. Any project depending on yours may now fetch your project's dependencies (including moonspeak) automatically using crush, 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.