Home
Softono
gamewiki

gamewiki

Open source Python
307
Stars
16
Forks
2
Issues
6
Watchers
3 months
Last Commit

About gamewiki

An intelligent Wiki overlay tool designed specifically for gamers, featuring GEMINI-powered RAG (Retrieval-Augmented Generation) capabilities for smart Q&A services.

Platforms

Web Self-hosted

Languages

Python

GameWiki - AI-Powered In-Game Assistant

Smart game companion that never leaves your side - Real-time wiki overlay + AI knowledge base for instant answers while gaming

Windows Python Games License GitHub Release

๐Ÿ‘‰ ไธญๆ–‡่ฏดๆ˜Ž | ะ ัƒััะบะธะน | Quick Start | download the newest release | Join Our Discord

โœจ Why GameWiki?

Never alt-tab out of your game again! Get instant answers, build guides, and wiki information directly in your game with our AI-powered overlay.

๐ŸŽฏ Key Features

  • ๐Ÿ”ฅ One Hotkey, All Answers - Press Ctrl+Q to instantly overlay wiki/AI chat without leaving your game
  • ๐Ÿค– AI Game Expert - Powered by Google Gemini with local knowledge bases for smart Q&A.

To use the AI chatbot feature, you will need to have a google account and get gemini API from Google AI Studio.

"The Gemini API "free tier" is offered through the API service with lower rate limits for testing purposes. Google AI Studio usage is completely free in all available countries" - according to Gemini API docs

๐Ÿ“ธ Screenshots

  • Use as AI assitant

Demo

View use video

  • Quick access to Wikis Demo Demo
  • Use as an web browser Demo

๐Ÿš€ Quick Install

Option 1: Download Portable Version (Recommended)

โฌ‡๏ธ download the newest release

Extract the ZIP file

Run GameWikiAssistant.exe

Set your hotkey and start gaming!

๐Ÿ’ก Try AI Chat without a game:

If you want to test the AI features but donโ€™t have a supported game installed, simply create a new folder and rename it to a game in our database (e.g., "Don't Starve Together" or "Helldivers 2"). Focus on that folder, trigger your hotkey, and you're ready to chat! Example query: "How can I catch a rabbit?"

Option 2: Run from Source

# Clone and setup
git clone https://github.com/rimulu030/gamewiki.git
cd gamewiki
pip install -r requirements.txt

# Configure API key for AI features (optional)
set GEMINI_API_KEY=your_key_here  # Windows

# Run
python -m src.game_wiki_tooltip

๐ŸŽฎ Supported Games

๐Ÿค– AI-Enhanced Games (Full Knowledge Base)

Game Features
HELLDIVERS 2 Weapons, Stratagems, Enemy Weaknesses
Elden Ring Items, Bosses, Build Guides
Don't Starve Together Crafting, Characters, Survival Tips
Civilization VI Civs, Units, Victory Strategies

๐Ÿ“– Wiki-Supported Games

Quick wiki access for 100+ games including: VALORANT, CS2, Monster Hunter, Stardew Valley, and more!

๐Ÿ”ง Configuration

First Launch Setup

  1. Hotkey Setup: Choose your preferred activation key (default: Ctrl+Q)
  2. API Key (Optional): Add Gemini API key for AI features
  3. Game Detection: Automatic - just launch your game!

Advanced Settings

  • Custom hotkey combinations
  • Language preferences (EN/ZH)
  • Wiki sources configuration
  • Voice recognition settings

๐Ÿ“š Documentation

๐Ÿ› Troubleshooting

Issue Quick Fix
Hotkey not working Run as Administrator / Change hotkey combination
Game not detected Check supported games list
AI not responding Verify API key in settings
Website not showing Install WebView2 Runtime (included in package)

For more solutions, see FAQ or report an issue.

๐Ÿค Contributing

We love contributions! Whether it's:

  • ๐ŸŽฎ Adding new game support/Knowledge data base. How to build a new knowledge base
  • ๐Ÿ› Bug fixes
  • ๐Ÿ“š Documentation improvements
  • Project Optimization

๐Ÿ“„ License

With the usage of Pyqt6, we use GPL3.0 License - See LICENSE file

๐Ÿ™ Acknowledgments

  • Google Gemini AI - Powering intelligent responses
  • Gaming Communities - For wiki content and knowledge

Contact me

โญ Star us if this helps your gaming experience!

Report Issue ยท Join Our Discord