To do

• Rewrite this README properly, its very work in progress...
• I think the way in which saves work currently does not seem to work on windows (works on linux though - have not got the means to test on mac)
• Some kind of story or multi speaker dialogue mode? -> for now I have gone with an ordered/random mode - I feel like this might do the job? Sequential convos...
• I want to add a dark mode at some point.

PhraseWeaver

Love2D language learning game, translate sentences using a bank of words.

Note

• Currently I am taking a break BACK!!!! - I intend to ship this only with French stuff
• Other language packs I make will be put here: https://github.com/stevnw/PhraseWeaver-Language-Packs/

I have made it so that it is quite easy to add data, and it should have the featureset required to easily add languages with different scripts or language specific phonetic readings

Essentially just add a line like this to languages.text - the first one on this list is what yours will default to when the program is run

French=lang/fr_lessons.txt 

Then you need to have a text file named whatever you have set in the languages.txt - this will be where you put the lessons i.e. fr_lessons.txt

  Basics=lang/fr_lessons/basics.tsv
  About You=lang/fr_lessons/about_you.tsv
  Food=lang/fr_lessons/food.tsv

You can either put it in Ordered or Random mode using R and O, Random is the assumed default so;

  Basics=lang/fr_lessons/basics.tsv	# Random as assumed default
  About You=lang/fr_lessons/about_you.tsv,R # Random, lessons contents will be random
  Food=lang/fr_lessons/food.tsv,O # Ordered, lessons contents will be in the orderer of the .tsv

Then these call the tsvs located in fr_lessons, these tsvs are in the format of:

	phrase {tab} meaning {tab} reading (i.e. Kana for Japanese, just leave blank if not needed) {tab} audio_path

i.e.

  ça va bien	things are going well		lang/fr_lessons/audio/ça_va_bien.mp3
  merci	thank you		lang/fr_lessons/audio/merci.mp3

You will need the folder names, or it will not be able to find them

Change language with the drop down in the top right

It saves your progress and marks lessons with a score - this determines the boxes colour on the main menu -> hit reset in the bottom to clear this but it saves in:

~/.local/share/love$

Audio is generated using gTTS python library - there is a script in /res/ which I used to generate the audio. You may need to change some of the code - these bits have comments next to them. To run this code from the PhraseWeaver directory;

python res/gen.py lang/fr_lessons/basics1.tsv

Just replace basics1.tsv with whatever your tsv is.

This will generate the audio and update the tsv to include audio paths.