potcreator

Translations made "easier".

This tool can create *.pot files¹ from different sources. So far 2 are implemented: GDScript and SQLite.

It is configurable with a simple JSON file.

Even that it started out to go together with Godot projects, it can also be used outside of such a context.

Info: This repository is in maintenance mode. I do not work actively on it, but if you create issues or Pull Requests, I will take a look. Time-wise that might vary though.

How to build

Requirements: nim and nimble installed

Windows

Go in the terminal to this project directory and call ./build.bat.

Linux / OSX

Go in the terminal to this project directory and call ./build.sh.

How to configure

The JSON file has to be called .potcreator.json and the base looks like this:

{
  "output" : "/template.pot",
  "displaySrc" : true,
  "modules" : [
  ]
}

output defines where the pot file shall later go to. The base path is always the folder path to the configuration file.

displaySrc defines if it shall add comments into the pot file with where the string comes from.

GDScript

The module will walk through any given path and check *.gd files for tr(""). Everything between the quotes will be counted as a translation key.

{
  "output" : "/template.pot",
  "displaySrc" : true,
  "modules" : [
    {
      "name" : "gdscript",
      "data" : {
        "paths" : ["/scripts"]
      }
    }
  ]
}

Simply put into paths an array of paths where the tool shall look for translation keys.

SQLite

Databases are a little bit more complex, but this should still be as straightforward as possible.

{
  "output" : "/template.pot",
  "displaySrc" : true,
  "modules" : [
    {
      "name": "sqlite",
      "data" : {
        "dbs" : [
          {
            "path" : "/data.db",
            "tables" : [
              {
                "tablename" : "examples",
                "columns" : ["name"]
              }
            ]
          }
        ]
      }
    }
  ]
}

Every database file gets its own object inside the dbs array. You have to define the path to the database file and the tables, that it shall take a look into.

It will make a SELECT on all given table columns and expects them to be TEXT aka translation keys.

How to run

Call potcreator from your terminal and provide it the path to the directory in which it can find the .potcreator.json file. For example: potcreator path/to/my/folder.

There are some minor flags that you can turn on. More info on those you can get, if you call the tools help function: potcreator -h.

How it works

1. Collect translation keys from the sources.
2. Merge duplicates, so that every given string is only once in the *.pot file later.
3. Create the *.pot file from the collected translation keys.

Example usage

Check out the examples folder, to see some of potcreator's possibilities.

License

potcreator is available under the MIT license. For more info, check out the LICENSE file.

How to contribute

• Create a pull request:
  • Feel free to add features, bug fixes etc. directly as pull request. As long as the features fit to the goal of this tool (making it easy to generate *.pot files from different sources and merge them together), and nothing breaks, the likelihood of getting your pull request accepted is quiet high.
  • Please try to stick with the projects code style.
  • Use nimpretty after you made your changes. (nimpretty file.nim)
• Create an issue:
  • Found a bug / have a problem?
    • Give minimum information about where you are running potcreator (Windows, Linux, Mac)
    • What did you try so far? What exactly is not working?
  • Feature requests
    • As said in the beginning of this readme, I do not actively work on potcreator, but if you can't add the feature yourself, maybe someone else can, so please create an issue and describe what you would like to have and why you would like to have it.
  • Space for improvements
    • If you see something, that could be improved, feel free to create a ticket.

Footnotes

1. https://en.wikipedia.org/wiki/Gettext#Programming ↩