Skip to content

KAnki v1.1.1 - Universal Flashcard App for Kindle

Latest
Latest
Compare
Choose a tag to compare
@crizmo crizmo released this 19 Aug 09:27
v1.1.1
f638a12

KAnki Release Notes v1.1.1

πŸ› οΈ Bug Fixes and Improvements

Resolved Issues

  • βœ… Text Overflow on Cards: Cards with long content now have proper scrolling support
  • βœ… Unintended Button Presses: Added protection against accidental rapid button clicks
  • βœ… Deck Time Tracking: Fixed issues with study session timing and statistics

New Features and Enhancements

Starred Card Review Flow

  • βœ… Scrolling Within Cards: Scrolling within cards where front / back text is long.
  • βœ… Post-Session Review: After completing regular reviews, you'll be prompted to review your starred cards
  • Review Process:
    1. Open the app and review your regular cards
    2. Star cards during review by tapping the star icon (β˜† β†’ β˜…)
    3. Complete all due cards
    4. See a prompt: "You have X starred cards from this session. Review them now?"
    5. Accept to enter starred review mode
    6. Review starred cards with normal difficulty buttons
    7. Return to regular mode when finished

Enhanced Card Management

Star/Favorite Cards
  • Mark favorites: Tap the star button (β˜†) in the top-left corner of any card
  • Filter by stars: Use the "β˜… Starred" button in the level selection area
  • Combined filters: Works with level filters (e.g., show only starred N5 cards)
  • Persistence: Star status remains even after resetting progress (but clears with "Reset All Data")
  • Use cases: Mark difficult words, create focused study sets, flag important vocabulary
Card Reversal
  • Switch direction: Tap the "↔ Reverse" button to toggle between modes:
    • Normal (Target β†’ Native): Foreign word shown first
    • Reversed (Native β†’ Target): Native word shown first
  • Visual indicators: Current mode displayed in level area and confirmed by toast notification
  • Enhanced learning: Practice both recognition and production skills
  • Full compatibility: Works with all other features (stars, level filters, error review)
Card Statistics
  • Automatic tracking: KAnki now tracks views and performance for each card
  • View count: See how many times you've encountered each word
  • Last viewed: Know when you last studied a specific card
  • Real-time updates: Statistics update as you study, providing immediate feedback
Improved Scrolling
  • Vertical scroll: Cards with extensive content now support smooth vertical scrolling
  • Text wrapping: Better handling of long words and phrases
Data Persistence
  • Automatic saving: Card progress, stars, and statistics are automatically saved between sessions
  • localStorage: Uses the Kindle's built-in localStorage feature to store data
  • Robust persistence: Data remains even after closing the app or restarting the Kindle
  • Complete history: All review history, difficulty levels, and next review times are preserved
  • File location: Data stored at /Kindle/.active_content_sandbox/kanki/resource/LocalStorage/file__0.localstorage
  • Data control: Reset options (Progress Only or All Data) available in the menu

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
  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 (Existing Users)

  1. Back up your current kanki/js/vocabulary.js or kanki/js/kanki_config.js file if you have been using KAnki
  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 Reload button after clicking the 3 dots in the top chromebar 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...
};

Data Storage

KAnki saves your progress and card statistics using the Kindle's localStorage feature. All your data is stored locally on your device at:

/Kindle/.active_content_sandbox/kanki/resource/LocalStorage/file__0.localstorage

If you ever want to reset all progress or encounter issues with saved data, you can:

  1. Delete this file to completely reset the application data
  2. Use the "Reset Progress" button within the app to only reset card progress while keeping your deck intact
  3. Use the "Reset All" button to return to the default deck and clear all progress

Available configs for this version

1 - Japanese

If you've configured KAnki for another language, please share it via my Discord or submit it on GitHub by opening an issue or pull request with your config zip!

⭐ Thank you for using KAnki! ⭐

Assets 4
Loading