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

Conversation

Chubercik
Copy link
Contributor

This PR introduces a README file to the thirdparty directory, akin to how it's done over in Godot's repository.

The reasoning behind this addition is to ease the process of updating thirdparty libraries.

As of right now, the list is not complete (see all the "TODO"s and "?") - I tried being as thorough as I can, but I am not able to deduce everything in a reasonable time, so I'd like to ask all those responsible for introducing these libraries (possibly all of them can be traced back to Zylann) to come forward and aid me in putting all relevant and accurate information here 😅


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.


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.


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.


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


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.

@Chubercik
Copy link
Contributor Author

Fuzzer seems to have fallen victim to an OOM error 😬

@Zylann
Copy link
Owner

Zylann commented May 16, 2024

It's been like that for months. I don't know how to fix this, Godot is just too big to build with sanitizers on Github Actions, even with a good linker

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants