Word Lists Qt

From GCompris
Revision as of 13:53, 11 February 2021 by Animtim (talk | contribs) (Simple Letters (Typing letters) level design)
Jump to: navigation, search

Activities that use Word Lists

Some activities requires a word dataset for your locale. It it managed through an individual json file per locale.

There are several activities that use the Word List format:

We will first explain how the file format works, then take you through the level design.


A word list is json based and looks like this:

   "levels" : [
         "sublevels" : "5",
         "level" : "1",
         "words" : [
         "sublevels" : "5",
         "level" : "2",
         "words" : [
   "name" : "default-fr",
   "locale" : "fr",
   "description" : "French"

And this is what the tags mean:

    • name: this is identical to the file name (withouth the .json at the end)
    • description: Add the name of your language here
    • locale: This needs to be the ISO code for your locale (same as the name of the .po-file)
  • levels: The data list for all levels
  • level: Create an entry for each new level. The level number starts at 1. You can have as many levels as you want, but make sure you don't miss a number!
    • sublevels: How many words will have to be typed correctly in order to solve the level. If not provided all words will be proposed in the game one by one but randomly.

Simple Letters (Typing letters) level design

This game drops letters on the screen that the child has to type before the reach the ground. So, what you will provide here is the alphabet of your language rather than whole words. However, we use the Word List format for this, because it lets you control which letters to teach at which level, according to the needs of your language. Also, you can use multigraphs (sounds that consist of more than one letter, for example sh in English or sch in German for the sound /ʃ/):

The file is located in src/activities/gletters/resource/default-XX.json.

Where XX is your target locale. You can pick the file from our git repository to get an up to date example.

Wordsgame (Typing words)

Here are some level design suggestions for you. Of course, you can do as best fits your language!

The word list file for your locale is named src/activities/wordsgame/resource/default-XX.json.

Where XX is your target locale. You can pick the file from our git repository to get an up to date example.

All words must be chosen to be simple in your language; don't necessary translate the English. Also, it is important to put easy to enter words in the first levels (no alt gr stuff or compose key).

In order to be useful, each word list must contain about 1000 words. If you can, pick the words from a school children's book or wiktionary.

This is a typing game. If your language has letters that require more keystrokes than simple letters, it is best to keep these letters out of the lower levels. Create a level higher up that will introduce them with some shorter words, then start to mix. Keep the words with complicated letters in them shorter than the other words, and keep in mind that they also require more thinking, not just more keystrokes! The number of levels is flexible, so if there are complicated letters to learn, you can create as many levels as you need to introduce them.

Example for word length if some letters are complicated to type:
Level Word Length
1 2 - 3 simple letters
2 = 4 simple letters
3 = 5 simple letters
4 = 6 simple letters
5 2 - 3 accented letters
6 = 4 - 5 accented letters
7 = 7 - 14 simple letters, 5 - 10 accented letters