https://github.com/tderflinger/mmm-hanzi
This is a Magic Mirror² module helping with learning Chinese Mandarin. It rotates between Chinese characters (hanzi), their pronunciation (in pinyin) and the translation in English.
https://github.com/tderflinger/mmm-hanzi
chinese hanzi hsk-vocabulary language-learning magic-mirror-modules magicmirror magicmirror2 mandarin
Last synced: 3 months ago
JSON representation
This is a Magic Mirror² module helping with learning Chinese Mandarin. It rotates between Chinese characters (hanzi), their pronunciation (in pinyin) and the translation in English.
- Host: GitHub
- URL: https://github.com/tderflinger/mmm-hanzi
- Owner: tderflinger
- License: mit
- Created: 2022-06-15T18:25:27.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-07-17T22:05:54.000Z (about 3 years ago)
- Last Synced: 2025-06-02T04:07:51.316Z (4 months ago)
- Topics: chinese, hanzi, hsk-vocabulary, language-learning, magic-mirror-modules, magicmirror, magicmirror2, mandarin
- Language: JavaScript
- Homepage:
- Size: 533 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Magic Mirror² Hanzi
This is a [`Magic Mirror²`](https://magicmirror.builders/) module that rotates between Chinese characters (hanzi), their pronunciation (in pinyin)
and the translation in English.
Every Chinese Mandarin language learner will appreciate this learning tool.
Magic Mirror² is open source software for creating a powerful dashboard mostly for home use.
`Magic Mirror² Hanzi` is based on the [Chinese Mandarin HSK](https://en.wikipedia.org/wiki/Hanyu_Shuiping_Kaoshi) test vocabulary and you can configure up to 6 levels
of difficulty.
The interval of the rotation of the characters is also configurable.
## Preview Screenshot
This is how Magic Mirror² Hanzi looks in my configuration:
## Installation
Clone this repository into your MagicMirror `modules` folder.
Example:
```
cd /home/pi/MagicMirror/modules
git clone https://github.com/tderflinger/MMM-Hanzi.git
```
Edit your configuration file under `config/config.js` with the following configuration.
```
{
module: "MMM-Hanzi",
position: "top_left",
config: {
hskLevel: 2, // up to six levels available
interval: 300000 // rotation speed in ms
},
},
```
## Config Options
| **Option** | **Description** |
| --- | --- |
| `hskLevel` | HSK difficulty level, number from 1 to 6 |
| `interval` | Rotation time of Hanzi in ms |
## Testing
I have tested the `Magic Mirror² Hanzi` module on an Raspberry Pi 3B with Raspberry OS
and Node 16.15.0 and `Magic Mirror²` version 2.19.0.
## References
Magic Mirror²: https://magicmirror.builders
HSK: https://en.wikipedia.org/wiki/Hanyu_Shuiping_Kaoshi
Source of HSK Hanzi Vocabulary Files: https://github.com/clem109/hsk-vocabulary
## License
MIT License