Documentation

Requirements

• Unreal Engine 5.8. Game IQ uses the experimental native Toolset Registry introduced in UE 5.8.
• Windows is the currently tested platform. The core is portable C++, but macOS and Linux are not yet verified.
• PowerShell 7 for the helper scripts. The plugin itself has no Node or external runtime dependency.

Install

Clone the repository directly as the GameIQ folder inside your project's Plugins directory:

cd <YourProject>/Plugins
git clone https://github.com/kevinpbuckley/unrealgameiq.git GameIQ

Repository layout

GameIQ/
├── GameIQ.uplugin
├── Source/GameIQ/
├── Content/
└── scripts/

Enable Unreal Game IQ in Edit → Plugins if needed, then build your editor target so UnrealEditor-GameIQ.dll is compiled.

Build the index

Close the editor and run this once from your project root:

pwsh Plugins/GameIQ/scripts/build-index.ps1 -Project .

The commandlet extracts project knowledge and writes the SQLite FTS5 database to <project>/.gameiq/index.db.

Rebuild from the editor

• Open Tools → Game IQ and choose Rebuild Index for a full rebuild.
• Choose Reindex Documents to refresh documents, images, and external sources without rebuilding code and asset entities.
• Use the console commands GameIQ.Rebuild, GameIQ.ReindexDocs, or GameIQ.ReindexCode from scripts and automated editor workflows.

After the initial build, save hooks patch changed assets automatically. A source fingerprint check reindexes changed C++ at editor startup and after Live Coding patches.

Connect an AI agent

Open the project in Unreal Editor. Game IQ registers GameIQ.GameIQService on UE 5.8's native MCP endpoint, so an agent already connected through Unreal's MCP support or VibeUE can use it without another server or process.

From Unreal Python, the same service is available directly:

import unreal
results = unreal.GameIQService.search("reload ammo", "blueprint")
print(results)

Generate agent guidance

Run GameIQ.GenerateAgentConfig to add a ready-to-use Game IQ guide to the project's agent instructions, including CLAUDE.md, AGENTS.md, GEMINI.md, or Copilot instructions.

Query tools

• Search — hybrid full-text search with optional kind and path-prefix filters.
• GetEntity — summaries, chunks, Blueprint pseudocode, C++ bodies, edges, and children.
• Children — paged child entities with an optional class filter.
• References — incoming or outgoing typed relationships at a chosen depth.
• Impact — severity-ranked dependents that could be affected by a change.
• Explain — an assembled context bundle for a topic or system.
• ProjectStats — counts, unused-asset candidates, large dependencies, and authority ranking.
• Drift — documented property claims that conflict with the implementation.
• Coverage — stated design intent connected to real implementation.
• Doctor — index diagnostics that distinguish an empty project from a broken index.

Exclude directories

Create gameiq.config.json at the project root to keep third-party source and Game IQ itself out of the project index:

{
  "exclude": [
    "Plugins/GameIQ",
    "Plugins/SomeMarketplacePlugin"
  ]
}

Entries can be directory names such as VibeUE or project-relative paths such as Plugins/VibeUE. You can edit the same list under Project Settings → Plugins → Game IQ.

Troubleshooting

The plugin is not detected

Confirm the descriptor is exactly at Plugins/GameIQ/GameIQ.uplugin. If it is under Plugins/unrealgameiq/plugin/GameIQ, you are using the retired pre-refactor layout.

The index is empty or unavailable

Run Doctor, then perform a full rebuild. Build progress appears in the Game IQ panel and under LogGameIQRunner in Unreal's Output Log.

Source changes are not reflected

Use GameIQ.ReindexCode and verify Auto Reindex Cpp is enabled under Project Settings → Plugins → Game IQ.

For bugs and feature requests, open an issue on GitHub or ask in the public Discord.