Skip to content

KAnki v1.0.0 - Universal Flashcard App for Kindle

Choose a tag to compare

@crizmo crizmo released this 11 May 18:01
· 37 commits to main since this release

KAnki Release Notes

πŸŽ‰ Major New Features

Error Review Mode

  • Immediate Error Review: Automatically tracks cards answered incorrectly during your review session
  • Review Prompt: After completing a review cycle, you'll be prompted to review incorrectly answered cards
  • Focused Learning: Helps reinforce troublesome vocabulary by letting you practice difficult cards right away
  • Progress Tracking: Clear UI indicators show when you're in error review mode
  • Mastery System: Cards are removed from the error queue once you answer them correctly

Centralized Configuration System

  • Single Configuration File: All user customizations now live in kanki/js/kanki_config.js
  • Easier Updates: Keep your configuration when updating to new KAnki versions
  • Clean Separation: Core application logic is now separate from user preferences

πŸ“ Changes

Improvements

  • Simplified Customization: Language settings and vocabulary all in one file
  • Better Structure: Improved organization of code and configuration
  • Enhanced Documentation: Updated README with detailed customization instructions
  • Cleaner UI: Improved status indicators for error review mode

File Changes

  • Added: kanki/js/kanki_config.js - New centralized configuration file
  • Modified: main.js - Updated to support error review and use centralized configuration

How to Install KAnki ( New Users )

  1. Clone this repository or download the ZIP file
  2. Connect your Kindle to a computer via USB
  3. Unzip the downloaded file (Make sure the name is KAnki)
  4. Copy the KAnki folder and the kanki.sh script to the documents folder on your Kindle
  5. Open the kanki/js/kanki_config.js file and edit the configuration to match your language.
  6. Download or convert a TTF font file that supports your target language. Rename it to language.ttf and place it in:
    kanki/assets/fonts/language.ttf
    
  7. Disconnect your Kindle from the computer
  8. Open the Kindle's home screen and run the KAnki app

πŸ”§ How to Update ( New Users ignore this )

  1. Back up your current kanki/js/vocabulary.js or kanki/js/kanki_config.js file if you have been using KAnki, ignore if you are a new user
  2. Download the new KAnki release
  3. Replace your old KAnki folder with the new one
  4. Copy your vocabulary data to the new kanki/js/kanki_config.js file
  5. Optional: Customize language settings in kanki_config.js
  6. Copy your language.ttf font file to the new kanki/assets/fonts/language.ttf location
  7. Disconnect your Kindle from the computer
  8. Open the Kindle's home screen and run the KAnki app
  9. Hit the Update button in the app to apply changes
  10. Done! Your KAnki app is now updated with the latest features

✨ Example Configuration

/**
 * KAnki Configuration
 * Edit these settings to customize the app for your language
 */
var KANKI_CONFIG = {
  language: "Japanese",  // Change this to your language name
  levels: ["N5", "N4", "N3", "N2", "N1"]   // These should match the keys in your VOCABULARY object
};

/**
 * Vocabulary Data
 * Organized by proficiency level
 */
var VOCABULARY = {
  "N5": [
    {"front": "こんにけは", "reading": "konnichiwa", "back": "Hello", "notes": "Greeting"},
    // Add more words...
  ],
  "N4": [
    {"front": "ζ€₯ぐ", "reading": "いそぐ", "back": "To hurry", "notes": "Verb"},
    // Add more words...
  ],
  // Add more levels...
};

Available configs

1 - Japanese
2 - Ukrainian

Thanks to Ave for contributing the Ukrainian version of KAnki!

⭐ Thank you for using KAnki! ⭐