Skip to content
generated from PurpurMC/Tentacles

CanvasMC is a fork of the Folia Minecraft server software that fixes gameplay inconsistencies, bugs, and introduces further performance enhancements to the dedicated server

License

Notifications You must be signed in to change notification settings

CraftCanvasMC/Canvas

Repository files navigation

CanvasMC Banner

GitHub License GitHub contributors Discord

CanvasMC is a fork of the Folia Minecraft server software that fixes gameplay inconsistencies, bugs, and introduces further performance enhancements to the dedicated server.

Canvas pulls some patches from Leaf to assist in single-threaded performance, along with a ton of our own performance patches


Useful Links


Running Canvas

Downloading the Server Jar

You can download the latest release from the Downloads Page.


Building Canvas

Requirements

  • Java 22 or higher
  • Git (configured with name and email)
  • Gradle

Common Scripts

./gradlew applyAllPatches         # Apply all patches
./gradlew buildMojmapPublisherJar # Build the server jar
./gradlew runDevServer            # Run dev server
./rebuildPatches                  # Custom script to generate patches for modified directories

Using the API (Gradle)

You can use the Canvas API in your own plugins via the following Gradle configuration:

build.gradle.kts
repositories {
    maven {
        name = "central portal" // contains Canvas artifacts
        url = uri("https://central.sonatype.com/repository/maven-snapshots/")
    }
    mavenCentral() // for other dependencies
    maven("https://repo.papermc.io/repository/maven-public/")
}

dependencies {
    implementation("io.canvasmc.canvas:canvas-api:1.21.7-R0.1-SNAPSHOT")
}

REST API

Canvas exposes a REST API that allows you to retrieve builds and version information.

Temporary docs are available here — these will soon be moved to the official documentation site.


Support & Contribution

Help CanvasMC grow by:

  • Supporting us on Ko-fi
  • Starring the project on GitHub
  • Contributing code or improving documentation

Your support helps keep the project active and evolving!


License

Canvas is licensed under the GNU AGPLv3.


About

CanvasMC is a fork of the Folia Minecraft server software that fixes gameplay inconsistencies, bugs, and introduces further performance enhancements to the dedicated server

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

Contributors 9