godot/thirdparty/README.md
2020-08-14 12:40:55 +02:00

8 KiB

Third party libraries

b2d_convexdecomp

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.

certs

File extracted from a recent Fedora install: /etc/pki/ca-trust/extracted/pem/tls-ca-bundle.pem (It can't be extracted directly from the package, as it's generated on the user's system.)

fonts

Noto Sans

Use UI font if exists, because it has tight vertial metrix and good for UI.

Adobe Source Code Pro Regular

DroidSans*.ttf

freetype

Files extracted from upstream source:

  • the src/ folder, stripped of the Jamfile files
  • the include/ folder
  • docs/{FTL.TXT,LICENSE.TXT}

glew

Files extracted from upstream source:

  • src/glew.c
  • include/GL/ as GL/
  • LICENSE.txt

jpeg-compressor

Files extracted from upstream source:

  • jpgd.{c,h}

libmpcdec

Files extracted from upstream source:

  • all .c and .h files in libmpcdec/
  • include/mpc as mpc/
  • COPYING from libmpcdec/

libogg

Files extracted from upstream source:

  • src/*.c
  • include/ogg/*.h in ogg/
  • COPYING

libpng

Files extracted from upstream source:

  • all .c and .h files of the main directory, except from example.c and pngtest.c
  • the arm/ folder
  • scripts/pnglibconf.h.prebuilt as pnglibconf.h
  • LICENSE

libtheora

Files extracted from upstream source:

  • all .c, .h in lib/
  • all .h files in include/theora/ as theora/
  • COPYING and LICENSE

libvorbis

Files extracted from upstream source:

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

libwebp

Files extracted from upstream source:

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

Important: The files utils/bit_reader_utils.{c,h} have Godot-made changes to ensure they build for Javascript/HTML5. Those changes are marked with // -- GODOT -- comments.

minizip

Files extracted from the upstream source:

  • contrib/minizip/{crypt.h,ioapi.{c,h},zip.{c,h},unzip.{c,h}}

Important: Some files have Godot-made changes for use in core/io. They are marked with /* GODOT start */ and /* GODOT end */ comments and a patch is provided in the minizip/ folder.

misc

Collection of single-file libraries used in Godot components.

core

modules

scene

openssl

Files extracted from the upstream source:

  • Our openssl/: contains the headers installed in /usr/include/openssl; gather them in the source tarball with make links and cp -f include/openssl/*.h ../openssl/openssl/
  • Our crypto/: copy of upstream crypto/, with some cleanup (see below).
  • Our ssl/: copy of upstream ssl/, with some cleanup (see below).
  • Cleanup:
    find \( -name "Makefile" -o -name "*.S" -o -name "*.bat" -o -name "*.bc" \
      -o -name "*.com" -o -name "*.cnf" -o -name "*.ec" -o -name "*.fre" \
      -o -name "*.gcc" -o -name "*.in" -o -name "*.lnx" -o -name "*.m4" \
      -o -name "*.pl" -o -name "*.pod" -o -name "*.s" -o -name "*.sh" \
      -o -name "*.sol" -o -name "*test*" \) -delete
    cd openssl; for file in *.h; do find ../{crypto,ssl} -name "$file" -delete; done
    
    For the rest check the git status and decide.
  • e_os.h
  • MacOS/buildinf.h
  • LICENSE
  • Apply the Godot-specific patches in the patches/ folder (make sure not to commit .orig/.rej files generated by patch).
  • Review openssl/opensslconf.h changes and make sure they make sense for our "one size fits all" config.

opus

Files extracted from upstream source:

  • all .c and .h files in src/ (both opus and opusfile), except opus_demo.c
  • all .h files in include/ (both opus and opusfile) as opus/
  • celt/ and silk/ subfolders
  • COPYING

pvrtccompressor

Files extracted from upstream source:

  • all .cpp and .h files apart from main.cpp
  • LICENSE.TXT

rg-etc1

Files extracted from upstream source:

  • rg_etc1.{cpp,h}

rtaudio

Files extracted from upstream source:

  • RtAudio.{cpp,h}

speex

squish

Files extracted from upstream source:

  • all .cpp, .h and .inl files

zlib

Files extracted from upstream source:

  • all .c and .h files