This documentation is for a prerelease version of O3DE. Click here to switch to the latest release, or select a version from the dropdown.

Version:

Multiplayer Compression Gem

The Multiplayer Compression Gem provides an LZ4-based implementation of AzNetworking::ICompressor and AzNetworking::ICompressorFactory. The Gem registers the provided compressor factory with the O3DE Networking System Component. To use the Gem and its related compressor, add it to your project and set the cvars net_UdpCompressor and net_TcpCompressor to MultiplayerCompressor.

Caution:
This Gem is intended as an example of how to implement a compressor. We strongly recommend that you write a compressor (or compressors) that meets the needs of your traffic.