Godot Chrome

Godot Chrome is a plugin that exposes Android WebKit's API v1 to Godot Engine GDScript via Android plugins. Users can create an embedded Chrome web browser in Godot Engine.

This plugin currently works for the Godot 3.5 branch and newer. It uses V1 Plugin Integration with .gdap files but relies on Godot's Maven repository as a dependency in the project's build.gradle file rather than local .aar files.

📖 Documentation

📌 Creating an Embedded Chrome Browser

Use the following GDScript function to create an embedded Chrome browser:

helloWorld(url, headers, enableJavaScript, order, debugger)

Parameters:

• url: String – The URL to load.
• headers: Dictionary = Dictionary() – Custom HTTP headers.
• enableJavaScript: Boolean = false – Enables JavaScript (default: false for security reasons).
• order: Int = -99 – WebView layering order (-99 is the default overlay for UI and background renders).
• debugger: Boolean = true – Stores console.log messages that can be parsed in Godot.

📌 Other Methods:

• goodByeWorld() – Destroys the web view instance.
• getCurrentHeight() – Returns the height of the loaded HTML page as an integer.
• getTitle() – Returns the title of the loaded URL as a string.
• getProgress() – Returns the progress of the current page (1 - 100).
• consoleLog() – Prints JavaScript console.log() entries to Godot as a dictionary. Also debugs the embedded Chrome instance status.

📌 Signals:

• <strong>connected</strong> – Emitted when an embedded browser instance is created.
• <strong>disconnected</strong> – Emitted when the embedded browser instance is destroyed.

🚀 How To Use

1. Download the Plugin: Download and export the .gdap and .aar release files for Godot 3, and place them in your res://android/plugins folder, for Godot 4, export .aar files pluginV2.gd and plugin.cfg to your res://addons/GodotChrome folder and enable the GodotChrome in your plugin settins
2. Place the Files: Move them into your project directory for Godot 3:

   res://project/android/plugin

3. Enable the Plugin:
   • In Export Settings (Godot Engine), enable Custom Build.
   • Check GodotChrome Plugin.
4. Initialize the Engine in Code:

   var Chrome = Engine.get_singleton("GodotChrome")

5. Call Supported Methods on Your Chrome Instance Example:

   Chrome.helloWorld("https://example.com", {}, true, -99, true)

🔥 Godot 4.4 Support

A Godot 4.4+ version will be available for $1.99 to support long-term maintenance and updates. This version will continue implementing Android WebKit API v1 calls.

The main branch remains focused on Godot 3.5+ support.

🎮 Happy Coding with Godot Chrome! 🚀