Skip to main content

Getting Started with GSM

Welcome to GameSentenceMiner (GSM)! This guide will help you get up and running quickly.

Quick Start Video​

If you prefer video tutorials, check out this installation guide:

What You'll Need​

Regardless of your platform, you'll need:

  1. A game to play and learn from.
  2. Yomitan (Browser Extension) for creating cards from text. Take a look here for installation instructions: Yomitan Getting Started
  3. Anki for creating and reviewing flashcards. Take a look here for some Templates and how to set them up in Yomitan: Yomitan Anki Templates
  4. A way to get text into GSM

Installing GSM​

GSM is available for multiple operating systems. Select your platform below for specific installation instructions:

  • Windows - Full feature support, recommended platform
  • macOS - Experimental support
  • Linux - Experimental support

How GSM Works​

Understanding the workflow will help you troubleshoot issues:

  1. Text Event - A texthooker (Agent, Textractor, OCR) detects text from your game
  2. Audio Capture - GSM marks this as the start of a voice line.
  3. Card Creation - You look up a word in the text using Yomitan, and create an Anki card.
  4. Enhancement - GSM automatically adds the audio, screenshot, and optional AI translation to your card

Basic Workflow​

Once you're set up, here's your typical mining session:

  1. Start GSM
  2. Launch OBS if it isn't already running.
  3. Launch your texthooker (if using one)
  4. Start your game
  5. Play normally - when you encounter unknown words:
    • Look them up using Yomitan on GSM's texthooker page, or the Overlay.
    • Create an Anki card
    • GSM automatically enhances it with audio and screenshots

What's Next?​

After installation:

Community & Support​