diff options
Diffstat (limited to 'thirdparty/README.md')
| -rw-r--r-- | thirdparty/README.md | 104 |
1 files changed, 79 insertions, 25 deletions
diff --git a/thirdparty/README.md b/thirdparty/README.md index 27cfe41238..934d719ca6 100644 --- a/thirdparty/README.md +++ b/thirdparty/README.md @@ -1,5 +1,10 @@ # Third party libraries +Please keep categories (`##` level) listed alphabetically and matching their +respective folder names. Use two empty lines to separate categories for +readability. +Subcategories (`###` level) where needed are separated by a single empty line. + ## assimp @@ -8,25 +13,23 @@ - License: BSD-3-Clause -## b2d_convexdecomp +## basis_universal -- Upstream: https://github.com/erincatto/Box2D/tree/master/Contributions/Utilities/ConvexDecomposition -- Version: git (25615e0, 2015) with modifications -- License: zlib +- Upstream: https://github.com/BinomialLLC/basis_universal +- Version: git (895ee8e, 2020) +- License: Apache 2.0 -The files were adapted to Godot by removing the dependency on b2Math (replacing -it by b2Glue.h) and commenting out some verbose printf calls. -Upstream code has not changed in 10 years, no need to keep track of changes. +Files extracted from upstream source: -Important: Some files have Godot-made changes. -They are marked with `// -- GODOT start --` and `// -- GODOT end --` -comments. +- `.cpp` and `.h` files in root folder +- `.cpp`, `.h` and `.inc` files in `transcoder/`, keeping folder structure +- `LICENSE` ## bullet - Upstream: https://github.com/bulletphysics/bullet3 -- Version: git (5ec8339, 2019) +- Version: 2.89 - License: zlib Files extracted from upstream source: @@ -61,7 +64,7 @@ Files extracted from upstream source: ## enet - Upstream: http://enet.bespin.org -- Version: 1.3.13 +- Version: 1.3.14 (0eaf48e, 2019) - License: MIT Files extracted from upstream source: @@ -72,12 +75,14 @@ Files extracted from upstream source: Important: enet.h, host.c, protocol.c have been slightly modified to be usable by godot socket implementation and allow IPv6. +Apply the patch in the `patches/` folder when syncing on newer upstream +commits. + Two files (godot.cpp and enet/godot.h) have been added to provide enet socket implementation using Godot classes. + It is still possible to build against a system wide ENet but doing so will limit it's functionality to IPv4 only. -Check the diff of enet.h, protocol.c, and host.c with the 1.3.13 -tarball before the next update. ## etc2comp @@ -143,6 +148,16 @@ See the header of glad.c for instructions on how to generate them for the GLES version Godot targets. +## glslang + +- Upstream: https://github.com/KhronosGroup/glslang +- Version: rev.3226 +- License: glslang + +Important: File `glslang/glslang/Include/Common.h` has +Godot-made change marked with `// -- GODOT --` comments. + + ## jpeg-compressor - Upstream: https://github.com/richgel999/jpeg-compressor @@ -250,7 +265,7 @@ from the Android NDK r18. ## libwebp - Upstream: https://chromium.googlesource.com/webm/libwebp/ -- Version: 1.0.3 +- Version: 1.1.0 - License: BSD-3-Clause Files extracted from upstream source: @@ -266,10 +281,11 @@ changes are marked with `// -- GODOT --` comments. ## mbedtls - Upstream: https://tls.mbed.org/ -- Version: 2.16.3 +- Version: 2.16.4 - License: Apache 2.0 File extracted from upstream release tarball (`-apache.tgz` variant): + - All `*.h` from `include/mbedtls/` to `thirdparty/mbedtls/include/mbedtls/` - All `*.c` from `library/` to `thirdparty/mbedtls/library/` - LICENSE and apache-2.0.txt files @@ -293,6 +309,7 @@ Files extracted from upstream source: - All `*.c` and `*.h` files from `miniupnpc` to `thirdparty/miniupnpc/miniupnpc` - Remove `test*`, `minihttptestserver.c` and `wingenminiupnpcstrings.c` +The patch `windows_fix.diff` is applied to `minissdpc.c` to fix an upstream issue. The only modified file is miniupnpcstrings.h, which was created for Godot (it is usually autogenerated by cmake). @@ -397,19 +414,17 @@ Files extracted from the upstream source: ## opus - Upstream: https://opus-codec.org -- Version: 1.3.1 (opus) and 0.11 (opusfile) +- Version: 1.1.5 (opus) and 0.8 (opusfile) - License: BSD-3-Clause Files extracted from upstream source: -- Run `opus/configure` and copy/sync changes to `config.h` - (note that this file may have Godot-specific options enabled) - all .c and .h files in src/ (both opus and opusfile) - all .h files in include/ (both opus and opusfile) as opus/ - remove unused `opus_demo.c`, - remove `http.c`, `wincerts.c` and `winerrno.h` (part of unused libopusurl) -- celt/ and silk/ subfolders (minus tests folders) +- celt/ and silk/ subfolders - COPYING @@ -445,7 +460,7 @@ Files extracted from upstream source: ## recastnavigation - Upstream: https://github.com/recastnavigation/recastnavigation -- version: git (ef3ea40f, 2017) +- Version: git (ef3ea40f, 2017) - License: zlib Files extracted from upstream source: @@ -454,6 +469,22 @@ Files extracted from upstream source: - License.txt +## Rvo2 + +- Upstream: http://gamma.cs.unc.edu/RVO2/ +- Version: 3D - 1.0.1 +- License: Apache 2.0 + +Files extracted from upstream source: + +- All .cpp and .h files in the `src/` folder except for RVO.h, RVOSimulator.cpp and RVOSimulator.h +- LICENSE + +Important: Some files have Godot-made changes; so to enrich the features +originally proposed by this library and better integrate this library with +Godot. Please check the file to know what's new. + + ## squish - Upstream: https://sourceforge.net/projects/libsquish @@ -497,6 +528,31 @@ They can be reapplied using the patches included in the `vhacd` folder. +## vulkan + +- Upstream: https://github.com/KhronosGroup/Vulkan-Loader +- Version: 1.1.127 +- License: Apache 2.0 + +Unless there is a specific reason to package a more recent version, please stick +to Vulkan SDK releases (prefixed by `sdk-`) for all components. + +NOTE: Use `scripts/update_deps.py --ref <version>` in the Loader git repository +to retrieve the `Vulkan-Headers` repository matching the loader version. + +Files extracted from upstream source: + +- `Vulkan-Headers/include/` as `include/` +- All `.c` and `.h` files in `loader/` and `loader/generated/`, put in a common + `loader/` folder +- `LICENSE.txt` + +`vk_enum_string_helper.h` is taken from the match `Vulkan-ValidationLayers` SDK +release: https://github.com/KhronosGroup/Vulkan-Loader/tree/master/loader/generated + +`vk_mem_alloc.h` is taken from https://github.com/GPUOpen-LibrariesAndSDKs/VulkanMemoryAllocator + + ## wslay - Upstream: https://github.com/tatsuhiro-t/wslay @@ -513,15 +569,13 @@ File extracted from upstream release tarball: ## xatlas - Upstream: https://github.com/jpcy/xatlas -- Version: git (b4b5426, 2019) +- Version: git (e12ea82, 2019) - License: MIT Files extracted from upstream source: - `xatlas.{cpp,h}` - -Note: License is marked as Public Domain in the files, but it was -later clarified upstream to MIT license. +- `LICENSE` ## zlib |