Skip to content

divin/kanji-match

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

63 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

Kanji Match ๐ŸŽดโœจ

Kanji Match is an educational game designed to help you master visually similar Japanese kanji. By focusing on kanji that are often confused due to their appearance, the game helps reinforce subtle distinctions and deepen your recognition skills. Kanji Match uses the WaniKani API to fetch your personalized kanji data, so an active WaniKani subscription is required.

โœจ Features

  • ๐Ÿ‰ Focus on Visually Similar Kanji: Practice distinguishing kanji that look alike, reducing common mistakes in reading and writing.
  • ๐Ÿ”— WaniKani Integration: Connects to your WaniKani account to use your current kanji progress and review schedule.
  • โฐ Spaced Repetition System (SRS): Review kanji in groups based on when they are due for optimal memory retention.
  • ๐Ÿ€„ Matching Gameplay: Match kanji characters with their correct meanings.
  • ๐Ÿ“Š Session Tracking: Detailed statistics including correct/incorrect matches, streaks, session time, and more.
  • ๐Ÿ”ฅ Streak System: Get rewarded for consecutive correct answers with increasing audio pitch and visual feedback.
  • ๐Ÿ Session Overview: At the end of each session (or if you exit early), see a summary of your performance.
  • ๐Ÿ”Š Audio-Visual Feedback: Enjoy sound effects and confetti for correct answers and streaks.

๐Ÿ“ Requirements

  • WaniKani Subscription: You must have an active WaniKani account and API key to use this game.
  • Lร–VE (Love2D): Only required if you want to run the game from source or for development. Pre-built binaries are available for end users.

Note: Kanji Match was written using Lร–VE2D 12, but should be compatible with Lร–VE2D 11.x as well.

๐ŸŽฎ How to Play

  1. Connect to WaniKani: Enter your WaniKani API key when prompted.
  2. Start a Review Session: The game will present you with groups of visually similar kanji that are due for review.
  3. Match Cards: Click on cards to match each kanji with its correct meaning.
  4. Track Your Progress: Watch your streak and stats update as you play.
  5. Complete or Exit: Finish all groups to complete the session, or exit early at any time. Your progress will be saved and summarized.

๐Ÿ•น๏ธ Controls

  • Mouse: Click cards to select and match them.
  • Exit Button: Click the exit button in the corner to end your session early.
  • Keyboard (Overview Screen): Press SPACE, ENTER, or click anywhere to return to the main menu after a session.

๐Ÿ“ˆ Stats Tracked

  • Groups Completed
  • Total Kanji Reviewed
  • Correct Matches
  • Incorrect Matches
  • Accuracy Percentage
  • Best Streak
  • Session Time

๐Ÿš€ Download & Running the Game

You can download pre-built binaries for Linux, macOS, and Windows from the following pages:

  • GitHub Releases: Always get the latest version here.

    • Windows: Download the .exe installer or the .zip portable version.
    • macOS: Download the .app.zip for a drag-and-drop app, or .dmg for disk image install.
    • Linux: Download the .AppImage for a single-file app, or .tar.gz for manual extraction.
    • All Platforms (advanced/source): Download the .love file to run with Lร–VE2D, or the source code archives.
  • itch.io Page: Alternative download and community page.

Simply download the appropriate file for your platform and run itโ€”no additional installation required.

macOS Users:
This app is not code-signed. After the initial start, you may need to allow the app to run via System Settings โ†’ Privacy & Security. If you see a warning that the app cannot be opened because it is from an unidentified developer, open System Settings, scroll to the bottom of the Privacy & Security pane, and click "Allow Anyway" next to the Kanji Match app. Then try launching the app again. This is required because the app is unsigned.

If you prefer to run from source:

  1. Install Lร–VE.
  2. Clone this repository.
  3. Run the game with:
    love .

๐Ÿ› ๏ธ Development

If you want to contribute or modify the game:

  1. Make sure you have Lร–VE and Lua installed.
  2. Clone this repository.
  3. All source code is in the src/ directory.
  4. You can run the game directly with:
    love .
  5. To package your own binaries, follow the Lร–VE distribution instructions.

๐Ÿ“„ License

MIT License. See LICENSE for details.


Enjoy mastering visually similar kanji with Kanji Match!