Skip to content

AtelierMC/Atelier

Repository files navigation

Atelier

ATELIER PROJECT

MIT License Github Actions Build Join us on Discord

Atelier is a high performance fork of Pearl with the aim of modifying the source code for some specific purpose.

License

MIT License

All patches are licensed under the MIT license, unless otherwise noted in the patch headers.

See Pearl-Project/Pearl, and PaperMC/Paperweight for the license of material used by this project.

Downloads & Usages

Github Actions Build

Please head to Releases to download the latest build.

If you are using another Paper forks, please follow this:

  1. Copy these files to {SERVER DIR}/storage:
  • banned-players.json
  • banned-ips.json
  • ops.json
  • whitelist.json
  • usercache.json (Unless --universe options are used)
  1. Copy these files to {SERVER DIR}/config/:
  • bukkit.yml
  • help.yml
  • commands.yml
  • permissions.yml (If settings.permissions-file are using default value)
  • spigot.yml
  • paper.yml
  • pufferfish.yml
  • purpur.yml
  1. Copy all world folders to {SERVER DIR}/worlds (Unless --universe options are used)

Building and setting up

Initial setup

Run the following commands in the root directory:

./gradlew applyPatches

Creating a patch

Patches are effectively just commits in either Atelier-API or Atelier-Server. To create one, just add a commit to either repo and run ./gradlew rebuildPatches, and a patch will be placed in the patches folder. Modifying commits will also modify its corresponding patch file.

We followed PaperMC/Paper contribution guides, please see PaperMC/Paper CONTRIBUTING.md for more detailed information.

Compiling

Use the command ./gradlew build to build the API and server. Compiled JARs will be placed under Atelier-API/build/libs and Atelier-Server/build/libs.

To get a atelierclip jar, run ./gradlew createReobfPaperclipJar. To install the atelier-api and atelier dependencies to your local Maven repo, run ./gradlew publishToMavenLocal

Credits

  1. Pearl
  • Upstream
  1. JettPack
  • Better handling of async tasks
  1. Slice
  • Reduction in unnecessary packets.
  1. EMC
  • Vanilla enchantments