-
Notifications
You must be signed in to change notification settings - Fork 26
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into reroute-audio
- Loading branch information
Showing
2 changed files
with
25 additions
and
51 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,51 +1,25 @@ | ||
# Chromium Embedded Framework as Godot 3.5 native module | ||
# Chromium Embedded Framework Webview for Godot | ||
|
||
This repository contains the source code of some C++ classes wrapping a subset | ||
of the [Chromium Embedded Framework](https://bitbucket.org/chromiumembedded/cef/wiki/Home) | ||
API into a Godot 3.4 or Godot 3.5 native module (GDNative) which allows you to | ||
implement a web browser for your 2D and 3D games through your gdscripts for | ||
Linux and Windows. We have named this CEF GDNative module `gdcef`. | ||
|
||
This module can be downloaded directly from the Godot asset library: | ||
|
||
https://godotengine.org/asset-library/asset/1426 | ||
|
||
*Note:* This current repository is a fork of [the following | ||
repo](https://github.com/stigmee/gdnative-cef) (under GPLv3) with a more | ||
permissive license (MIT). Since the original repo is no longer maintained | ||
by their two original authors (Alain and Quentin), we, the undersigned Alain | ||
and Quentin, gave consent to relicensing the original code under the | ||
MIT license. | ||
|
||
## Documentation | ||
|
||
Since this current README is not taken when importing this module from the Godot asset | ||
library, all details are referred in the following | ||
[document](addons/gdcef/README.md) which explains you how to build | ||
this module, how to run demos, describe the architecture, details design and | ||
more ... | ||
|
||
## TL;DR: Installation | ||
|
||
To compile this project with the Python3 build script for Linux and Windows: | ||
|
||
``` | ||
cd addons/gdcef | ||
python3 -m pip install -r requirements.txt | ||
./build.py | ||
``` | ||
|
||
This will generate artifacts in the `build/` folder. Use this folder for your Godot | ||
project and add gdns and gdnlib files to refer `libgdcef.so` or `libgdcef.dll`. | ||
|
||
## Gallery | ||
|
||
Projects interested in / using this module. Please do not hesitate to share your | ||
project links and pictures by making a GitHub pull request. | ||
|
||
- https://elitemeta.city/ | ||
|
||
Click to see on the image to see the Elitemeta video shared on IPFS. | ||
[![elitemeta](addons/gdcef/doc/gallery/elitemeta.jpg)](https://ipfs.io/ipfs/QmaL7NY5qs3AtAdcX8vFhqaHwJeTMKfP3PbzcHZBLmo1QQ?filename=elitemeta_0.mp4) | ||
Thanks to the team for having shared this video. | ||
|
||
of the [Chromium Embedded | ||
Framework](https://bitbucket.org/chromiumembedded/cef/wiki/Home) (CEF for | ||
shorter) [API](https://magpcss.org/ceforum/apidocs/) compiled to be used either | ||
as a Godot 3.5 native module (GDNative) or Godot 4.2 extension (GDExtension) | ||
which allows you to implement a webview for your 2D and 3D games through your | ||
gdscripts for Linux and Windows (Mac OS could work, but help is needed). | ||
|
||
We have named this CEF module/extension `gdcef`. It can be downloaded directly | ||
from the Godot asset library: | ||
- For Godot 3.5: https://godotengine.org/asset-library/asset/1426 | ||
- For Godot 4.2: https://godotengine.org/asset-library/asset/2508 | ||
|
||
For developers, since Godot 3.x GDNative and Godot 4.x GDExtension are not | ||
compatible, there are two branches: | ||
- https://github.com/Lecrapouille/gdcef/tree/godot-3.x for Godot 3.4 or 3.5. | ||
- https://github.com/Lecrapouille/gdcef/tree/godot-4.x for Godot 4.2 and later. | ||
- Note: Godot before 3.4, Godot 4.0 and 4.1 versions have not been tested and | ||
are not be supported. | ||
|
||
For developers, you have to do: | ||
- `git checkout godot-3.x` for developing GDNative version for Godot 3.4 or 3.5. | ||
- `git checkout godot-4.x` for developing GDExtension version for Godot 4.2 and later. |