diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 52 |
1 files changed, 52 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..08da93e --- /dev/null +++ b/README.md @@ -0,0 +1,52 @@ +neo-curl arrives from the future +================================ + +Drop-in replacement for the [neocurl] SourceMod extension, in turn a drop-in +replacement for the ancient [SourceMod cURL] extension. + +* Builds with AMBuild instead of make, if for no other reason than to get + cflags straight from the horse's mouth. +* Gets rid of vendored OpenSSL and cURL, and their + _vendored binary dependencies_. +* Gets rid of `smsdk_ext.{c,h}` as those can be referenced from SourceMod. + +Building +-------- + + python configure.py --mms-path /path/metamod --sm-path /path/sourcemod + ambuild + +Requirements: +* AMBuild +* SourceMod +* MetaMod: Source +* pkg-config, which should be able to find static 32-bit: + * openssl + * libcurl, which for parity with neocurl, should apparently be built with at + least: + * brotli + * zlib + * zstd + * gsasl + * nghttp2 + * ngtcp2 + * ssh2 + * openssl >= 3.3 for QUIC + +Upon success, you will find `build/package/addons`, ready to overlay on your +server directory. + +Releases +-------- + +Given the rate at which CVEs appear in OpenSSL, prepackaged static builds would +be irresponsible. You are encouraged to find a way to maintain builds against +up-to-date system libraries. + +Licensing +--------- + +See COPYING. + +[neocurl]: https://github.com/sapphonie/SM-neocurl-ext +[SourceMod cURL]: https://code.google.com/archive/p/sourcemod-curl-extension
\ No newline at end of file |