Start · 01

Install & run

SilkMC ships as a Paperclip-style runnable jar. The recommended path is to build from source against Folia 26.1.2, then launch the generated paperclip jar from silkmc-server/build/libs/.

Prerequisites

Build from source

Clone the repository, apply patches, then build the Paperclip jar:

git clone https://github.com/tame-gg/SilkMC.git
cd SilkMC
./gradlew applyAllPatches
./gradlew build
./gradlew :silkmc-server:createPaperclipJar

On Windows PowerShell, point JAVA_HOME at your JDK 25 install first:

$env:JAVA_HOME='C:\Program Files\Eclipse Adoptium\jdk-25.0.2.10-hotspot'
$env:Path="$env:JAVA_HOME\bin;$env:Path"
./gradlew applyAllPatches
./gradlew build
./gradlew :silkmc-server:createPaperclipJar

Run the server

Use the Paperclip jar — not the plain silkmc-server module jar, which is not meant to be launched standalone.

java -Xms4G -Xmx4G \
  -jar silkmc-server/build/libs/silkmc-paperclip-26.1.2.local-SNAPSHOT.jar \
  nogui
tip
The first launch generates silkmc-compatibility.yml and silkmc-plugin-overrides.yml next to the world. Stop the server, edit those, and restart to pick up your policy.

Prebuilt jars

Each tagged release on the upstream repo includes a paperclip jar attached as a release asset. See the releases page for downloads, or grab the direct asset off the latest tag.

Next steps