godot-whisper: Instructions file for GitHub Copilot

.github/copilot-instructions.md

godot-whisper copilot-instructions.md is an instructions file for GitHub Copilot from appsinacup/godot-whisper. It costs 1,402 tokens per session, scanned A, original, MIT.

Project instructions for a Godot 4 plugin that connects the game engine to Whisper, a speech-recognition system that turns spoken audio into text.

In plain words
What is it for?
They are for building and maintaining real-time or offline speech-to-text features in Godot, including model loading, audio processing, and native extension registration.
Why use it?
They explain the plugin's C++ structure, build process, dependencies, and important files so development work follows the project's setup.

Instructions file for GitHub Copilot

Written for GitHub Copilot: a Copilot instructions file.

This is appsinacup/godot-whisper's own configuration. It tells GitHub Copilot how to work on godot-whisper itself, so it is not a mod to install elsewhere. Copy it as a starting point and replace the rules that are about this project. Everything godot-whisper configures →

Reuse

Borrowing it

Nothing to install: this file belongs to appsinacup/godot-whisper. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file
curl -O https://raw.githubusercontent.com/appsinacup/godot-whisper/main/.github/copilot-instructions.md
Clone the repo
git clone --depth 1 https://github.com/appsinacup/godot-whisper

Made for: GitHub Copilot.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for godot-whisper copilot-instructions.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/appsinacup/godot-whisper/copilot-instructions/github.svg)](https://agentmods.dev/instructions/appsinacup/godot-whisper/copilot-instructions)
Your own site
<a href="https://agentmods.dev/instructions/appsinacup/godot-whisper/copilot-instructions"><img src="https://agentmods.dev/badge/instructions/appsinacup/godot-whisper/copilot-instructions/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for godot-whisper copilot-instructions.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/appsinacup/godot-whisper/copilot-instructions"><img src="https://agentmods.dev/badge/instructions/appsinacup/godot-whisper/copilot-instructions.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 1,402 This file is loaded in full into every session.
When invoked 1,402 The same file — it is already loaded in full.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.01402 $0.01402
Opus 5.5 $0.00561 $0.00561
Sonnet 5.5 $0.00280 $0.00280
Haiku 4.5 $0.00140 $0.00140

Measured 2mo ago against content hash cc122f31250f, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

godot-whisper copilot-instructions.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2mo ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.github/copilot-instructions.md · 95 lines

How it starts

The opening of the file, as written. The whole thing — 95 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Copilot Instructions — Godot Whisper

Project Overview

Godot Whisper is a GDExtension plugin that integrates whisper.cpp into the Godot Engine for real-time and offline speech-to-text transcription. It targets Godot 4.2+ via godot-cpp.

Architecture

  • Build system: SCons (SConstruct at root). No CMake for the plugin itself.
  • Language: C++ (godot-cpp style). Source files live in src/.
  • Third-party deps are git submodules under thirdparty/:
    • whisper.cpp (v1.8.4, ggml-org/whisper.cpp) — the ML inference engine
    • godot-cpp (branch 4.2) — Godot C++ bindings
    • opencl_headers, opencl_icd_loader — OpenCL support (headers & ICD loader)
    • libsamplerate (0.1.9) — audio resampling
  • After cloning, run git submodule update --init --recursive.

Key Source Files

File Purpose
src/speech_to_text.h/.cpp Main SpeechToText node — transcription, VAD, resampling
src/resource_whisper.h/.cpp ResourceWhisper — wraps a whisper model binary
src/resource_loader_whisper.h/.cpp Custom ResourceLoader for .bin model files
src/register_types.h/.cpp GDExtension entry point — class registration
SConstruct Build script (all platforms)
include/config.h, include/build_config.h Build-time configuration

whisper.cpp v1.8.4 Layout

The submodule has a new directory structure (changed from the old monolithic layout):

  • include/whisper.h — public API header
  • src/whisper.cpp — whisper implementation
  • ggml/include/ — ggml public headers (ggml.h, ggml-cpu.h, ggml-metal.h, ggml-backend.h, …)
  • ggml/src/ — ggml core (ggml.c, ggml.cpp, ggml-backend.cpp, ggml-alloc.c, …)
  • ggml/src/ggml-cpu/ — CPU backend (+ arch/ subdirs for arm, x86, wasm, …)
  • ggml/src/ggml-metal/ — Metal backend (multiple .cpp/.m files)
  • ggml/src/ggml-opencl/ — OpenCL backend (self-contained, embedded kernels)
  • ggml/src/ggml-vulkan/ — Vulkan backend (auto-detected when glslc available)
  • ggml/src/ggml-webgpu/ — WebGPU backend (opt-in, requires Emscripten 4.0.10+)

Read the full file on GitHub · 95 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2mo ago First seen · 95 lines · 1,402 tokens per session scan A cc122f31250f

Subscribe to this mod's changes

godot-whisper copilot-instructions.md is an instructions file published in the GitHub repository appsinacup/godot-whisper (132 stars, last pushed 3mo ago), licensed MIT. It adds 1,402 tokens to every session, about $0.0056 per session on Opus 5.5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-09-01.

Related

godot-whisper copilot-instructions.md compared with instructions from other repositories

godot-whisper copilot-instructions.md next to 6 instructions from other repositories
ModTypeStarsLast pushLicenceScanTokensWorks with
godot-whisper copilot-instructions.mdappsinacup/godot-whisperInstructions file1323mo agoMITA1,402GitHub Copilot
vscode buildNext.instructions.mdmicrosoft/vscodeInstructions file195kyesterdayMITA9,719GitHub Copilot
next.js AGENTS.mdvercel/next.jsInstructions file143ktodayMITA7,461Codex, OpenCode
langchain AGENTS.mdlangchain-ai/langchainInstructions file149kyesterdayMITA4,680Codex, OpenCode
vscode oss-third-party-notices.instructions.mdmicrosoft/vscodeInstructions file195kyesterdayMITA5,516GitHub Copilot
vscode copilot-instructions.mdmicrosoft/vscodeInstructions file195kyesterdayMITA3,093GitHub Copilot
deepseek-harness AGENTS.mddeepseek-ai/deepseek-harnessInstructions file274k2d agoMITA4,313Codex, OpenCode