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:
- A game to play and learn from.
- Yomitan (Browser Extension) for creating cards from text. Take a look here for installation instructions: Yomitan Getting Started
- Anki for creating and reviewing flashcards. Take a look here for some Templates and how to set them up in Yomitan: Yomitan Anki Templates
- A way to get text into GSM
- Agent - Video Tutorial - Games/Emulators - List of Supported Games: https://github.com/0xDC00/scripts
- LunaTranslator - Video Tutorial - VNs/Emulators - I use this for VNs rather than textractor, but that's not a recommendation.
- Textractor - Video Tutorial - VNs
- GSM's built-in OCR - Universal Solution
- My recommendation for conventional games is to check Agent for a script, and if it doesn't have one, use GSM's OCR.
- For VNs, try LunaTranslator/Textractor before trying OCR.
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:
- Text Event - A texthooker (Agent, Textractor, OCR) detects text from your game
- Audio Capture - GSM marks this as the start of a voice line.
- Card Creation - You look up a word in the text using Yomitan, and create an Anki card.
- 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:
- Start GSM
- Launch OBS if it isn't already running.
- Launch your texthooker (if using one)
- Start your game
- 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:
- Set up AI Features for automatic translations
- Check Troubleshooting if you run into issues
Community & Support
- Discord: Join our community
- GitHub: Report issues or contribute
- Videos: Watch demos and tutorials