WRY is a cross-platform webview rendering library. This extension allows you to use the native webview in Godot to build browsers and GUIs with HTML, CSS and JavaScript.
Warning
This extension is a work in progress! Expect bugs, report issues, and feel free to contribute.
- 🍃 Use the native system native webview (no extra dependencies!)
- 🌎 Load website URLs and local
res://files - 🧩 JavaScript ⇔ GDScript code integration
- 🚥 Mouse/keyboard input events forwarding
Demo game UI available at "examples/character_creator_ui_demo".
📸 Other screenshots
The easiest way to install Godot WRY is through Godot's Asset Library. You can install it via the editor by following these instructions:
- Open your project in Godot 4.1 or later.
- Go to the "📥 AssetLib" tab at the top of the editor.
- Search for "Godot WRY".
- Click on the Godot WRY extension and click Download.
- In the configuration dialog, click Install.
- Go to the Releases page.
- Download the latest release ZIP file (not the source code).
- Extract the contents into your project's "addons" folder (create one if it doesn't exist yet).
Use just to build the extension and move the binaries to the Godot project folder:
$ just buildIf you need a more in-depth guide on how to compile the project, check the Building from source documentation page.
Please refer to the Docs for API reference and in-depth guides on how to use Godot WRY.
| Platform | Support | Web engine |
|---|---|---|
| Windows (10, 11) | ✅ Supported | WebView2 (Chromium) |
| Mac (Intel, Apple Sillicon) | ✅ Supported | WebKit |
| Linux (X11) | 🚧 Supported* | WebKitGTK |
| Android | ⏳ Planned | Android WebView (Chromium) |
| iOS | ⏳ Planned | WebKit |
| Browser/HTML5 | ⏳ Planned | — |
WebKitGTK is required for WRY to function on Linux. The package name may differ based on the operating system and Linux distribution.
* X11 support only. Transparency is currently not supported. See #17.
WRY itself already has mobile support. Contributions to add Android/iOS support in this extension are welcome!
- Webview always renders on top
- Different browser engines across platforms
- No automatic dependency checks
You can learn more about these caveats on the Caveats documentation page.
Your help is most welcome regardless of form! Check out the How to contribute page for all ways you can contribute to the project. For example, suggest a new feature, report a problem/bug, submit a pull request, or simply use the project and comment your experience.
See the Roadmap documentation page for an idea of how the project should evolve.
The Godot WRY extension is licensed under MIT. WRY is licensed under Apache-2.0/MIT.
Below is a list of interesting similar projects:
- gdcef — Open-source, powered by Chromium
- Godot-HTML — Open-source, powered by Ultralight (WebKit)
- godot-webview — Commercial, powered by QT (Chromium/CEF)