Skip to content

Latest commit

 

History

History
32 lines (25 loc) · 1.39 KB

README.md

File metadata and controls

32 lines (25 loc) · 1.39 KB

CompressChat

This mod is very experimental.

Also, trusting random players with not sending something malicious in chat is not a very bright idea, as well as passing random stuff through the decompression library.

If you really want to use it, the requirements are below.

Mod that passes your messages through the compression algorithm, so you could write a message longer than 256 symbols in length. In order to view compressed messages, other players should have this mod installed too.

Requirements

  1. Java 19+ with preview features enabled (add --enable-preview JVM argument)
  2. Brotli library should be available on the library path (so JVM can find and load it)

Many Linux distributions provide packages for Brotli, so you can avoid building it by yourself. Check your Linux distro's repositories for details. I have to express my deepest condolences to Windows users.

Usage

Anything between opening ($!) and closing (!$) marks is compressed. For example:

$!This part of the message is compressed,!$ but this is not compressed.

There are can be multiple compressed parts inside a single message:

$!This message!$ is $!nice!$

However, trying to write everything inside a single compressed part is a good idea, because each part is compressed separately, making it harder for compressor to make message smaller when there are a lot of them.