Add a note about the bundled enet submodule

This commit is contained in:
Cameron Gutman
2016-03-09 21:20:48 -08:00
parent 04b00f9e8a
commit 5d89f671e4

View File

@@ -7,3 +7,7 @@ Moonlight-common-c contains common C code between [Moonlight](http://moonlight-s
If you are implementing your own Moonlight game streaming client that can use a C library, you will need the code here.
It implements the actual GameStream protocol.
## Note to Developers
Moonlight-common-c requires the _specific_ version of ENet that is bundled as a submodule. This version has changes required for IPv6 compatibility and retransmission reliability, among other things. These are breaking API/ABI changes which make Moonlight-common-c incompatible with other versions of the ENet library. Attempting to runtime link to another libenet library will cause your client to crash when connecting to recent versions of GeForce Experience.