Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a README.md file for the thirdparty/ directory #638

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 67 additions & 0 deletions thirdparty/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
# Third party libraries

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


## fast_noise

- Upstream: https://github.com/Auburn/FastNoiseLite
- Version: 1.0.1+ (f5c07b98fe490b1fea59879811134ef56b4fcd7d, 2023)
- License: MIT

Files extracted from upstream source:

- `C/FastNoiseLite.h` as `FastNoiseLite.h`
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not C, it's Cpp.


Some downstream changes are yet to be split into separate git diffs;
after that's done, it will be possible to reapply them using patches
included in the `patches` folder.
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is no "patches" folder and this library changes so rarely that I didn't feel the need to do the effort of making patches. If you want this then perhaps you should add these patches to your commit, or do it in a later commit?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, no patches as of right now; I thought about adding something like this as part of the 1.1.1 update in a separate PR.



## fast_noise_2

- Upstream: https://github.com/Auburn/FastNoise2
- Version: 0.10.0-alpha+ (9b75083b87d5e391d43dc0c721d8a9fa51db735a(?), 2023)
- License: MIT

Files extracted from upstream source:

- TODO
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In this case it's pretty much the whole 0.10.0 release without the NoiseTool and with a SConscript file added to integrate to the Godot build system.



## lz4

- Upstream: https://github.com/lz4/lz4
- Version: 1.9.4 (ae179a9c16aba4dc3b6adefd440c9b77bda1a785, 2022)
- License: BSD-2-clause

Files extracted from upstream source:

- TODO
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is only lz4.h and lz4.c, bare minimum.



## meshoptimizer

- Upstream: https://github.com/zeux/meshoptimizer
- Version: git (316167c3606c4bfd7647976ca0299afa31163ea7, 2021)
- License: MIT

Files extracted from upstream source:

- TODO
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the contents of this folder: https://github.com/zeux/meshoptimizer/tree/master/src
With a custom namespace MESHOPTIMIZER_ZYLANN_NAMESPACE_BEGIN to prevent conflict with Godot's own meshoptimizer when compiling as a module.
There is also a custom change in simplifier.cpp, look for MESHOPTIMIZER_ZYLANN_NEVER_COLLAPSE_BORDERS



## sqlite

- Upstream: https://sqlite.org/download.html (source code amalgamation)
- Version: 3.45.2 (2024)
- License: MIT

Files extracted from upstream source:

- `sqlite3.c`
- `sqlite3.h`
- `sqlite3ext.h`

Loading