Introduction

Pass HanziToAnki a file via command-line or GUI, and generate clashcards Anki/Pleco(to-do)/Memrise(to-do) flashcards.

You can generate the flashcards from any Chinese input - a news article you're studying, song lyrics, or even your exported WeChat logs!

Command-line options:

-w --word-list Read from an input file containing a list of words, separated by line breaks. Without this flag, individual characters are extracted
-s --single-characters Extract only single characters from the file
-hsk <hsk level> Remove any words in any HSK levels up to and including the given one
-t --strategy <strategy> Specify the word finding strategy. See ChineseWordFinder.Strategy enum for details
-o <output filename> Override the default output file name
-f --format <output format> Override the default output file name

Note if using Gradle, you can do:

./gradlew run --args="<whatever>"

Features:

Both simplified and traditional hanzi can be provided
English definitions provided by CC-CEDICT
Pinyin has accented characters (nĭ hăo instead of ni3 hao3)
Pinyin is coloured by HTML markup
Can ignore vocabulary below specified HSK level (reduces card count & saves time)
Fully Open-Source, so you can contribute features, create issue tickets on GitHub, or even help fix those issues!

Please feel free to make suggestions, open/comment on issues, or share code!

Development

Feel free to fork, create branches, and raise PRs.

If you get an error about "Invalid source release", check that echo $JAVA_HOME points to your JDK. We recommend sdkman for setting up Java.

To make a heroku-like local deployment, run:

./gradlew stage
heroku local web

You can either run tests with IntelliJ, or with ./gradlew test

If gradlew doesn't have permissions, run chmod +x gradlew (or chmod +x gradlew.bat on Windows) in the root of this project.

We run a few automated checks with Github Actions in our PRs. We recommend doing the following before raising a PR:

With the CheckStyle plugin, you can import the repository's google_checks.xml file. The IDE should use this for formatting checks.

This project uses a modified version of the CEDICT Chinese dictionary, which can be found here: https://cc-cedict.org/wiki/