ContextQMD
Back to Redot Engine

Third party libraries

thirdparty/README.md

latest34.6 KB
Original Source

Third party libraries

Please keep categories (## level) listed alphabetically and matching their respective folder names. Use two empty lines to separate categories for readability.

accesskit

Files extracted from upstream source:

  • accesskit.h
  • LICENSE-MIT

amd-fsr

Files extracted from upstream source:

  • ffx_a.h and ffx_fsr1.h from ffx-fsr
  • license.txt

amd-fsr2

Files extracted from upstream source:

  • ffx_*.cpp and ffx_*.h from src/ffx-fsr2-api
  • shaders folder from src/ffx-fsr2-api with ffx_*.hlsl files excluded
  • LICENSE.txt

Patches:

  • 0001-build-fixes.patch (GH-81197)
  • 0002-godot-fsr2-options.patch (GH-81197)

angle

Files extracted from upstream source:

  • include/*
  • LICENSE

astcenc

Files extracted from upstream source:

  • astcenc_* and astcenc.h files from Source
  • LICENSE.txt

basis_universal

Files extracted from upstream source:

  • encoder/ and transcoder/ folders, with the following files removed from encoder: 3rdparty/{qoi.h,tinydds.h,tinyexr.cpp,tinyexr.h}
  • LICENSE

Patches:

  • 0001-external-zstd-pr344.patch (GH-73441)
  • 0002-external-tinyexr.patch (GH-97582)
  • 0003-remove-tinydds-qoi.patch (GH-97582)
  • 0004-ambiguous-calls.patch (GH-103968)
  • 0005-msvc-include-ctype.patch (GH-106155)

brotli

Files extracted from upstream source:

  • common/, dec/ and include/ folders from c/, minus the dictionary.bin* files
  • LICENSE

certs

  • Upstream: Mozilla, via https://github.com/bagder/ca-bundle
  • Version: git (bcc414c5b5282f9321651bf71dc1e254ae87e3f8, 2025), generated from mozilla-release changeset 60d4997d339bb7ac6d033819ac50dcad4b9be09d
  • License: MPL 2.0

Files extracted from upstream source:

  • ca-bundle.crt renamed to ca-certificates.crt

clipper2

Files extracted from upstream source:

  • CPP/Clipper2Lib/ folder (in root)
  • LICENSE

Patches:

  • 0001-disable-exceptions.patch (GH-80796)

cvtt

Files extracted from upstream source:

  • All .cpp and .h files except the folders MakeTables and etc2packer
  • LICENSE.txt

Patches:

  • 0001-revert-bc6h-reorg.patch (GH-73715)

d3d12ma

Files extracted from upstream source:

  • src/D3D12MemAlloc.cpp, src/D3D12MemAlloc.natvis
  • include/D3D12MemAlloc.h
  • LICENSE.txt, NOTICES.txt

Patches:

  • 0001-mingw-support.patch (GH-83452)

directx_headers

Files extracted from upstream source:

  • include/directx/*.h
  • include/dxguids/*.h
  • LICENSE

Patches:

  • 0001-mingw-pragma.patch (GH-83452)
  • 0002-win7-8-dynamic-load.patch (GH-88496)

doctest

Files extracted from upstream source:

  • doctest/doctest.h as doctest.h
  • LICENSE.txt

Patches:

  • 0001-ciso646-version.patch (GH-105913)

embree

Files extracted from upstream:

  • All .cpp files listed in modules/raycast/godot_update_embree.py
  • All header files in the directories listed in modules/raycast/godot_update_embree.py
  • All config files listed in modules/raycast/godot_update_embree.py
  • LICENSE.txt

Patches:

  • 0001-disable-exceptions.patch (GH-48050)
  • 0002-godot-config.patch (GH-88783)
  • 0003-emscripten-nthreads.patch (GH-69799)
  • 0004-mingw-no-cpuidex.patch (GH-92488)
  • 0005-mingw-llvm-arm64.patch (GH-93364)

The modules/raycast/godot_update_embree.py script can be used to pull the relevant files from the latest Embree release and apply patches automatically.

enet

Files extracted from upstream source:

  • All .c files in the main directory (except unix.c and win32.c)
  • The include/enet/ folder as enet/ (except unix.h and win32.h)
  • LICENSE file
  • Added 3 files enet_godot.cpp, enet/enet_godot.h, and enet/enet_godot_ext.h, providing ENet socket implementation using Godot classes, allowing IPv6 and DTLS.

Patches:

  • 0001-godot-socket.patch (GH-7985)

Important: Building against a system wide ENet is possible, but will limit its functionality to IPv4 only and no DTLS. We recommend against it.

etcpak

Files extracted from upstream source:

  • Only the files relevant for compression (i.e. Process*.cpp and their deps): 
    Dither.{cpp,hpp} ForceInline.hpp Math.hpp ProcessCommon.hpp ProcessRGB.{cpp,hpp}
ProcessDxtc.{cpp,hpp} Tables.{cpp,hpp} Vector.hpp
  • The files DecodeRGB.{cpp.hpp} are based on the code from the original repository.
  • AUTHORS.txt and LICENSE.txt

Patches:

  • 0001-remove-bc7enc.patch (GH-101362)

fonts

All fonts are converted from the unhinted .ttf sources using the https://github.com/google/woff2 tool.

Use UI font variant if available, because it has tight vertical metrics and good for UI.

freetype

  • Upstream: https://www.freetype.org
  • Version: 2.13.3 (42608f77f20749dd6ddc9e0536788eaad70ea4b5, 2024)
  • License: FreeType License (BSD-like)

Files extracted from upstream source:

  • src/ folder, minus the dlg and tools subfolders
    • These files can be removed: .dat, .diff, .mk, .rc, README*
    • In src/gzip/, keep only ftgzip.c
  • include/ folder, minus the dlg subfolder
  • LICENSE.TXT and docs/FTL.TXT

giflib

Files extracted from upstream source:

  • gif_err.c
  • gif_lib.h
  • dgif_lib.c
  • egif_lib.c
  • gifalloc.c
  • gif_hash.{c,h}
  • gif_lib_private.h
  • openbsd-reallocarray.c
  • COPYING

glad

Files extracted from upstream source:

  • LICENSE

Files generated from upstream web instance:

  • EGL/eglplatform.h
  • KHR/khrplatform.h
  • egl.c
  • glad/egl.h
  • gl.c
  • glad/gl.h
  • glx.c
  • glad/glx.h

See the permalinks in glad/gl.h and glad/glx.h to regenerate the files with a new version of the web instance.

Patches:

  • 0001-enable-both-gl-and-gles.patch (GH-72831)

glslang

Version should be kept in sync with the one of the used Vulkan SDK (see vulkan section).

Files extracted from upstream source:

  • glslang/ folder (except the glslang/HLSL and glslang/ExtensionHeaders subfolders), SPIRV/ folder
    • Remove C interface code: CInterface/ folders, files matching "*_c[_\.]*"
  • Run cmake . && make and copy generated include/glslang/build_info.h to glslang/build_info.h
  • LICENSE.txt
  • Unnecessary files like CMakeLists.txt or updateGrammar removed

Patches:

  • 0001-apple-disable-absolute-paths.patch (GH-92010)
  • 0002-gcc15-include-fix.patch (GH-102022)

graphite

Files extracted from upstream source:

  • The include folder
  • The src folder (minus CMakeLists.txt and files.mk)
  • COPYING

grisu2

Files extracted from upstream source:

  • The src/to_chars.cpp file renamed to grisu2.h and slightly modified.

Patches:

  • 0001-godot-changes.patch (GH-98750)

harfbuzz

Files extracted from upstream source:

  • AUTHORS, COPYING, THANKS
  • From the src folder, recursively:
    • All the .cc, .h, .hh files
    • Except main.cc, harfbuzz*.cc, failing-alloc.c, test*.cc, hb-wasm*.*, hb-harfrust.cc, wasm/*, ms-use/*, rust/*

hidapi

Files extracted from upstream source:

  • See thirdparty/sdl/update-sdl.sh

The source code of this library is being bundled with SDL's source code files. The files of hidapi are stored in thirdparty/sdl/hidapi/ folder.

icu4c

Files extracted from upstream source:

  • The common folder
  • scriptset.*, ucln_in.*, uspoof.cpp and uspoof_impl.* from the i18n folder
  • uspoof.h from the i18n/unicode folder
  • LICENSE

Files generated from upstream source:

  1. Download and extract both icu4c-{version}-src.tgz and icu4c-{version}-data.zip (replace data subfolder from the main source archive)
  2. Build ICU with default options: ./runConfigureICU {PLATFORM} && make
  3. Reconfigure ICU with custom data config: ICU_DATA_FILTER_FILE={GODOT_SOURCE}/thirdparty/icu4c/godot_data.json ./runConfigureICU {PLATFORM} --with-data-packaging=common
  4. Delete data/out folder and rebuild data: cd data && rm -rf ./out && make
  5. Copy source/data/out/icudt{ICU_VERSION}l.dat to the {GODOT_SOURCE}/thirdparty/icu4c/icudt_godot.dat

jolt_physics

Files extracted from upstream source:

  • All files in Jolt/, except Jolt/Jolt.cmake and any files dependent on ENABLE_OBJECT_STREAM, as seen in Jolt/Jolt.cmake
  • LICENSE

libbacktrace

Files extracted from upstream source:

  • *.{c,h} files for Windows platform, i.e. remove the following:
    • allocfail.c, instrumented_alloc.c, *test*.{c,h}
    • elf.c, macho.c, mmap.c, mmapio.c, nounwind.c, unknown.c, xcoff.c
  • LICENSE

Patches:

  • 0001-big-files-support.patch (GH-100281)

libjpeg-turbo

Files extracted from upstream source:

  • src/*.{c,h} except for:
    • cdjpeg.c cjpeg.c djpeg.c example.c jcdiffct.c jclhuff.c jclossls.c jcstest.c jddiffct.c jdlhuff.c jdlossls.c jlossls.h jpegtran.c rdbmp.c rdcolmap.c rdgif.c rdjpgcom.c rdppm.c rdswitch.c rdtarga.c strtest.c tjbench.c tjcomp.c tjdecomp.c tjtran.c tjunittest.c tjutil.c wrbmp.c wrgif.c wrjpgcom.c wrppm.c wrtarga.c
  • LICENSE.md
  • README.ijg

Patches:

  • 0001-cmake-generated-headers.patch (GH-104347)
  • 0002-disable-16bitlossless.patch (GH-104347)
  • 0003-remove-bmp-ppm-support.patch (GH-104347)

libktx

Files extracted from upstream source:

  • LICENSE.md
  • include/ minus .clang-format
  • external/dfdutils/LICENSE.adoc as LICENSE.dfdutils.adoc (in root)
  • external/dfdutils/LICENSES/Apache-2.0.txt as Apache-2.0.txt (in root)
  • external/dfdutils/{KHR/,dfd.h,colourspaces.c,createdfd.c,interpretdfd.c,printdfd.c,queries.c,dfd2vk.inl,vk2dfd.*}
  • lib/{basis_sgd.h,formatsize.h,gl_format.h,ktxint.h,uthash.h,vk_format.h,vkformat_enum.h,checkheader.c,swap.c,hashlist.c,vkformat_check.c,vkformat_typesize.c,basis_transcode.cpp,miniz_wrapper.cpp,filestream.*,memstream.*,texture*}
  • other_include/KHR/
  • utils/unused.h

Patches:

  • 0001-external-basisu.patch (GH-76572)
  • 0002-disable-astc-block-ext.patch (GH-76572)
  • 0003-basisu-1.60.patch (GH-103968)

libogg

  • Upstream: https://www.xiph.org/ogg
  • Version: 1.3.5 (e1774cd77f471443541596e09078e78fdc342e4f, 2021)
  • License: BSD-3-Clause

Files extracted from upstream source:

  • src/*.{c,h}
  • include/ogg/*.h in ogg/ (run configure to generate config_types.h)
  • COPYING

libpng

Files extracted from upstream source:

  • All .c and .h files of the main directory, apart from example.c and pngtest.c
  • arm/, intel/, loongarch/, and powerpc/ folders, except arm/filter_neon.S and .editorconfig files
  • scripts/pnglibconf.h.prebuilt as pnglibconf.h
  • LICENSE

Patches:

  • 0001-add-png.patch (Redot GH-937)

libtheora

  • Upstream: https://www.theora.org
  • Version: 1.2.0 (8e4808736e9c181b971306cc3f05df9e61354004, 2025)
  • License: BSD-3-Clause

Files extracted from upstream source:

  • All .c and .h files in lib/, except arm/ and c64x/ folders
  • All .h files in include/theora/ as theora/
  • COPYING and LICENSE

libvorbis

Files extracted from upstream source:

  • lib/* except from: lookups.pl, Makefile.*
  • include/vorbis/*.h as vorbis/
  • COPYING

libwebp

Files extracted from upstream source:

  • src/ and sharpyuv/ except from .am, .rc and .in files
  • AUTHORS, COPYING, PATENTS

Patches:

  • 0001-msvc-node-debug-rename.patch
  • 0002-msvc-arm64-fpstrict.patch
  • 0003-clang-cl-sse2-sse41.patch

linuxbsd_headers

See linuxbsd_headers/README.md.

manifold

File extracted from upstream source:

  • src/ and include/, except from CMakeLists.txt, cross_section.h and meshIO.{cpp,h}
  • AUTHORS, LICENSE

mbedtls

File extracted from upstream release tarball:

  • All .h from include/mbedtls/ to thirdparty/mbedtls/include/mbedtls/ and all .h from include/psa/ to thirdparty/mbedtls/include/psa/
  • From library/ to thirdparty/mbedtls/library/:
    • All .c and .h files
    • Except bignum_mod.c, block_cipher.c, ecp_curves_new.c, lmots.c, lms.c
  • The LICENSE file (edited to keep only the Apache 2.0 variant)
  • Added 2 files godot_core_mbedtls_platform.c and godot_core_mbedtls_config.h providing configuration for light bundling with core
  • Added 2 files godot_module_mbedtls_config.h and threading_alt.h to customize the build configuration when bundling the full library

Patches:

  • 0001-msvc-2019-psa-redeclaration.patch (GH-90535)

meshoptimizer

Files extracted from upstream repository:

  • All files in src/
  • LICENSE.md

mingw-std-threads

Files extracted from upstream repository:

  • LICENSE
  • mingw.condition_variable.h
  • mingw.invoke.h
  • mingw.mutex.h
  • mingw.shared_mutex.h
  • mingw.thread.h

Patches:

  • 0001-disable-exceptions.patch (GH-85039)
  • 0002-clang-std-replacements-leak.patch (GH-85208)

minimp3

Files extracted from upstream repository:

  • minimp3.h
  • minimp3_ex.h
  • LICENSE

Patches:

  • 0001-msvc-arm.patch (GH-64921)
  • 0002-msvc-warnings.patch (GH-66545)

miniupnpc

Files extracted from upstream source:

  • miniupnpc/src/ as src/
  • miniupnpc/include/ as include/miniupnpc/
  • Remove the following test or sample files: listdevices.c,minihttptestserver.c,miniupnpcmodule.c,upnpc.c,upnperrors.*,test*
  • LICENSE
  • src/miniupnpcstrings.h was created manually for Godot (it is usually generated by CMake). Bump the version number for miniupnpc in that file when upgrading.

minizip

Files extracted from the upstream source:

  • From contrib/minizip: {crypt.h,ioapi.{c,h},unzip.{c,h},zip.{c,h}} MiniZip64_info.txt

Patches:

  • 0001-godot-seek.patch (GH-10428)

misc

Collection of single-file libraries used in Godot components.

msdfgen

Files extracted from the upstream source:

  • msdfgen.h
  • Files in core/ folder
  • LICENSE.txt

openxr

Files extracted from upstream source:

  • include/
  • src/common/
  • src/loader/
  • src/*.{c,h}
  • src/external/jsoncpp/include/
  • src/external/jsoncpp/src/lib_json/
  • src/external/jsoncpp/{AUTHORS,LICENSE}
  • LICENSE and COPYING.adoc

Exclude:

  • src/external/android-jni-wrappers and src/external/jnipp (not used yet)
  • Obsolete src/xr_generated_dispatch_table.{c,h}
  • All CMake stuff: cmake/, CMakeLists.txt and *.cmake
  • All Gradle stuff: *gradle*, AndroidManifest.xml
  • All following files (and their .license files): *.{def,expsym,in,json,map,pom,rc,txt}
  • All dotfiles

pcre2

  • Upstream: http://www.pcre.org
  • Version: 10.46 (b2bd4254b379b9d7dc9a3dda060a7e27009ccdff, 2025)
  • License: BSD-3-Clause

Files extracted from upstream source:

  • Files listed in the file NON-AUTOTOOLS-BUILD steps 1-4
  • All .h files in src/ apart from pcre2posix.h
  • src/pcre2_jit_match.c
  • src/pcre2_jit_misc.c
  • src/pcre2_ucptables.c
  • deps/sljit/sljit_src
  • AUTHORS.md and LICENCE.md

Patches:

  • 0001-fix-format-enumerate.patch (GH-114766)
  • 0002-fix-duplicate-symbols.patch (GH-114766)

recastnavigation

Files extracted from upstream source:

  • Recast/ folder without CMakeLists.txt
  • License.txt

rvo2

For 2D in rvo2_2d folder

For 3D in rvo2_3d folder

Files extracted from upstream source:

  • All .cpp and .h files in the src/ folder except for Export.h and RVO.h
  • LICENSE

Important: Nearly all files have Godot-made changes and renames to make the 2D and 3D rvo libraries compatible with each other and solve conflicts and also enrich the feature set originally proposed by these libraries and better integrate them with Godot.

smaa

Files extracted from upstream source:

  • LICENSE
  • Textures generated using the Python scripts in the Scripts folder

sdl

Files extracted from upstream source:

  • See thirdparty/sdl/update-sdl.sh

Patches:

  • 0001-remove-unnecessary-subsystems.patch (GH-106218)
  • 0002-msvc-constants-fpstrict.patch (GH-106218)
  • 0003-std-include.patch (GH-108144)
  • 0004-errno-include.patch (GH-108354)
  • 0005-fix-libudev-dbus.patch (GH-108373)
  • 0006-fix-cs-environ.patch (GH-109283)

The SDL source code folder includes hidapi library inside of folder thirdparty/sdl/hidapi/. Its version and license is described in this file under hidapi.

spirv-cross

Files extracted from upstream source:

  • All .cpp, .hpp and .h files, minus main.cpp, spirv_cross_c.*, spirv_hlsl.*, spirv_cpp.*
  • include/ folder
  • LICENSE and LICENSES/ folder, minus CC-BY-4.0.txt

Versions of this SDK do not have to match the vulkan section, as this SDK is required to generate Metal source from Vulkan SPIR-V.

spirv-reflect

Version should be kept in sync with the one of the used Vulkan SDK (see vulkan section).

Files extracted from upstream source:

  • spirv_reflect.h, spirv_reflect.c
  • include/ folder
  • LICENSE

Patches:

  • 0001-specialization-constants.patch (GH-50325)
  • 0002-zero-size-for-sc-sized-arrays.patch (GH-94985)

swappy-frame-pacing

Files extracted from upstream source:

  • include/common/
  • include/swappy/{swappy_common.h,swappyVk.h}
  • LICENSE

thorvg

Files extracted from upstream source:

  • See thorvg/update-thorvg.sh for extraction instructions. Set the version number and run the script.

Patches:

  • 0001-revert-tvglines-bezier-precision.patch (GH-96658)
  • 0002-use-heap-alloc.patch (GH-109530)

tinyexr

Files extracted from upstream source:

  • tinyexr.{cc,h}

Patches:

  • 0001-external-zlib.patch (GH-55115)

ufbx

Files extracted from upstream source:

  • ufbx.{c,h}
  • LICENSE

vhacd

Files extracted from upstream source:

  • From src/VHACD_Lib/: inc, public and src
  • LICENSE

Patches:

  • 0001-bullet-namespace.patch (GH-27929)
  • 0002-fpermissive-fix.patch (GH-27929)
  • 0003-fix-musl-build.patch (GH-34250)
  • 0004-fix-msvc-arm-build.patch (GH-34331)
  • 0005-fix-scale-calculation.patch (GH-38506)
  • 0006-gcc13-include-fix.patch (GH-77949)

volk

Version should be kept in sync with the one of the used Vulkan SDK (see vulkan section).

Files extracted from upstream source:

  • volk.h, volk.c
  • LICENSE.md

vulkan

Unless there is a specific reason to package a more recent version, please stick to tagged SDK releases. All Vulkan libraries and headers should be kept in sync so:

  • Update Vulkan SDK components to the matching tag (see "vulkan")
  • Update volk (see "volk")
  • Update glslang (see "glslang")
  • Update spirv-reflect (see "spirv-reflect")

Files extracted from upstream source:

  • include/
  • LICENSE.md

vk_enum_string_helper.h is taken from the matching Vulkan-Utility-Libraries SDK release: https://github.com/KhronosGroup/Vulkan-Utility-Libraries/blob/main/include/vulkan/vk_enum_string_helper.h

vk_mem_alloc.h is taken from https://github.com/GPUOpen-LibrariesAndSDKs/VulkanMemoryAllocator Version: 3.1.0 (009ecd192c1289c7529bff248a16cfe896254816, 2024) vk_mem_alloc.cpp is a Godot file and should be preserved on updates.

Patches:

  • 0001-VKEnumStringHelper-godot-vulkan.patch (GH-97510)
  • 0002-VMA-godot-vulkan.patch (GH-97510)
  • 0003-VMA-add-vmaCalculateLazilyAllocatedBytes.patch (GH-99257)

wayland

Files extracted from upstream source:

  • protocol/wayland.xml
  • COPYING

wayland-protocols

Files extracted from upstream source:

  • stable/viewporter/README
  • stable/viewporter/viewporter.xml
  • stable/xdg-shell/README
  • stable/xdg-shell/xdg-shell.xml
  • staging/fractional-scale/README
  • staging/fractional-scale/fractional-scale-v1.xml
  • staging/xdg-activation/README
  • staging/xdg-activation/xdg-activation-v1.xml
  • staging/xdg-system-bell/xdg-system-bell-v1.xml
  • unstable/idle-inhibit/README
  • unstable/idle-inhibit/idle-inhibit-unstable-v1.xml
  • unstable/pointer-constraints/README
  • unstable/pointer-constraints/pointer-constraints-unstable-v1.xml
  • unstable/pointer-gestures/README
  • unstable/pointer-gestures/pointer-gestures-unstable-v1.xml
  • unstable/primary-selection/README
  • unstable/primary-selection/primary-selection-unstable-v1.xml
  • unstable/relative-pointer/README
  • unstable/relative-pointer/relative-pointer-unstable-v1.xml
  • unstable/tablet/README
  • unstable/tablet/tablet-unstable-v2.xml
  • unstable/text-input/README
  • unstable/text-input/text-input-unstable-v3.xml
  • unstable/xdg-decoration/README
  • unstable/xdg-decoration/xdg-decoration-unstable-v1.xml
  • unstable/xdg-foreign/README
  • unstable/xdg-foreign/xdg-foreign-unstable-v1.xml
  • COPYING

wslay

File extracted from upstream release tarball:

  • Run cmake . to generate config.h and wslayver.h Contents might need tweaking for Godot, review diff
  • All .c and .h files from lib/
  • All .h in lib/includes/wslay/ as wslay/
  • COPYING

Patches:

  • 0001-msvc-build-fix.patch (GH-30263)

xatlas

Files extracted from upstream source:

  • source/xatlas/xatlas.{cpp,h}
  • LICENSE

zlib

Files extracted from upstream source:

  • All .c and .h files, except gz*.c and infback.c
  • LICENSE

zstd

Files extracted from upstream source:

  • lib/{common/,compress/,decompress/,zstd.h,zstd_errors.h}
  • LICENSE