8000
Skip to content

Whiw/my_vocabulary

Repository files navigation

My Vocabulary

My Vocabulary overlay demo

A tiny, always-on-top overlay flashcard app for effortless vocabulary learning while you work or browse.

➡️ Download (Windows / macOS) - Releases


✨ Features

  • Overlay window that stays on top of other apps (drag & resize freely)
  • Auto-cycling words on a timer (hover to pause; click to skip)
  • Mark as Learned to hide words you’ve mastered
  • Multi-language UI (EN/KR)
  • Example sentence support
    Format: word[TAB]meaning[TAB]example sentence
  • Built-in sample TSV
  • Lightweight (bundled Chromium & Node)
  • Cross-platform: Windows & macOS supported 🎉

⚠️ Note about full-screen games
Some games use exclusive fullscreen (DirectX/OpenGL/Vulkan).
In that mode overlays cannot draw on top.
Switch to borderless windowed (fullscreen) mode instead.


📥 Installation

  1. Download the latest installer from Releases.
  2. Run the installer (.exe on Windows, .dmg or .zip on macOS).
  3. Go to Load and select your .tsv file.

ℹ️ On Windows, SmartScreen may show a warning if the app is unsigned.
Click More info → Run anyway to proceed.

ℹ️ On macOS, you may need to allow apps from unidentified developers in System Settings → Privacy & Security.


🚀 How to Use

  1. Load a TSV

    • File format:
      word[TAB]meaning
      word[TAB]meaning[TAB]example sentence
      
    • Example:
      abate   reduce in amount or intensity   The storm suddenly abated.
      candid  straightforward and honest     She was candid about her feelings.
      sagacious   wise; having sound judgment   The sagacious leader guided them well.
      
  2. Learn flow

    • Words cycle automatically.
    • Hover mouse to pause timer.
    • Use < and > to navigate manually.
    • Check Learned to hide a word (saved to learned.json).
  3. Customize

    • Open Settings to change timer speed, font sizes, colors, and manage learned words.

🔄 Auto-Update

  • Checks GitHub Releases for new versions on launch.
  • Downloads & applies automatically if found.
  • Works on both Windows and macOS.

🌐 Language Support

  • English and 한국어 supported.
  • Switch language from Settings or About.

❤️ Support the Developer

If you find this app helpful, consider supporting its development:


🛠 Build (for Developers)

Requirements: Node.js & npm

# Install deps
npm install

# Run dev
npm start

# Build (electron-builder)
npm run build

About

my vocabulary app

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors

0