Skip to main content

Getting Started with GSM

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

Choose Your Platform​

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

  • Windows - Full feature support, recommended platform
  • macOS - Experimental support, core features working
  • Linux - Experimental support, community-maintained

What You'll Need​

Regardless of your platform, you'll need:

  1. A game to play and learn from
  2. Anki for creating and reviewing flashcards
  3. OBS Studio for capturing game footage and audio
  4. Yomitan (browser extension) for creating cards from text
  5. A texthooker (optional but recommended)

Quick Start Video​

Watch this installation tutorial to see the setup process in action:

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 and begins monitoring
  3. Voice Detection - When speech ends (detected by VAD), GSM saves the audio clip
  4. Screenshot - A screenshot from OBS is captured at the moment of the text event
  5. Card Creation - You look up a word in the text using Yomitan, which creates an Anki card
  6. 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. Launch OBS and set up your game capture scene
  2. Start GSM
  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
    • Create an Anki card
    • GSM automatically enhances it with audio and screenshots

What's Next?​

After installation:

Community & Support​