Change CEF Version

Table of Contents

• 1. Select a CEF Version
• 2. Update the Script Configuration File
• 3. Run the Update Script
  • 4. Verify the Update
  • 5. Troubleshooting

UCefView is designed to be flexible, allowing you to update the underlying Chromium Embedded Framework (CEF) to a version that best suits your project's needs. Whether you need the latest web features, critical security patches, or compatibility with a specific Chromium version, you can easily switch the CEF binaries used by the plugin. This guide will walk you through the process.

1. Select a CEF Version

1. Visit the CEF Builds page.

   Note

   The page lists builds for different branches (Stable, Beta, Dev). For production use, it is highly recommended to choose a Stable build.

2. Identify the desired CEF version compatible with your project's requirements.
3. Copy the full version string. It will look something like this: 126.2.18+g3647d39+chromium-126.0.6478.183.

Important

Before changing the version, it is strongly recommended to check the commit history of the CefViewCore repository to see which CEF versions are officially tested and supported. Major CEF updates often contain breaking API changes that may require corresponding updates to the CefViewCore wrapper.

2. Update the Script Configuration File

1. Open the configuration file used by your update script

   ‍UCefView/Scripts/UpdateThirdparty/ThirdParty-Config.txt

2. Update the CEF_VERSION variable with the version string you copied in the previous step.

   # The repository for the CefViewCore wrapper library.
   CORE_REPO=https://github.com/CefView/CefViewCore.git
    
   # The specific commit hash of the CefViewCore wrapper to use.
   CORE_VERSION=8b618d4290c9187eedfb8b176aae8a7dfcaa51ab
    
   # The build configuration for the wrapper library (usually Release).
   CORE_BUILD_TYPE=Release
    
   # The name of the CEF helper executable.
   CEF_HELPER_NAME=UCefViewHelper
    
   # The target CEF version to download and build against.
   CEF_VERSION=126.2.18+g3647d39+chromium-126.0.6478.183

Warning

If you are making a significant jump in CEF versions, you may also need to update the CORE_VERSION to a newer commit hash that supports the new CEF API. Check the CefViewCore repository for the appropriate commit.

3. Run the Update Script

Run the script corresponding to your operating system. This script will download the specified CEF binaries and recompile the CefViewCore library against them.

• On Windows: powershell @section autotoc_md36 From the UCefView/Scripts/UpdateThirdparty/ directory ./Update-Thirdparty.ps1
• On macOS or Linux: bash @section autotoc_md37 From the UCefView/Scripts/UpdateThirdparty/ directory ./Update-Thirdparty.sh

4. Verify the Update

After the script completes successfully, launch your Unreal Engine project. The new CEF version will be logged to the Output Log during engine startup.

You can search for the log entry LogUCefView: Using CEF version.

5. Troubleshooting

• Build Failures: If the Update-Thirdparty script fails during the compilation of CefViewCore, it is likely due to an API mismatch between the selected CEF_VERSION and the CORE_VERSION. Ensure you are using a compatible pair of versions.
• Runtime Errors: If the project crashes on startup, check the logs for any errors related to loading the CEF framework or the UCefView plugin modules.