Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

132 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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:

📄 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

About

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

Topics

Resources

Stars

308 stars

Watchers

6 watching

Forks

Releases

Packages

Contributors

Languages