-
Notifications
You must be signed in to change notification settings - Fork 0
Home
Electron2D is an AI-friendly 2D game engine for C# and .NET. The 0.1.0 Preview line focuses on a clean runtime API, deterministic project tooling and documentation that can be read by both developers and coding agents.
This Wiki is the public documentation hub for the preview API surface. It is generated from the compiled runtime assembly and XML documentation comments, so the reference follows the code that ships in the engine package.
Electron2D provides a compact 2D runtime model: objects, nodes, resources, scenes, 2D math, input events, rendering-facing nodes, animation, UI/text primitives and an initial 2D physics surface. The project is being built for desktop-first development with a release path toward packaged tools, editor workflows and agent-assisted game creation.
- API by Category - browse the runtime API by domain.
- Complete API Index - alphabetical index of every public type.
- API Compatibility - preview support status and planned surface.
| Area | Description | Types |
|---|---|---|
| Core | Object lifetime, identity, names, callable values and low-level result types. | 7 |
| Scene Tree | Nodes, node paths, scene packing and scene traversal. | 5 |
| Resources | Resource base types and stable resource identifiers. | 2 |
| Math and Data | 2D math value types, color, random number generation, variants and collection values. | 12 |
| Input | Input state, input maps, keyboard, mouse, gamepad and touch event types. | 20 |
| Display and Localization | Display state, orientation requests, virtual keyboard state and translations. | 5 |
| Rendering | 2D drawing nodes, textures, tile maps, viewports, cameras, materials, shaders and rendering server state. | 20 |
| Animation and Tweening | Frame animation, animation resources, playback nodes and tween sequences. | 16 |
| Audio | Audio resources, playback nodes and audio server state. | 5 |
| Physics | 2D physics bodies, areas, shapes, query parameters, collisions and physics server boundaries. | 30 |
| UI and Text | UI controls, labels, fonts and text alignment values. | 48 |
| Scripting Metadata | Attributes used by scripts, serialization metadata and editor-facing script annotations. | 3 |
| Item | Status |
|---|---|
| Runtime API |
173 public types generated from the current assembly |
| Documentation source | XML comments and compiled public surface |
| Navigation | Category pages, complete index and focused common API sidebar |
| Release line | 0.1.0 Preview |
The documentation is generated in a stable structure so humans and coding agents can link to the same pages, compare public types, and avoid guessing which preview APIs exist.
The compatibility page marks which APIs are supported, partial, experimental, planned or intentionally excluded for this preview release.
Electron2D 0.1.0 Preview API reference. Generated from 175 public runtime types.