Skip to content

Village-V-Studio/CleanPaper

Repository files navigation

CleanPaper

CleanPaper is a stripped-down fork of Paper, with unnecessary features and commands removed for stability and simplicity. Paper is the most widely used, high-performance Minecraft server that aims to fix gameplay and mechanics inconsistencies. This core does not add custom features; it simply removes or modifies built-in functionality to keep only the essentials, while allowing you to add any other features through plugins or custom development.

Original Paper by PaperMC. Paper is licensed under the GPLv3 license.

You can use CleanVelocity as a proxy server for your CleanPaper.

What was changed

  • Updated file structure:
    • Configuration files (cleanpaper.yml, paper-global.yml, paper-world-defaults.yml, spigot.yml) moved to the configs/ folder;
    • Data files (ops.json, usercache.json) moved to the data/ folder;
    • Deleted banned-ips.json, banned-players.json, bukkit.yml, commands.yml, help.yml, permissions.yml, version_history.json and whitelist.json;
  • Removed telemetry, metrics (bStats), and the automatic update checker; (0ada734)
  • Updated config files;
  • Deleted some commands and aliases; (cb511a5)
  • Deleted some server messages; (f02890f)
  • And other changes.

Download & Running

The compiled JAR file can be downloaded from the Releases section on this GitHub. Requires Java 25 or higher.

Building from Source

Requirements:

  • JDK 25+
  • Git
# Apply patches
./gradlew applyAllPatches

# Build the server JAR
./gradlew cleanpaper-server:createPaperclipJar

The built JAR will be located in cleanpaper-server/build/libs/.

Making Changes

  1. After applyAllPatches, make your changes in the generated paper-server/ or paper-api/ source
  2. Commit your changes within the respective subproject:
    cd paper-server
    git add .
    git commit -m "Description of change"
    cd ..
  3. Rebuild patches:
    ./gradlew rebuildPaperPatches rebuildServerPatches
  4. Commit the updated patch files to the main repository

Updating Paper

  1. Update paperRef in gradle.properties to the latest Paper commit hash
  2. Run ./gradlew applyAllPatches
  3. Resolve any conflicts if needed
  4. Run ./gradlew rebuildPatches

About

CleanPaper is a stripped-down and optimized fork of Paper.

Topics

Resources

Stars

Watchers

Forks

Contributors