Site icon Efficient Coder

GameWikiTooltip: The Ultimate In-Game Guide Tool for Gamers

高效码农

GameWikiTooltip: Your In-Game AI Assistant for Seamless Guide Access

Ever found yourself stuck in a game—staring down a tough boss with no memory of its weaknesses, or wanting to check the best gear build without pausing and switching windows? GameWikiTooltip solves this exact problem. It’s a Windows-based AI-enhanced game utility that delivers wiki information and smart answers directly within your game, no window-switching required. This means you can stay focused on gameplay while getting the guidance you need, right when you need it.

What Is GameWikiTooltip?

At its core, GameWikiTooltip is a desktop application that combines two key features: in-game wiki access and AI-powered Q&A. It runs as a lightweight overlay—similar to Discord or Steam’s in-game overlays—so it never modifies game files or memory. This non-invasive design means it won’t put your game account at risk, making it safe to use with all your favorite titles.

Here’s what makes it stand out:

  • Platform Support: Currently optimized for Windows 10 and 11 (Linux and macOS support may come in future updates).
  • Cost: 100% free and open-source. The AI features rely on Google’s Gemini API, which offers a generous free tier for casual use.
  • User Experience: Activated with a customizable hotkey (default: Ctrl+Q), it pops up as a floating window that stays on top of your game—no more breaking immersion to look up攻略 (guides) online.

How to Install GameWikiTooltip (2 Easy Methods)

Installing GameWikiTooltip takes minutes, and you can choose the method that fits your technical comfort level:

Method 1: Portable Version (Best for Most Users)

This is the simplest option—no installation, just download and run:

  1. Download the latest release
    Go to the project’s Releases page and download the file named GameWikiAssistant_Portable.zip.

  2. Extract and launch
    Unzip the file to any folder on your computer. Inside, you’ll see this structure:

    📁 GameWikiAssistant/
├── GameWikiAssistant.exe    ← Double-click this to run
├── runtime/                ← Contains essential components (like WebView2)
└── data/                   ← Pre-built game knowledge bases

  3. First-launch setup
    When you run GameWikiAssistant.exe for the first time, a window will ask you to set a hotkey. The default is Ctrl+Q, but you can change it to any combination using Ctrl, Alt, Shift, or Win keys. Click “Save,” and you’re ready to game.

Method 2: Run from Source Code (For Developers/Advanced Users)

If you want to view or modify the code (e.g., add a new game’s knowledge base), follow these steps:

  1. Clone the repository
    Open Command Prompt (Windows) or Terminal, and run:

    git clone https://github.com/rimulu030/gamewiki.git
cd gamewiki

  2. Create a virtual environment
    Virtual environments prevent conflicts with other Python tools on your computer. Run:

    # Create the environment
python -m venv venv

# Activate it (Windows only)
venv\Scripts\activate

    You’ll see (venv) at the start of your command line when the environment is active.

  3. Install dependencies
    All required tools (like PyQt6 for the UI and Google’s Gemini SDK) are listed in requirements.txt. Install them with:

    # Update pip first (to avoid installation errors)
pip install --upgrade pip

# Install dependencies
pip install -r requirements.txt

  4. (Optional) Set up AI features
    To use the AI chat function, you need a Google Gemini API key. Here’s how to add it:

    # For Windows: Set the API key as an environment variable
set GEMINI_API_KEY=your_api_key_here

    Get a free API key from Google AI Studio—no credit card required.

  5. Launch the app
    Run the application with:

    python -m src.game_wiki_tooltip

How to Use GameWikiTooltip (4 Simple Steps)

Using the tool is intuitive—here’s how to get help while gaming:

Step 1: Launch your game

Start the game you want to play as usual. GameWikiTooltip runs in the background and won’t interfere with your game’s launch or performance.

Step 2: Activate the overlay with your hotkey

While playing, press your chosen hotkey (default: Ctrl+Q). The GameWikiTooltip window will appear on top of your game—you can drag it to any position so it doesn’t block important gameplay elements.

Step 3: Choose a mode

The tool has two modes to fit your needs:

Mode 1: Wiki Mode

This mode opens the official wiki for your game directly in the overlay. It’s perfect for quick lookups—like checking item locations, quest steps, or enemy stats. Currently, it supports over 100 games, including popular titles like Valorant, CS2, Monster Hunter, and Stardew Valley.

Mode 2: AI Chat Mode

For deeper questions (e.g., “What’s the best loadout for fighting bugs in HELLDIVERS 2?” or “How do I survive winter in Don’t Starve Together?”), use AI Chat Mode. Type your question (or use voice input—see Step 4) and the AI will generate a clear answer using a dedicated knowledge base for your game.

Note: AI Chat Mode requires a Gemini API key (set up in Step 4 of the source code method) and only works for games with a pre-built knowledge base (see the next section).

Step 4: Get your answer

  • Text input: Type your question in the chat box and press Enter.
  • Voice input: Click the microphone icon and speak your question. For voice to work, you first need to download a voice model by running this command in the project folder: 
    python download_vosk_models.py

Which Games Does GameWikiTooltip Support?

Support varies by game—some have full AI integration, while others offer basic wiki access. Here’s a breakdown:

1. Games with Full AI Support (Dedicated Knowledge Bases)

These games have custom-built knowledge bases, so the AI can answer detailed questions about strategies, gear, and enemies.

Game Title What You Can Ask the AI
HELLDIVERS 2 “What’s the best weapon for taking down Bile Titans?” “Which stratagems work against bugs?”
Elden Ring “Where can I find the Moonveil katana?” “What’s a good dexterity build for beginners?”
Don’t Starve Together “How do I make a Winter’s Feast table?” “What’s the best character for solo play?”
Civilization VI “How do I get a Science Victory?” “Which civ is best for early-game expansion?”

2. Games with Basic Wiki Support

Over 100 games support wiki access—you can view official wiki pages directly in the overlay, but the AI won’t answer custom questions. Popular examples include:

  • Valorant
  • Counter-Strike 2 (CS2)
  • Monster Hunter: World
  • Stardew Valley
  • The Legend of Zelda: Tears of the Kingdom (PC emulators)

How Does GameWikiTooltip Work Technically?

If you’re curious about the tool’s inner workings, it uses a three-layer architecture to deliver fast, reliable performance. Each layer has a clear job, so the tool runs smoothly even during intense gameplay.

1. User Interface Layer (What You See)

This layer handles all interactions between you and the tool:

  • PyQt6 UI: The main window (overlay) is built with PyQt6, a lightweight framework that lets the window stay on top of games and resize dynamically.
  • WebView2: Renders wiki pages—this is the same technology Microsoft Edge uses, so pages load quickly and display correctly.
  • System Tray Icon: Lets you access settings (e.g., change hotkeys) or close the tool without opening the overlay.

2. Core Services Layer (The “Engine”)

This layer manages the tool’s key functions behind the scenes:

  • Hotkey Manager: Uses Windows API (via pywin32) to listen for your hotkey globally—even when the tool is running in the background.
  • Game Detector: Identifies which game you’re playing by checking the title of the active window (e.g., if the window title is “HELLDIVERS 2,” it loads the HELLDIVERS 2 knowledge base).
  • Window Controller: Manages the overlay’s position, size, and “always-on-top” behavior. It also supports features like blurred backgrounds and click-through regions (so you can click game elements even if the overlay is in the way).

3. AI/RAG Layer (The “Brain”)

The AI features rely on Retrieval-Augmented Generation (RAG)—a system that combines a knowledge base with AI to generate accurate answers. Here’s how it works when you ask a question:

  1. Query Processing: The tool first detects the language of your question (e.g., English or Chinese) and figures out your intent (e.g., “looking for a weapon recommendation”).
  2. Hybrid Search: It runs two searches at once:
    • Vector Search (FAISS): Finds content similar in meaning to your question (e.g., “best bug weapon” matches “top anti-insect gear”).
    • Keyword Search (BM25): Finds content with exact keywords (e.g., “Bile Titan” matches only results that mention “Bile Titan”).
  3. Reranking: The tool sorts the results to prioritize the most relevant ones (e.g., if you ask about Elden Ring, it ignores HELLDIVERS 2 content).
  4. Answer Generation: The sorted results are sent to Google Gemini, which writes a clear, natural-language answer.

How to Add a New Game’s Knowledge Base

Want to use GameWikiTooltip with a game that’s not currently supported? You can build a custom knowledge base in a few steps:

Step 1: Prepare the Knowledge Base File

First, create a JSON file with your game’s information. Save it in the data/knowledge_chunk/ folder. The file must follow this structure (only the fields marked “required” are mandatory):

[
  {
    "knowledge_chunks": [
      {
        "chunk_id": "unique_id_001",  // Required: Unique ID for this piece of info
        "topic": "Best Early-Game Weapons",  // Required: Title of the info
        "summary": "The Iron Sword is ideal for beginners—it deals 50 damage and is easy to craft with 2 Iron Ore and 1 Wood.",  // Required: Detailed description
        "keywords": ["Iron Sword", "early-game weapons", "crafting"],  // Required: Searchable terms
        "type": "Weapon_Guide",  // Optional: Category (e.g., "Build_Recommendation", "Enemy_Guide")
        "structured_data": {  // Optional: Extra details (e.g., weapon stats)
          "weapon_name": "Iron Sword",
          "damage": 50,
          "crafting_materials": ["Iron Ore (2)", "Wood (1)"]
        }
      }
    ]
  }
]

Step 2: Build the Search Indexes

Next, generate the vector and BM25 indexes (these let the tool search your knowledge base quickly). Use one of these commands in the project folder:

Goal Command
Build for a single game python src/game_wiki_tooltip/ai/build_vector_index.py --game YourGameName
Build from a specific file path python src/game_wiki_tooltip/ai/build_vector_index.py --file data/knowledge_chunk/YourGame.json
Build for all games in the folder python src/game_wiki_tooltip/ai/build_vector_index.py --game all
Update only the BM25 index (faster) python src/game_wiki_tooltip/ai/rebuild_bm25_only.py YourGameName

Step 3: Test It

Launch GameWikiTooltip and your game. Press your hotkey, switch to AI Chat Mode, and ask a question about your new content (e.g., “How do I craft the Iron Sword?”). The AI should answer using your knowledge base.

Common Issues & Fixes (Troubleshooting Guide)

Even the best tools run into issues sometimes. Here’s how to fix the most common problems:

Problem 1: The hotkey isn’t working

You press the hotkey, but the overlay doesn’t appear. Try these fixes:

  1. Run as Administrator
    Right-click GameWikiAssistant.exe and select “Run as administrator.” Some games block global hotkeys from non-admin apps.

  2. Check for hotkey conflicts
    Other apps (e.g., Discord, Spotify) might use the same hotkey. Change your hotkey in the tool’s settings (right-click the system tray icon → “Settings”).

  3. Whitelist the tool in your antivirus
    Antivirus software (like Windows Defender) sometimes blocks hotkey tools. Add GameWikiAssistant.exe to your antivirus’s “allowed” list.

  4. Switch to Borderless Windowed mode
    Some games in “Exclusive Fullscreen” mode block overlays. In your game’s graphics settings, change the display mode to “Borderless Windowed.”

Problem 2: The tool doesn’t recognize my game

The overlay opens, but it doesn’t load the right wiki or knowledge base. Try these steps:

  1. Check the game’s window title
    Open Task Manager (Ctrl+Shift+Esc), go to the “Details” tab, and find your game’s process. Look at the “Window Title” column—this must match the name in the tool’s config files.

  2. Add the game manually

    • Right-click the GameWikiTooltip system tray icon → “Settings.”
    • Scroll to “Game Configuration” and click “Add Game.”
    • Enter the game’s window title (from Task Manager) and the URL of its official wiki.
    • Click “Save.”

  3. Check language files
    The tool has separate config files for English (games_en.json) and Chinese (games_zh.json). If your game’s title is in Chinese (e.g., “饥荒联机版”), make sure it’s listed in games_zh.json.

Problem 3: The AI isn’t responding

You ask a question in AI Chat Mode, but you get no answer (or an error). Here’s how to fix it:

  1. Verify your API key

    • Right-click the system tray icon → “Settings.”
    • Check that your Gemini API key is correct (no typos!).
    • Go to Google AI Studio to confirm you haven’t used up your free tier.

  2. Check your internet connection
    The AI needs an internet connection to communicate with Google Gemini. Make sure you’re online, and your firewall isn’t blocking GameWikiAssistant.exe.

  3. Rebuild the knowledge base
    If the AI says “No relevant information found,” your game’s knowledge base might be corrupted. Rebuild it with:

    python src/game_wiki_tooltip/ai/build_vector_index.py --game YourGameName

Problem 4: The overlay doesn’t show up (but the hotkey works)

You press the hotkey, and you hear a sound (or get a notification), but the window doesn’t appear. Try these fixes:

  1. Install WebView2 Runtime
    The overlay uses WebView2 to display content. Run the installer in runtime/MicrosoftEdgeWebView2Setup.exe (included in the portable zip) or download it from Microsoft’s website.

  2. Disable Hardware Acceleration

    • Open the tool’s settings → “Advanced.”
    • Uncheck “Enable Hardware Acceleration.”
    • Restart the tool. This fixes issues with older graphics cards.

  3. Check for multiple monitors
    The overlay might be on a different monitor. Move your game to your primary monitor, or drag the overlay from another screen to your game screen.

Problem 5: Voice input isn’t working

You click the microphone icon, but the tool doesn’t recognize your speech. Try these steps:

  1. Download the voice model
    Run this command in the project folder:

    python download_vosk_models.py

  2. Check microphone permissions

    • Go to Windows Settings → “Privacy & security” → “Microphone.”
    • Turn on “Allow apps to access your microphone.”
    • Make sure GameWikiAssistant.exe is listed under “Allowed apps.”

  3. Set the correct microphone

    • Right-click the speaker icon in the Windows taskbar → “Sounds.”
    • Go to the “Recording” tab.
    • Set your preferred microphone as the default (right-click → “Set as Default Device”).

How to Build Your Own Executable File

If you modify the source code (e.g., add a new feature), you can create a new executable file to share with others. Here’s how:

Prerequisites

Make sure you have these installed:

  • Python 3.8–3.11 (3.12+ may cause compatibility issues)
  • Visual C++ Build Tools (download from Microsoft)
  • Git (for version control, optional but recommended)

Step-by-Step Build Process

  1. Prepare your environment
    Follow Steps 1–3 of the “Run from Source Code” method (clone the repo, create a virtual environment, install dependencies).

  2. (Optional) Download voice models
    If you want to include voice support in your executable:

    python download_vosk_models.py

  3. Build the executable
    Use one of these methods:

    Option A: Use the Build Script (Recommended)

    The project includes a script that automates the build process:

    python build_exe.py

    Option B: Manual PyInstaller Command

    If you want more control, run this command (replace paths as needed):

    pyinstaller --name GameWikiAssistant \
            --windowed \
            --icon src/game_wiki_tooltip/assets/app.ico \
            --add-data "src/game_wiki_tooltip/assets;src/game_wiki_tooltip/assets" \
            --add-data "data;data" \
            --hidden-import PyQt6 \
            --hidden-import google.generativeai \
            src/game_wiki_tooltip/qt_app.py

  4. Find your executable
    The built files will be in the GameWikiAssistant_Portable_onedir/ folder. The main executable is GameWikiAssistant/GameWikiAssistant.exe.

Tips to Optimize the Executable

  • Reduce file size: Use UPX compression (install with pip install pyinstaller[upx] and add --upx-dir=path/to/upx to the build command). Note: This may trigger false positives in some antivirus tools.
  • Speed up startup: Use “OneDir” mode (the default) instead of “OneFile” mode—OneFile packages everything into a single EXE but takes longer to launch.
  • Remove unused modules: Edit game_wiki_tooltip.spec and add modules to the excludes list (e.g., excludes = ['tkinter', 'matplotlib']).

Final Thoughts

GameWikiTooltip fills a unique gap for gamers: it lets you get help without breaking immersion. Whether you’re a casual player who needs a quick wiki lookup or a hardcore gamer seeking detailed AI-powered strategies, it’s a tool that adapts to your needs.

Best of all, it’s open-source—so if you have ideas for new features (like support for your favorite indie game), you can contribute to the project. Check out the GitHub repository for more details on how to help.

If you run into issues, the community is here to help: join the Discord server, post a question on the GitHub Discussions page, or send an email to support@gamewikitooltip.com.

Now, launch your game, press Ctrl+Q, and enjoy a smoother, more informed gaming experience!

Exit mobile version