Modrinth · Fabric, Forge, NeoForge

LinearReader on your Minecraft server

LinearReader runs on Minecraft servers with Fabric or Forge or NeoForge. Order your server, set the loader in the panel and install the mod with one click in the mod browser.

Reduce Minecraft world size on disk.

Downloads
3.9K
Author
Bugfunbug
Loader
Fabric, Forge, NeoForge
Minecraft
1.20 – 26.3
Updated
–

Screenshots

What LinearReader looks like

All 4 images on Modrinth

Images: LinearReader on Modrinth, published by the project team.

Setup

Install LinearReader on your server

The server and players need the same loader and Minecraft version. Back up the world before adding or updating mods.

  1. 01

    Configure

    4 GB of RAM is preselected. You choose the term and add-ons and pay by credit card or PayPal.

  2. 02

    Set the loader

    In the panel, set the server software to Fabric or Forge or NeoForge and choose the matching Minecraft version, for example 26.3.

  3. 03

    Install the mod

    Search the mod browser for “LinearReader” and install the release for your loader. Alternatively, upload the .jar to the mods folder via SFTP. Required dependencies are listed on the project page.

  4. 04

    Connect

    LinearReader is not needed on the client. Players connect using the server address from the panel.

On the server
Required
On the client
Not needed
Loader
Fabric, Forge, NeoForge
Minecraft
26.3, 26.2, 26.1.2 +21 more
License
MIT License

The panel

Install mods, find errors.

Real screenshots from the Mado panel. Both come with every Minecraft server.

Mod browser

Modrinth and CurseForge, right in the panel.

The browser filters by your Minecraft version. Install mods with one click, without uploading .jar files.

Browser in the Mado panel with search, a CurseForge or Modrinth source switch and install buttons.

AI crash analysis

When a mod crashes, the analyzer reads the log.

Mods often fail on a wrong loader version, Java version or missing dependency. The analyzer names a likely cause and suggests a fix.

Optimization page in the Mado panel with the AI Log Analyzer enabled and a “Server Crashed” notice with an “Analyze Now” button.

Releases

Published releases

Pick the file that matches your server’s loader and Minecraft version. The server and players need the same release.

LinearReader · Modrinth
Original description by the project author

LinearReader

Minecraft Range
Loaders
Server-side

Compression
Wiki

LinearReader is a server-side Minecraft mod that reduces your world size without negatively impacting
gameplay. This is done mainly through using Xymb's
Linear Region File Format in
place of Minecraft's Anvil file format, and through utilizing Zstd for compression instead of
the Zlib compression algorithm used by vanilla Minecraft.

How is World Size Reduced?

Xymb's Linear Region File Format
is already a large step up from vanilla Minecraft's region file format, and greatly reduces
world sizes.

The other necessary improvement is the compression algorithm and level of compression. Higher levels
of compression require more resources and more time, which is not ideal for an active server, and
lower levels obviously do not save as much storage. So the challenge was, how can LinearReader
provide the speed of low-level compression and the storage savings of high-level compression?

LinearReader solves this by splitting the workload into two separate stages. Live writes are
compressed quickly with low-level Zstd compression levels, leaving the CPU with plenty of resources
to run Minecraft. Then later, when the server is idle, LinearReader will safely recompress the
region files with much deeper compression.

Compression Benchmarks

To show LinearReader's storage gains and why high level compression is not used during live writes,
I ran benchmarks for the Anvil file format with Zlib using Java’s default compression level (which is
what Vanilla Minecraft uses), Zstd level 4 (which is what LinearReader usually uses for live writes),
and Zstd level 22 (which LinearReader uses for recompression). For a deeper dive on the benchmarks,
see the benchmarks/ directory.

Dataset Format Original Compressed Compression Ratio Compression Speed Decompression Speed
Overworld Anvil/Zlib 6 9.51 GB 8.38 GB 5.44x 75.7 MB/s 1271.3 MB/s
Overworld LinearReader (Zstd 4) 9.51 GB 6.21 GB 7.39x 585.5 MB/s 1412.8 MB/s
Overworld LinearReader (Zstd 22) 9.51 GB 4.28 GB 10.71x 4.4 MB/s 1589.2 MB/s
End (mostly void) Anvil/Zlib 6 2.33 GB 2.16 GB 3.66x 188.4 MB/s 1576.4 MB/s
End (mostly void) LinearReader (Zstd 4) 2.33 GB 244 MB 33.20x 1811.1 MB/s 4062.7 MB/s
End (mostly void) LinearReader (Zstd 22) 2.33 Gb 141 MB 57.50x 10.1 MB/s 6166.9 MB/s
Tectonic + Terralith Anvil/Zlib 6 2.89 GB 2.56 GB 5.97x 84.1 MB/s 1338.1 MB/s
Tectonic + Terralith LinearReader (Zstd 4) 2.89 GB 1.80 GB 8.49x 735.8 MB/s 1742.8 MB/s
Tectonic + Terralith LinearReader (Zstd 22) 2.89 GB 1.24 GB 12.37x 4.4 MB/s 1787.3 MB/s

As is shown in the above table, LinearReader + Zstd achieves better compression while still
maintaining fast compression and decompression speeds during normal gameplay, (Zstd 22 is used for
the recompressor, which is not active during normal gameplay).

Other Features

LinearReader doesn't just replace Minecraft's file format and compression algorithm, it also
includes a bunch of other features, such as:

  • A backup system: LinearReader can automatically create backups of region files, which can be
    used if need be.
  • A cache system: A configurable number of recently used region files remain cached in memory,
    reducing disk reads and decompression.
  • A chunk pruning system: LinearReader can search for empty, worthless chunks that can safely be
    deleted. Strict rules are in place to ensure that only truly worthless chunks are pruned.
  • An adaptive runtime policy: LinearReader can tweak certain settings to keep the game running
    smooth.

Made with Servers in Mind

Being a server-side mod, LinearReader tries to be as helpful and informative for server admins
as possible. There are commands, such as bench and health, for seeing benchmarks and
internal metrics, and a config file so that settings can be tailored to fit the server.

(LinearReader works on singleplayer too, and players in singleplayer have access to all the
same features that server admins can access.)

Modded Servers

LinearReader strives to be compatible with as many mods as possible. Most mods will just work,
but any mods that change part of Minecraft's storage system or require reading files on
disk will likely not work. Mods that read chunk data from RAM will likely work.

A list of compatible/incompatible mods can be found in the
wiki.

If you find a mod that is incompatible with LinearReader (and is not already listed as being
incompatible), please create an issue on my
GitHub repo.

Installation and Uninstallation

To install, just download LinearReader off of CurseForge
or Modrinth, drop the .jar file in the mods folder, and
you're all set. LinearReader will handle everything from there.

To uninstall, run the command /linearreader export-mca start to convert your world's .linear
files back to .mca, replace your .linear region files with the fresh .mca files, and remove
LinearReader.

Data Safety

It is recommended to create a backup of your world before installing LinearReader, as LinearReader
changes much about Minecraft's internal storage engine and any storage-related bugs could potentially
corrupt your world. So please, make backups of your world.

Where to Learn More

This README does not provide a full, in depth explanation of all of LinearReader's features. I highly
encourage reading the wiki to gain a full
understanding of all LinearReader has to offer.

Additionally, you can ask a question on the GitHub repository by leaving an
issue. You can also use the CurseForge
comments section.

Development Status

LinearReader 1.3.0 will probably be the last major update.

I no longer plan to add much to LinearReader anymore. However, I do plan to keep LinearReader up to
date with the latest Minecraft releases for the near future.

I will still try to respond to GitHub issues, and hotfixes or small updates may happen if need be,
but my intention is for serious development of LinearReader (by me) to cease after the release of
version 1.3.0.

AI Disclaimer

AI was used to code this mod. Everything is manually tested before a new release. If you run
into any issues at all please report them on GitHub
and I will try to resolve them as fast as possible.

For more information regarding the use of AI in this mod, please refer to
AI_USAGE.md.

FAQ

LinearReader questions

Question not listed? Ask our team.

LinearReader server crashes on startup – what to do?

Common causes: the loader or Minecraft version does not match the mod file, a dependency is missing, or RAM is too low. Check the log (latest.log) for “OutOfMemoryError”, “Mixin” or missing mods. At Mado, the AI crash analysis reads the log and suggests a cause. You can change the loader and version in the panel.

Which loader does LinearReader run on?

According to Modrinth, LinearReader supports Fabric, Forge, NeoForge for Minecraft 26.3, 26.2, 26.1.2. Forge and Fabric files are not interchangeable: pick one loader for the server and clients.

How much RAM does a server with LinearReader need?

As guidance, 3–4 GB for a server with this mod. This is an estimate, not a measured minimum. More mods, many players and long view distances need more. The spark profiler shows whether a mod is costing tick time.

Ready for your server with LinearReader?

4 GB of RAM from €8.00 per month. 35% off your first month with MADO35.

Order server