Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/realtriassic/linearpaper
A fork of Paper that implements the experimental Linear region file in the Minecraft dedicated server.
https://github.com/realtriassic/linearpaper
bukkit hacktoberfest java minecraft minecraft-server paper spigot
Last synced: 6 days ago
JSON representation
A fork of Paper that implements the experimental Linear region file in the Minecraft dedicated server.
- Host: GitHub
- URL: https://github.com/realtriassic/linearpaper
- Owner: RealTriassic
- License: mit
- Created: 2023-09-23T11:11:21.000Z (over 1 year ago)
- Default Branch: ver/1.21.1
- Last Pushed: 2024-10-21T01:26:30.000Z (3 months ago)
- Last Synced: 2024-10-21T14:11:47.528Z (3 months ago)
- Topics: bukkit, hacktoberfest, java, minecraft, minecraft-server, paper, spigot
- Language: Shell
- Homepage:
- Size: 701 KB
- Stars: 70
- Watchers: 2
- Forks: 8
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# LinearPaper
A fork of [Paper](https://github.com/PaperMC/Paper) which adds support for the **experimental** [Linear region file format](https://github.com/xymb-endcrystalme/LinearRegionFileFormatTools) to the dedicated server.
> [!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**.
## 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
```yml
linear:
flush-frequency: 10
flush-max-threads: 1
```
### Per-world Configuration
```yml
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
```sh
git clone https://github.com/RealTriassic/LinearPaper.git
```
2. #### Change directory to LinearPaper
```sh
cd LinearPaper
```
4. #### Apply Patches
```sh
./gradlew applyPatches
```
4. #### Create Paperclip Jar
```sh
./gradlew createMojmapPaperclipJar
```
You will find a compiled Paperclip Jar file in `build/libs/`.
## Credits
- [**Xymb**](https://github.com/xymb-endcrystalme) - Created the Linear region file format.
- [**Kaiiju**](https://github.com/KaiijuMC/Kaiiju) - Linear-related patches have been borrowed from this repository.