summaryrefslogtreecommitdiff
path: root/thirdparty/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'thirdparty/README.md')
-rw-r--r--thirdparty/README.md71
1 files changed, 70 insertions, 1 deletions
diff --git a/thirdparty/README.md b/thirdparty/README.md
index 7c3378dec3..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,6 +13,19 @@
- License: BSD-3-Clause
+## basis_universal
+
+- Upstream: https://github.com/BinomialLLC/basis_universal
+- Version: git (895ee8e, 2020)
+- License: Apache 2.0
+
+Files extracted from upstream source:
+
+- `.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
@@ -130,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
@@ -432,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:
@@ -441,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
@@ -484,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