Skip to content

MrJul/Estragonia

Repository files navigation

Estragonia: Avalonia in Godot

Avalonia + Godot

NuGet

Estragonia is a bridge allowing the use of the powerful Avalonia UI framework in the no less powerful Godot game engine!

It's GPU accelerated using Vulkan, which is the main renderer used in Godot 4.

Quick Start

  1. Have Godot 4.1 with .NET support installed.
  2. Install the JLeb.Estragonia NuGet package inside your Godot C# project.
  3. Initialize the Avalonia application using UseGodot().SetupWithoutStarting().
  4. Add a Godot Control node to your scene, assign it a script inheriting from JLeb.Estragonia.AvaloniaControl and populate its Control property with any valid Avalonia view.

For a more detailed guide, see the step by step instructions.

Resources

For various things to know regarding compatibility, rendering and input handling, see this document.

Samples:

  • HelloWorld: a basic Avalonia-into-Godot setup.
  • GameMenu: a functional game menu UI using the MVVM pattern, with controller support, UI animations and scaling.

License

The whole Estragonia project source code is under the MIT License.
Some specific licenses may apply to some assets used in the samples. See each sample for more information.

Video

estragonia_gamemenu_demo.mp4

From the GameMenu sample