GDCEF Godot4 0.17.0-godot4 2D Tools 4.2 Community

Submitted by user Lecrapouille; MIT; 2025-04-05

gdCEF - Web Viewer Plugin for Godot 4.x
=======================================

gdCEF is a web viewer plugin for Godot >= 4.2, compatible with Linux, Windows, and macOS.
It uses the Chromium Embedded Framework (CEF) to bring web content into your 2D and 3D applications.

Notes:
------
1. Godot 3 users: gdCEF is no longer maintained but still available here:
https://godotengine.org/asset-library/asset/1426

2. Android and iOS are not supported by CEF and therefore not by gdCEF.

Installation Methods
====================

There are three ways to install gdCEF in your project:

1. Direct Download (Prebuilt Binaries)
---------------------------------------
- Download binaries from GitHub:
https://github.com/Lecrapouille/gdcef/releases
- Extract the archive and place the 'cef_artifacts' folder into your project.

Limitations:
* Fixed versions of CEF and Godot.
* The artifacts folder name cannot be changed.
* Only x64 architectures are supported due to CI limitations.

2. Script-Based Download (since v0.12.0)
----------------------------------------
- Download the gdCEF source code from the Godot Asset Library.
- Use the provided Python 3 build script:
addons/gdcef/build.py
- C++ source folders can be deleted as they are not compiled.
- Set the GITHUB_GDCEF_RELEASE variable to the version you want.
- Run the script to download binaries and set up demo scenes.

Limitations:
* Same as the direct download method.

3. Build from Source (Recommended)
----------------------------------
- Download the gdCEF source code from the Godot Asset Library.
- Run the Python 3 script: addons/gdcef/build.py
- The script is preconfigured but can be customized at the top.

Build Process (takes 5–15 minutes):
* Downloads and compiles godot-cpp.
* Downloads and extracts prebuilt CEF.
* Compiles gdCEF.

Requirements:
* Python 3 with necessary packages.
* Build tools: SCons, CMake, Make or Ninja.
* On macOS: Xcode Command Line Tools.
* On Windows: Visual Studio, Windows SDK, console with admin rights.

After compilation, you can try the demo scenes in:
addons/gdcef/demos

Documentation
=============

- Installation Guide:
https://github.com/Lecrapouille/gdcef/blob/godot-4.x/addons/gdcef/doc/installation.md

- API Reference:
https://github.com/Lecrapouille/gdcef/blob/godot-4.x/addons/gdcef/doc/API.md

- Design Details:
https://github.com/Lecrapouille/gdcef/blob/godot-4.x/addons/gdcef/doc/detailsdesign.md

- Demos Info:
https://github.com/Lecrapouille/gdcef/blob/godot-4.x/addons/gdcef/demos/README.md

- FAQ:
https://github.com/Lecrapouille/gdcef/blob/godot-4.x/addons/gdcef/README.md#faq

Community & Support
===================

For help with installation or general questions, join our Discord:
https://discord.gg/EckEwy7S5U