Skip to content

Latest commit

 

History

History
100 lines (70 loc) · 4.74 KB

README.md

File metadata and controls

100 lines (70 loc) · 4.74 KB
Raw

VocabLove

GNOME Shell extension to learn and practice vocabulary. Gets the words from a local .csv file in word_sources/ folder and displays the words with meaning repeatedly until the script gets executed again to get new set of words. Click on the words to hear their pronunciation.

Since Argos does not allow to select particular method from the script to execute from the shell, so you will see random words(default 10) at a time from a language level(A1.1, A1.2, ... B2.2)

Number of words

  • A1.1 (586)
  • A1.2 (533)
  • A2.1 (479)
  • A2.2 (563)
  • B1.1 (578)
  • B1.2 (415)
  • B2.1 (845)
  • B2.2 (897)

The script gets executed automatically every 3 hours. You can refresh the words list manually if you know/learned them all or for whatever reason. Every time you refresh the word list, the language level also gets refreshed. That mean you can learn words from different levels in parallel.

How to Install and Use?

Dependencies:

Installation:

It's fairly simple to install this extension. After installing Argos, and cloning this repo

# install espeak-ng with
sudo apt install espeak-ng
# copy the python script to ~/.config/argos/ and and make it executable
cp vocablove.c.3h.py ~/.config/argos/ && chmod +x ~/.config/argos/vocablove.c.3h.py
# copy word_sources/ to ~/.config/argos
cp -r word_sources/ ~/.config/argos/
# copy word_to_speech to ~/bin/ and make it executable
cp word_to_speech ~/bin/ && chmod +x ~/bin/word_to_speech

File name follows the Argos recommended filename format if you want to change it.

NAME.POSITION.INTERVAL[+].EXTENSION

Once the script is executable, you should be able to see the words on the top panel.

How to make changes?

  • By default, the word changes every 3 seconds. I think this is too fast, especially when it's a new word. You can change the interval easily, by just changing it in the source code of Argos. Go to the argos@pew.worldwidemann.com/buttons.js file in argos and change the seconds from 3 to 7 (recommend) or more in line 151 this._cycleTimeout = Mainloop.timeout_add_seconds(3, Lang.bind(this, function().
  • Available positions: l | c | r. You can change the position by changing the file name.
  • Depending on your speed of learning and the amount of time you spend on screen, you can change the frequency of script execution. Available intervals: number+s | h | d | y .You can change the frequency of script execution by changing the file name accordingly. Ex: vocablove.c.2d.py... means the word list gets refreshed every 2 days.
  • Play around with espeak-ng settings in word_to_speech script to adjust the speech

Extension Screenshot

Sample ouut

Troubleshooting

If you just see vocablove.c.3h.py... instead of some words in the top panel, restarting the GNOME shell by Alt+F2 and then type r usually solves the problem. If the problem persists, you probably have to do your own diagnostics.

hint: Check if you have installed a working copy of Argos or not.

Contributing

If you would like improve the extension is any way, feel free to open an issue. I'm always open to new ideas. I did not use an OCR engine and some automated script to create the .csv files for words. I manually entered/copy-pasted(it was a good practice) the words so there could be some mistakes in the words. Feel free to open an Issue first and then a PR if you want to contribute.

The words are in the following format in the .csv file. Plural if it's a noun.

Word/Plural: Meaning

To Do

  • Improve word pronunciations
  • Add option to select between language levels
  • Add words for C1, C2
  • Reduce the speed of change directly from extension
  • Add more languages
  • Add option to select between languages
  • Deprecate the methods related to online words to use only local words
  • Option to refresh word list
  • Add multiple sources to get the random words (online, local files)
  • Add check box for learned words and save them to a local text file
  • Save words to a local text file
  • Increase/Decrease number of words

Thanks to

Go UP⬆️