mLearn

This repo contains the source code for the desktop app mLearn.

Overview

Supercharge your language learning journey by watching native content

mLearn is an all-in-one immersion app that integrates well with Anki.

Screenshots

Features

# More info Additional information can be found on [mLearn](https://mlearn.morisinc.net).

Dependencies

• Electron.js
• JQuery.js
• HLS.js

FAQ

Which languages are supported?

mLearn ships with complete German and Japanese support. You can add your own languages too by following the guide on the GitHub page.

Can the app work offline?

For now, Offline-mode is restricted to Japanese because no free open-source German dictionary was available at the time of writing this.

Can the app work without Anki?

Yes, you'll just have to disable it by opening the settings menu.

Which platforms are supported?

macOS on Apple Silicon, macOS on x86, Linux on x86, Windows on x86

Is it free?

Since we wanted to make education free, mLearn is absolutely free forever and opensource.

mLearn crashes even if I have opened Anki

If you have restarted the app recently, it may have not closed properly; open your task manager and kill the process named 'python3'.

How do I stream a video?

By pasting a link to a streaming playlist (e.g. ending in .m3u8 or .mp4 or other video streaming formats), mLearn will automatically start playing that video.

How do I find the stream link of a video?

To find the URL of a stream, download the CocoCut video downloader Google Chrome extension, then go to the website you want to stream from. CocoCut is going to list you streaming links ending in .m3u8. You can copy and paste them into mLearn.

I opened Anki, but mLearn cannot see that I have opened it

Install the AnkiConnect plugin.

Why does the Japanese version of the app use so much RAM?

Since the Japanese version of mLearn doesn't send requests over the internet for each word definition, it has to load a HUGE dictionary into the computer's RAM for faster word access (which makes it use less power).

How do I add subtitles to a video?

Just drag'n'drop them onto the mLearn video player.

I found a bug!

Please open a GitHub issue.

How to add your own language

The language install URL needs to have the following code (mLearn will parse the contents of it):

{
  "json": {...},
  "lang_py": "https://.../../.py",
  "lang": "LANGUAGE_NAME"
}

For example, for Japanese it would be:

{
  "json": {
    "name": "Japanese",
    "translatable": [
      "名詞",
      "動詞",
      "形状詞",
      "副詞",
      "副詞節",
      "形容詞"
    ],
    "name_translated": "日本語",
    "colour_codes": {
      "名詞": "#ebccfd",
      "動詞": "#d6cefd",
      "助詞": "#f5d7b8",
      "助動詞": "#ffefd1",
      "形状詞": "#def6ff",
      "副詞": "#b8cdf5",
      "接尾辞": "#aac8c4",
      "感動詞": "#eacbcb",
      "代名詞": "#f1ccfd",
      "補助記号": "#cccccccc",
      "連体詞": "#def6ff",
      "形容詞": "#def6ff",
      "形容動詞": "#def6ff"
    },
    "fixed_settings": {}
  },
  "lang_py": "URL THAT POINTS TO THE SOURCE CODE OF JA.PY",
  "lang": "ja"
}

The python file must have the following functions:

• LANGUAGE_TOKENIZE(text): This gets raw text and returns a tokenized version of the text. Each token has 3 fields: "word", which is the word in the same form as it is in the text, "actual_word", its original dictionary form, and "type" which is the grammatical type of the word. For example, LANGUAGE_TOKENIZE("僕はテープを買ってきた")　would return

      [
        {"word": "僕", "actual_word": "僕", "type": "代名詞"},
        {"word": "は", "actual_word": "は", "type": "助詞"},
        {"word": "テープ", "actual_word": "テープ", "type": "名詞"},
        {"word": "を", "actual_word": "を", "type": "助詞"},
        {"word": "買っ", "actual_word": "買う", "type": "動詞"},
        {"word": "て", "actual_word": "て", "type": "助詞"},
        {"word": "き", "actual_word": "くる", "type": "動詞"},
        {"word": "た", "actual_word": "た", "type": "助動詞"}
    ]

• LOAD_MODULE(folder), which is called when the module is loaded, where folder is the resources folder of the app. This is mainly used to cache dictionaries
• LANGUAGE_TRANSLATE(word) returns {"data": [{'reading':'','definitions':''},{'reading': '', 'definitions': ''},{'reading':'','definitions':''},{'reading': '', 'definitions': ''},...]} that contain the definitions of the word.

Examples of such files can be found in the "languages" directory.

License

Additional licenses for libraries may be found in the "Settings → about" section of the app.

mLearn - Supercharge your language learning by immersing yourself in the language you want to learn.

Copyright (C) 2024 Adrian Vlasov

This program is free software:
you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation,
either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program.
If not, see https://www.gnu.org/licenses/.