About · Features · Platforms · Installation · Quick Start · Documentation · Examples · Feedback · License

⭐ Star us on GitHub - it motivates us a lot!

🧭 About

Electron2D is an agent-native, cross-platform 2D game engine for .NET.

Developers and local coding agents work on the same scenes, scripts, resources, diagnostics and undo history through the editor.

✨ Features

• Agent-native workflow - Local coding agents can inspect and edit scenes, scripts, resources and project settings through the same project model as the Editor. Their changes, diagnostics and undo history remain visible and reversible.
• Trello-style task board - Coordinate work through shared task columns, cards, assignees, labels, review states and editor-visible project context.
• Built-in editor - Scene tree, inspector, 2D viewport, script workspace, debugger and run/output tools for everyday game development.
• C# scripting - Game logic is written as regular C# classes and runs inside the same .NET project as the rest of the game.
• Node-based scenes - Scenes are built from reusable nodes, resources, signals and serializable project files.
• 2D rendering - Sprites, cameras, viewports, text, shaders and immediate drawing.
• 2D physics - Bodies, areas, collision shapes, raycasts and fixed-step simulation.
• Asset workflow - Textures, fonts, audio, shaders and resource importing.
• Cross-platform runtime - Build and run games on Windows, Linux, macOS and Android. iOS and Web are planned as future runtime targets.

🖥️ Platforms

Platform	Editor	Runtime
Windows	✅ Done	✅ Done
Linux	✅ Done	✅ Done
macOS	✅ Done	✅ Done
Android	❌ Not planned	✅ Done
iOS	❌ Not planned	🕓 Planned
Web	❌ Not planned	🕓 Planned

📦 Installation

Clone the repository and build the solution:

git clone https://github.com/edwardgushchin/Electron2D.git
cd Electron2D
dotnet build src/Electron2D.sln -c Release

The runtime package version is 0.1-preview.

🚀 Quick Start

Run the editor:

dotnet run --project src/Electron2D.Editor/Electron2D.Editor.csproj -c Release

📚 Documentation

Documentation, guides and API reference are available in the Electron2D GitHub Wiki.

🎮 Examples

• Platformer - A 2D platformer example built with Electron2D.

💬 Feedback and Contributing

Use GitHub Issues for bug reports, feature requests and design feedback. Pull requests are welcome once the related behavior is covered by documentation and tests. See CONTRIBUTING.md before opening a change.

Please follow the Code of Conduct. Do not include secrets, signing keys, private data or credentials in issues, examples, screenshots or build artifacts.

👥 Contributors

Electron2D is maintained by Eduard Gushchin. See the contributors graph for repository contributors.

📄 License

Electron2D is distributed under the MIT License.