Skip to content
This repository was archived by the owner on Apr 11, 2025. It is now read-only.

Latest commit

 

History

History
58 lines (47 loc) · 2.45 KB

README.md

File metadata and controls

58 lines (47 loc) · 2.45 KB

LinearPaper

A fork of Paper which adds support for the experimental Linear region file format to the dedicated server.

Warning

This project is no longer maintained and is now formally archived. As mentioned in #16 (comment), I do not have any motivation to keep maintaining this software, especially considering all the large changes Paper has been making, which increases the amount of work required to keep this project going and as I do not have any use for this software any longer, I cannot justify such time investment, the software should remain functional on 1.21.1, but it will no longer be receiving any updates.

Configuration

Caution

Starting with Minecraft 1.20.6, we are based on Paper, instead of Purpur. All Linear configuration options have been migrated to config/linear.yml, the format is pretty much almost the same as before. You need to manually update your configuration.

All configuration regarding anything Linear-related is stored in config/linear.yml. You must restart your server for any edits to be applied, reloading is not supported and may even break your server.

Global Configuration

linear:
  flush-frequency: 10
  flush-max-threads: 1

Per-world Configuration

format: ANVIL # Change this to "LINEAR" to use the Linear region format.
  linear:
    compression-level: 1

Plugin compatibility

Important

Generally, all plugins that run on Paper should run on LinearPaper exactly the same, but if the plugin needs to access the region files directly by reading the .mca region files, it isn't going to be able to do so and may cause errors and unexpected behaviour. Plugin developers need to manually update their plugins to support Linear.

Compiling

  1. Clone LinearPaper

git clone https://github.com/RealTriassic/LinearPaper.git
  1. Change directory to LinearPaper

cd LinearPaper
  1. Apply Patches

./gradlew applyPatches
  1. Create Paperclip Jar

./gradlew createMojmapPaperclipJar

You will find a compiled Paperclip Jar file in build/libs/.

Credits

  • Xymb - Created the Linear region file format.
  • Kaiiju - Linear-related patches have been borrowed from this repository.