0
0
mirror of https://github.com/Pumpkin-MC/Pumpkin-Website.git synced 2025-02-07 00:19:51 +00:00
Pumpkin-Website/docs/config/compression.md
Alexander Medvedev 530524b739 init
2024-12-22 19:45:25 +01:00

1.1 KiB

Compression

Compression is used to reduce the size of packets. This is beneficial to reduce bandwidth server side and also to help players on slower internet connections.

Configuring Compression

enabled: Boolean

Whether packet compression is enabled or not.

Tip

It might be beneficial to disable compression if the server is behind a proxy.

:::code-group

[packet_compression]
enabled = true

:::

threshold: Integer (0-1024)

The minimum packet size before the server attempts to compress the packet.

Caution

Increasing this value can hurt players on slower connections.

:::code-group

[packet_compression]
threshold = 256

:::

level: Integer (0-9)

A value between 0 to 9: 0 to disable compression, 1 being the fastest compression (at the cost of size), and 9 being maximum compression (at the cost of speed).

:::code-group

[packet_compression]
level = 4

:::

Default Config

By default, compression is enabled.

:::code-group

[packet_compression]
enabled = true
threshold = 256
level = 4

:::