🧑‍🔧 Installation Guide

This page primarily explains the basic requirements for plugin installation and the method for MOD installation.

Enviroment Requirements

Paper or its forks

First, ensure that you are running a Paper (or its fork) 1.20.1+ server. The plugin does not support Spigot and is unlikely to do so in the future. CraftEngine contains over 10,000 lines of code that are based on the Minecraft code of the Paper version server.

[Download Paper]

JDK 21+

Secondly, please use JDK 21 to run the server. I believe this is quite straightforward for you.

How to install

CraftEngine offers two installation modes: Standard Installation and MOD Mode. As the name suggests, Standard Installation involves placing the plugin into your plugins folder just like any conventional plugin. Below, we will provide a detailed explanation on how to install using MOD Mode.

Note: Mod is optional, you can still use most features without mod

Why Server Mod

By installing in MOD Mode, the plugin will modify your server in a manner similar to Fabric mods. This allows for enhanced customization of the plugin and ensures its stable operation. The MOD acts as a bridge between the server and the plugin, enabling more powerful features such as vanilla data packs.

Install Server Mod

• Download the latest ignite.jar into your server's root directory

• Either:

  • Rename your server JAR to paper.jar

• Or:

  • Add launch arguments: -Dignite.locator=paper -Dignite.paper.jar=./paper-xxx.jar

• Start the server to generate the /mods directory

• Place the latest mod.jar in /mods

• Install the plugin by placing its JAR in /plugins

• Perform two restarts:

  1. Initial restart for file initialization

  2. Final restart to activate all components