Getting started (installation)

2025-01-01

This addon is distributed as a GDExtension, which means the .zip archive comes with a folder addons/ that can simply be placed in the root of your Godot project. You can do this while the Godot editor is running - it will dynamically load the addon at runtime.

Demo project

There is a demo project available on GitHub. Download or clone it, and place the addon folder into the root of the project.

Known issues during installation

Make sure you have the minimum required Godot version as displayed on the downloads page.

Windows

  • Do not put your project in a OneDrive folder, it won't work.

Linux

  • Using ARK to unzip the .zip will not work, ARK does not seem to extract symlinks correctly
    • instead, use cd project_root && wget [...] && unzip gd-webview[...].zip
  • On Arch Linux, you need to install libxml2-legacy

macOS

  • The binaries/libraries are not signed, and Godot will refuse to run. You can fix this by running the following bash script from the root of your project. This resets the signing.

If you believe there is an unknown issue, report it on GitHub: issue tracker