GDCEF Godot4 0.15.0-godot4 2D Tools 4.2 Community

Submitted by user Lecrapouille; MIT; 2024-12-23

gdCEF is a web viewer plugin for Godot 4.2 and 4.3, available on Linux, Windows and MacOSX, based on the Chromium Embedded Framework (CEF) for your 2D and 3D applications.

Note 1: For Godot 3 users, gdCEF is no longer maintained but still available at: https://godotengine.org/asset-library/asset/1426
Note 2: Android and iOS devices are not supported by CEF and therefore by gdCEF.

There are three methods to install gdCEF in your project:

1. Direct Download Method:
- Download pre-built gdCEF artifacts directly from GitHub: https://github.com/Lecrapouille/gdcef/releases
- Available for Linux, Windows and MacOSX (x64 architectures only).
- Simply untar and place the cef_artifacts folder in your project.
- Limitations:
* Cannot choose CEF or Godot versions.
* Cannot customize the artifacts folder name.
* Limited to x64 architectures due to CI constraints.

2. Script-Based Download (since v0.12.0):
- Download gdCEF source code from Godot Asset Library.
- Use the provided Python3 build script (addons/gdcef/build.py).
- Folders with C++ source code can be removed as they are not compiled.
- Set GITHUB_GDCEF_RELEASE variable to your desired version.
- Run the script to download artifacts and prepare demos.
- Has the same limitations as the direct download method.

3. Compilation Method (Recommended):
- Download gdCEF source code from Godot Asset Library.
- Run the Python3 build script (addons/gdcef/build.py).
- Script is preconfigured but customizable in its first section.
- Process (5-15 minutes):
* Downloads and compiles godot-cpp.
* Downloads and compiles prebuilt CEF.
* Compiles gdCEF.
- Requirements:
* Python3 with required plugins.
* Build tools: Scons, CMake, Make or Ninja.
* For MacOSX: Xcode Command Line Tools.

Once gdCEF has been compiled, you can try demos in the addons/gdcef/demos folder.

The project also offer documentation:
- Installation: https://github.com/Lecrapouille/gdcef/blob/godot-4.x/addons/gdcef/doc/installation.md
- API: https://github.com/Lecrapouille/gdcef/blob/godot-4.x/addons/gdcef/doc/API.md
- Details Design: https://github.com/Lecrapouille/gdcef/blob/godot-4.x/addons/gdcef/doc/detailsdesign.md
- Demos: 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

Otherwise, for installation help or general questions, the best way is to join our Discord: https://discord.gg/EckEwy7S5U