Skip to main content

← GDScout

How GDScout works

Vector embeddings, retrieval-augmented generation, and the official Godot 4.6 docs. Here is the technique behind the chat on the home page.

The pipeline

GDScout doesn't run on a generic LLM that learned about Godot by accident. It uses retrieval-augmented generation, the standard way modern AI assistants stay grounded in specific knowledge.

1. Indexing the docs

We split the official Godot 4.6 documentation into small passages, usually a few sentences each. Each passage gets converted into a vector embedding: a list of around 1,500 floating-point numbers that captures the meaning of that passage. Passages with similar meaning end up with similar vectors. Two paragraphs both about RigidBody3D physics will land near each other in this high-dimensional space, even if they use completely different words.

2. Storage

All those embeddings sit in a vector database, an index optimized to answer one very specific question: “given this vector, what are the closest other vectors?” It answers that question in milliseconds, even across hundreds of thousands of entries.

3. Answering

When you ask a question, the question itself gets embedded the same way. The database returns the handful of documentation passages whose embeddings are closest to your question. Those passages, plus your question, go to a general-purpose LLM with a strict instruction: answer using only these passages. If the docs don't say it, the model won't claim it does.

Built for two kinds of game devs

Beginners

“How do I make a player jump in 2D?” “What is the difference between CharacterBody2D and RigidBody2D?” “How do signals work?” The answers come back with the same authority as the manual, in plain English, with working code in GDScript or C#.

Mid-engine deep cuts

“How do I extend EditorPlugin to add a custom inspector for my own resource class?” “What is the right way to pool projectiles when I have 500 on-screen?” “How does the renderer decide which mesh instances to batch?” These are the questions where you'd otherwise be opening five tabs, three forum threads, and a stale Reddit answer from 2021. GDScout answers them in one shot, citing the actual docs section.

What it won't do

GDScout won't invent node names. It won't hallucinate API methods that don't exist. If the docs don't have an answer, it will say so rather than fabricate one.

It also isn't a code reviewer. It can tell you how CharacterBody2D works; it can't tell you that your _physics_process is going to drop frames at 60 enemies. For that, keep reading.

Also from Surmado: Godot Surmado Code Review

The same embedding pipeline, pointed at your code instead of your questions. Surmado Code Review is a pull request reviewer trained on the official Godot 4.6 documentation the same way GDScout is.

It reads every change in a pull request, finds the docs sections relevant to the patterns being touched, and writes targeted review comments inline on the PR. Performance hot paths in _process. Memory leaks from missing queue_free() calls. Wrong physics body for the use case. Godot 3.x idioms half-ported into 4.x. Signal connections that will silently drop on the next refactor.

Where GDScout answers questions about Godot, Surmado Code Review reviews your project's adherence to Godot.

Get Godot Surmado Code Review →

Ask GDScout something hard.

It is free, it cites its sources, and it doesn't sleep.

Back to the chat