GameWiki is an AI-powered overlay tool designed for gamers, leveraging Google Gemini's RAG capabilities to provide instant in-game answers and wiki information. It aims to eliminate the need for alt-tabbing, enhancing the gaming experience with smart Q&A, build guides, and real-time wiki access directly within the game.

How It Works

GameWiki employs a Retrieval-Augmented Generation (RAG) approach powered by Google Gemini. It overlays game information and an AI chatbot directly onto the game window, allowing users to query build guides, wiki data, and receive instant answers without leaving the game. This approach leverages local knowledge bases and Gemini's AI for context-aware responses, enhancing player immersion and efficiency.

Quick Start & Requirements

• Primary Install: Recommended: Download the portable version (GameWikiAssistant.exe) from the latest release. Alternative: Clone the source repository, run pip install -r requirements.txt, and execute python -m src.game_wiki_tooltip.
• Prerequisites: A Google account and Gemini API key are required for AI chatbot features (a free tier with rate limits is available). WebView2 Runtime is necessary for the website overlay functionality (included in the portable package).
• Links: Quick Start Guide, FAQ, Architecture.

Highlighted Details

• One-hotkey activation (default: Ctrl+Q) for instant overlay access.
• AI Expert powered by Google Gemini, offering smart Q&A with local knowledge bases.
• Supports over 100 games for quick wiki access, with AI-enhanced features for titles like Helldivers 2 and Elden Ring.
• Automatic game detection and configurable hotkeys, language preferences, and wiki sources.

Maintenance & Community

Contributions are welcomed for adding new game support, bug fixes, documentation improvements, and project optimization. The primary contact is Weizhen Chu (chu.weizhen04@gmail.com), with an X profile at https://x.com/ChengXiang75007. Community support is available via Discord, and issues can be reported at GitHub Issues.

Licensing & Compatibility

The project is licensed under the GPL3.0 License, primarily due to its use of PyQt6. This is a strong copyleft license, meaning derivative works must also be distributed under GPL3.0, potentially restricting integration into closed-source commercial applications.

Limitations & Caveats

AI features necessitate a Gemini API key, subject to potential rate limits on the free tier. Hotkey conflicts may arise, requiring administrator privileges or a hotkey change. Game detection relies on a predefined list; testing AI features for unsupported games may require manual folder renaming. The WebView2 Runtime is a mandatory dependency for the website overlay component.