Installation

Requirements

To run CanvasMC, you’ll need:

• Java 21 or newer
• At least 4GB of RAM (recommended)
• A stable internet connection

Installation

CanvasMC follows a similar installation process to other PaperMC-based server software, making it familiar for experienced server administrators.

Downloading the Server

• Visit canvasmc.io/downloads to get the newest version of CanvasMC.

• Make a new folder to keep your server files organized and easily accessible.

• Move the downloaded CanvasMC jar file into your server directory.

Running the Server

• Create a startup script for your operating system:

  start.bat

  java -Xms2G -Xmx4G --add-modules=jdk.incubator.vector -jar canvas.jar --nogui
  pause >nul 2>&1

  start.sh

  #!/bin/bash
  java -Xms2G -Xmx4G --add-modules=jdk.incubator.vector -jar canvas.jar --nogui
  pause > /dev/null 2>&1

  For optimal performance, get customized JVM flags from Birdflop Flags Generator based on your server specs.

• The first launch creates an eula.txt file. Open it and change the following line:

  eula.txt

  # By changing the setting below to TRUE, you agree to our EULA (https://aka.ms/MinecraftEULA).
  # Thu Jan 1 00:00:00 UTC 1970
   eula=false
   eula=true

• Run the server again using the startup script you created. Once it fully loads, your installation is complete!

Next Steps

Now that you have your CanvasMC server running, you can start adding plugins and configuring it to your liking.