references.md

References

This file collects the primary official references for godot-kirie.

Use these links before relying on memory for engine behavior, Android plugin packaging, or platform WebView bridge details.

Godot

• Godot Android plugins (stable) Main reference for Godot Android plugin v2 packaging and export flow.
• Command line tutorial (stable) Reference for --remote-debug, command-line running, and export behavior.
• Overview of debugging tools (stable) High-level reference for remote debugging and editor debugging workflows.
• Debugger panel (stable) Reference for runtime debugger capabilities such as scene inspection and stack or variable introspection.
• EditorSettings (stable) Reference for editor debugger settings such as automatic switching to the remote scene tree.
• EditorExportPlugin (stable) Reference for Android export hooks and Apple embedded platform hooks such as framework, plist, and C++ code injection.
• EditorExportPlatformAndroid (stable) Android export platform settings, including Gradle build requirements.
• iOS plugins index (stable) Entry point for Godot iOS plugin documentation.
• Creating iOS plugins Reference for Godot native iOS plugin entry points and .xcframework support. Kirie uses addon export hooks instead of a project-local .gdip shim.
• EditorExportPlatformIOS (stable) iOS export platform settings reference.
• C#/.NET (stable) Reference for Godot C# platform support, including Android and iOS export limitations.
• Variant class (stable) Reference for Godot's cross-language dynamic value model.
• C# Variant (stable) Reference for Godot.Variant, Variant.Type, and C# Variant-compatible types.
• C# signals (stable) Reference for idiomatic C# event usage when working with Godot signals.
• Signal class (stable) Reference for Godot signal behavior and cross-language signal concepts.

Android

• Android WebView Primary API reference for WebView lifecycle, addJavascriptInterface(), and evaluateJavascript().
• JavascriptInterface Security-critical annotation reference for JavaScript-exposed methods.
• WebMessage Reference for message payloads when using the platform message APIs.
• WebMessagePort Reference for channel-style messaging on Android WebView.
• AndroidX WebKit WebViewCompat Reference for AndroidX WebView message listener APIs used by Kirie's Android ArrayBuffer IPC channels and document-start runtime injection.
• AndroidX WebKit WebMessageCompat Reference for WebView message payload types, including ArrayBuffer support.
• Upload your Android library Publishing reference for Maven delivery of Android libraries and metadata.
• Gradle dependency management basics Reference for module dependencies vs file dependencies and transitive dependency behavior.

Apple

• WKWebView Primary API reference for embedded web content on Apple platforms.
• WKScriptMessageHandler Reference for JavaScript-to-native messaging through window.webkit.messageHandlers.
• WKUserScriptInjectionTime.atDocumentStart Reference for iOS document-start script injection before page content loads.

IPC formats and compatibility targets

• Godot CEF methods Reference for CefTexture browser controls, JavaScript eval, and Godot CEF JavaScript IPC send APIs.
• Godot CEF properties Reference for CefTexture.preload_script, preload_script_path, and URL loading behavior.
• Godot CEF releases Desktop artifact source for Kirie. The current pin lives in addons/kirie/godot_cef.json.
• RFC 8949: Concise Binary Object Representation Stable CBOR specification used as the primary reference for Kirie IPC v1 packet encoding.
• Jackson CBOR data format Android native CBOR implementation used for dynamic data lane decoding through Jackson's tree model.
• cborg Browser-side CBOR implementation used by @gd-kirie/ipc.
• Godot CEF IPC signals Reference implementation and future compatibility target for separate text, binary, and CBOR-backed data IPC lanes.
• CEF CefRenderProcessHandler Reference for OnContextCreated, the desktop CEF hook closest to Kirie's future pre-page-script runtime injection point.
• Eventa TypeScript repository Upstream TypeScript Eventa project that Kirie JavaScript adapters should integrate with rather than modify.
• eventa.net repository Upstream C# Eventa project that GdKirie.EventaAdapter should integrate with rather than modify.

.NET

• .NET support policy Reference for supported .NET versions and end-of-support dates.
• Attributes and reflection Reference for C# attribute metadata and runtime reflection.
• Native AOT deployment Reference for Native AOT limitations, platform restrictions, and AOT compatibility analyzers.
• Introduction to AOT warnings Reference for warning categories that flag code patterns that may fail under Native AOT.
• System.Text.Json source generation Reference for AOT-friendly JSON metadata generation.
• Microsoft.Testing.Platform migration to v2 Reference for the .NET 10 dotnet test opt-in through global.json.
• NuGet contentFiles Reference for source files included in PackageReference-based NuGet packages.
• dotnet pack Reference for creating NuGet packages from .NET projects.
• dotnet nuget push Reference for publishing NuGet packages.

JavaScript packaging

• Node.js TypeScript support Reference for Node's built-in TypeScript type stripping and erasable syntax constraints used by the repository task implementation.
• mise task configuration Reference for repository task dependencies and task graph behavior.
• Execa Reference for programmatic process execution from the repository task runner.
• Vite build guide Reference for production HTML builds used by the platform integration web fixture.
• Electron preload scripts Comparison point for renderer-side runtime injection before a page is loaded.
• Tauri WebviewWindowBuilder initialization scripts Comparison point for scripts that run after the global object exists but before the HTML document is parsed and before HTML scripts run.
• Wails frontend script injection Comparison point for injecting IPC and runtime scripts while serving index.html.
• npm trusted publishing Reference for publishing npm packages from GitHub Actions through OIDC instead of long-lived npm tokens.
• GitHub Actions OIDC reference Reference for the id-token: write permission required to request OIDC tokens from GitHub Actions.
• bumpp Reference for recursive monorepo version bumps, release commits, and tags.
• pnpm publish Reference for pnpm workspace publishing behavior, including publishConfig manifest overrides.

Suggested usage in this repo

• When changing Android plugin packaging, start with the Godot Android plugin docs and EditorExportPlugin.
• When changing Android IPC, start with WebView, AndroidX WebKit WebViewCompat and WebMessageCompat, RFC 8949, Jackson CBOR, and cborg.
• When changing iOS IPC or packaging, start with WKWebView, WKScriptMessageHandler, and EditorExportPlugin.
• When changing Kirie runtime injection, start with AndroidX WebKit addDocumentStartJavaScript, WKUserScriptInjectionTime.atDocumentStart, CEF OnContextCreated, and the Electron, Tauri, and Wails runtime injection references.
• When changing the desktop Godot CEF backend, start with Godot CEF methods, Godot CEF IPC signals, and CEF OnContextCreated.
• When changing the IPC packet format or data lane, start with RFC 8949 and Godot CEF's IPC lane documentation.
• When changing the C# wrapper or C# tests, start with Godot C#/.NET platform support, C# signals, and .NET reflection or AOT documentation.
• When changing the Eventa adapter or NuGet packaging, start with .NET Native AOT, System.Text.Json source generation, the upstream Eventa repositories, NuGet contentFiles, dotnet pack, and dotnet nuget push.
• When changing npm package publishing, start with npm trusted publishing, GitHub Actions OIDC, bumpp, and pnpm publish behavior.
• When changing native artifact orchestration, start with Node.js TypeScript support and the Gulp task composition references.
• When changing the platform integration web fixture, start with the Vite build guide and @gd-kirie/ipc.