godot-admob-plugin
AGENTS.md648 starsChanged 3 months agoMITView on GitHub
This file is the authoritative source of truth for ALL AI agents (Gemini, Claude, Cursor). Read this first to minimize token usage and ensure architectural consistency.
- Reads credentials
Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.
Of the AGENTS.md files we read, the 32,671 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.
In this repository5 other files it gives its agents.
- doc-masterSkill
- mediationSkill
- parity-checkerSkill
- release-managerSkill
- syncSkill
The file
We split this AGENTS.md into the rules it gives an agent
11 rules. About 0 are common, 4 are distinctive, and 7 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈4
Distinctive · estimate
This author's own choices. Worth a look.
7
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- could be automatic: a setting could enforce it
- Distinctive: line 33
Build All/Specific Platforms: Use the central script for all compilation needs.
- Very specific: line 41
GitHub CLI: Use gh to check status of issues or prs.
- Very specific: line 44
License Header: EVERY new source code file (e.g.
- Very specific: line 45
GDScript: Always use := for type inference.
- Very specific: line 46
Linting: Always run gdlint platforms/godot_editor/addons/ and verify/fix errors before proposing changes.
- Distinctive: line 47
C#:: Use PascalCase. Maintain 1:1 parity with the GDScript API.
- Very specific: line 48
Samples: Always use platform-specific test Ad Unit IDs with ternary operators (GDScript) or properties (C#).
- Very specific: line 49
API Updates in Samples: Every new API implementation, feature, method, or alteration MUST also be added to the sample projects …
- Distinctive: line 53
When performing these specific tasks, you MUST read and follow the specialized guides:
- Very specific: line 60
Security: Never log/commit API Keys or .env files.
- Distinctive: line 66
Verify iOS runtime behavior for App Open Ads in production environments.
≈ “Common” is an estimate: at least 1 in 5 of the 41,581 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
🤖 Project Intelligence: Godot AdMob Editor Plugin
This file is the authoritative source of truth for ALL AI agents (Gemini, Claude, Cursor). Read this first to minimize token usage and ensure architectural consistency.
🏗️ Repository Overview & Architecture
What is this repository?
This repository is a Godot plugin that integrates the Google AdMob SDK into Godot Engine projects. It supports both GDScript and C#, and uses native plugins (Android and iOS) to interact with the official Google Mobile Ads SDKs.
Folder Structure
platforms/godot_editor/: The core Godot plugin and sample project.addons/admob/: The actual plugin distributed to users.admob.gd: Main entry point and public API.internal/: Internal GDScript logic. Rule: Noclass_namehere, usepreload.csharp/: C# wrappers and bridge, mirroring the GDScript API. Managed byCSharpService.gd(auto-hides via.gdignore).
platforms/android/: Android native plugin source code (Kotlin/JNI).platforms/ios/: iOS native plugin source code (Swift/Obj-C).docs/: Official documentation built with MkDocs.scripts/: Automation scripts (e.g., building native plugins).tmp/: Reference implementations and external source code.
Cross-Platform Communication
- Godot ➡️ Native: The Godot scripts (GDScript/C#) use Godot's
Engine.get_singleton()to access native plugins registered by the Android or iOS code. Method calls to these singletons trigger the native Google Mobile Ads SDK functions. - Native ➡️ Godot: The Android and iOS plugins emit signals back to Godot to communicate asynchronous events (e.g., ad loaded, ad failed to load, user rewarded). The Godot side connects to these signals and forwards them to the game developer's code.
- C# ↔️ GDScript: The C# API acts as a wrapper around the GDScript implementation or Engine singletons to guarantee 1:1 API parity.
📦 Current Environment
- Godot Version: 4.7.2 (Current target for builds and testing).
- Godot Version Updates: Whenever targeting or updating to a new Godot version, always update both the Android and iOS
GODOT_VERSIONSmatrices in.github/workflows/cd-build-and-release.ymlto include the new version.
🛠️ Critical Commands
- Build All/Specific Platforms: Use the central script for all compilation needs.
./scripts/build_local.sh [android|ios|all] <godot_version>- Example (All):
./scripts/build_local.sh all 4.7.2 - Example (iOS):
./scripts/build_local.sh ios 4.7.2 - Example (Android):
./scripts/build_local.sh android 4.7.2
- Local Documentation Preview:
- Standard (Stable preview):
mkdocs serve - Development (Master/Latest preview with banner):
mkdocs serve -f mkdocs.dev.yml
- Standard (Stable preview):
- GitHub CLI: Use
ghto check status ofissuesorprs.
📝 Coding Standards
- License Header: EVERY new source code file (e.g.
.gd,.cs,.kt,.swift,.java) MUST start with the project's MIT License header (excluding documentation, Markdown/SKILL.md, and configuration files). - GDScript: Always use
:=for type inference. Prefix bridge signals with_on_admob_. - Linting: Always run
gdlint platforms/godot_editor/addons/and verify/fix errors before proposing changes. - C#: Use PascalCase. Maintain 1:1 parity with the GDScript API.
- Samples: Always use platform-specific test Ad Unit IDs with ternary operators (GDScript) or properties (C#). Verify IDs against
docs/enable_test_ads.md. - API Updates in Samples: Every new API implementation, feature, method, or alteration MUST also be added to the sample projects (
platforms/godot_editor/addons/admob/{gdscript,csharp}/sample/) for interactive testing and verification, maintaining strict 1:1 functional and layout parity between GDScript and C# samples. - Mock Ads Parity: Whenever changes are made to any ad format layout or behavior, the corresponding mock plugins must be updated as well. Maintain 1:1 functional and layout parity between C# and GDScript mock implementations (and vice versa) at all times.
🔄 Specialized Protocols (Skills)
When performing these specific tasks, you MUST read and follow the specialized guides:
- Cross-Platform Sync: .agents/skills/sync/SKILL.md
- API Parity Check: .agents/skills/parity-checker/SKILL.md
- Release Management: .agents/skills/release-manager/SKILL.md
- Documentation Sync: .agents/skills/doc-master/SKILL.md
🚫 Constraints & Security
- Security: Never log/commit API Keys or
.envfiles. - All Agents: Permissions and context are managed via
.agents/settings.json. - Gemini: Respect
.geminiignorepatterns. - Workflow: Reproduce bugs with a script before implementing a fix. Never stage/commit unless asked.
📋 Pending Tasks
- Verify iOS runtime behavior for App Open Ads in production environments.
🔗 Key Files
platforms/godot_editor/addons/admob/admob.gd(Main API)platforms/android/build.gradle(Android Deps)platforms/ios/Package.swift(iOS Deps)docs/enable_test_ads.md(Source of truth for Test IDs)
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

