Skip to content

Server Types ​

Learn about different Minecraft server types and how to configure them.

Server Types

Vanilla ​

Basic Minecraft server without mods or plugins.

yaml
environment:
  TYPE: VANILLA
  VERSION: 1.21.4

Fabric ​

A lightweight modding platform alternative to Forge.

Basic Setup ​

  1. Select Fabric as server type
  2. Choose your Minecraft version
  3. Optionally specify loader/launcher versions

Configuration Options ​

OptionVariableDescriptionDefault
Loader VersionFABRIC_LOADER_VERSIONFabric loader versionLatest
Launcher VersionFABRIC_LAUNCHER_VERSIONFabric launcher versionLatest
Custom LauncherFABRIC_LAUNCHERPath to custom launcher jar-
Launcher URLFABRIC_LAUNCHER_URLURL to custom launcher-
Force ReinstallFABRIC_FORCE_REINSTALLRe-install if corruptedfalse

Example Configuration ​

yaml
environment:
  TYPE: FABRIC
  VERSION: 1.21.4
  FABRIC_LOADER_VERSION: 0.13.1
  FABRIC_LAUNCHER_VERSION: 0.10.2

Fabric API

Most Fabric mods require the Fabric API mod. Install it easily using Modrinth.

Forge ​

The most popular mod loader with extensive mod compatibility.

Configuration Options ​

OptionVariableDescriptionDefault
Forge VersionFORGE_VERSIONForge build numberLatest for version

Example ​

yaml
environment:
  TYPE: FORGE
  VERSION: 1.20.4
  FORGE_VERSION: 43.2.0

Paper ​

High-performance Spigot fork with plugins support.

Configuration Options ​

OptionVariableDescriptionDefault
BuildPAPER_BUILDSpecific Paper buildLatest
ChannelPAPER_CHANNELRelease channeldefault
Download URLPAPER_DOWNLOAD_URLCustom download URL-

Example ​

yaml
environment:
  TYPE: PAPER
  VERSION: 1.21.4
  PAPER_BUILD: 120

Spigot ​

Popular plugin-based server.

Configuration Options ​

OptionVariableDescriptionDefault
Download URLSPIGOT_DOWNLOAD_URLCustom download URL-
Build from SourceBUILD_FROM_SOURCECompile from sourcefalse

Example ​

yaml
environment:
  TYPE: SPIGOT
  VERSION: 1.20.4

Bukkit ​

The original plugin platform.

Configuration Options ​

OptionVariableDescriptionDefault
Download URLBUKKIT_DOWNLOAD_URLCustom download URL-
Build from SourceBUILD_FROM_SOURCECompile from sourcefalse

Purpur ​

Fork of Paper with additional features.

Configuration Options ​

OptionVariableDescriptionDefault
BuildPURPUR_BUILDSpecific Purpur buildLatest
Download URLPURPUR_DOWNLOAD_URLCustom download URL-
Flare FlagsUSE_FLARE_FLAGSUse Flare performance flagsfalse

Pufferfish ​

Paper fork focused on performance.

Configuration Options ​

OptionVariableDescriptionDefault
BuildPUFFERFISH_BUILDSpecific buildLatest
Flare FlagsUSE_FLARE_FLAGSUse Flare flagsfalse

Folia ​

Experimental multi-threaded Paper fork.

Configuration Options ​

OptionVariableDescriptionDefault
BuildFOLIA_BUILDSpecific buildLatest
ChannelFOLIA_CHANNELRelease channeldefault
Download URLFOLIA_DOWNLOAD_URLCustom URL-

Leaf ​

Another Paper fork with optimizations.

Configuration Options ​

OptionVariableDescriptionDefault
BuildLEAF_BUILDSpecific buildLatest

CurseForge Modpacks ​

Install complete modpacks from CurseForge.

API Key Required

You need a CurseForge API key. Get one from CurseForge for Studios.

Installation Methods ​

1. URL Method (easiest):

yaml
environment:
  TYPE: AUTO_CURSEFORGE
  CF_API_KEY: your_key
  CF_PAGE_URL: https://www.curseforge.com/minecraft/modpacks/all-the-mods-9/download/5464988

2. Slug + File ID:

yaml
environment:
  TYPE: AUTO_CURSEFORGE
  CF_API_KEY: your_key
  CF_SLUG: all-the-mods-9
  CF_FILE_ID: 5464988

3. Auto-select latest:

yaml
environment:
  TYPE: AUTO_CURSEFORGE
  CF_API_KEY: your_key
  CF_SLUG: all-the-mods-9

Advanced Options ​

OptionVariableDescriptionDefault
Force SyncCF_FORCE_SYNCHRONIZERe-download even if existsfalse
Parallel DownloadsCF_PARALLEL_DOWNLOADSConcurrent downloads4
Skip ExistingCF_OVERRIDES_SKIP_EXISTINGDon't overwrite filesfalse
Set Level FromCF_SET_LEVEL_FROMWorld source: WORLD_FILE, OVERRIDES-
Force IncludeCF_FORCE_INCLUDE_MODSForce download specific mods-
Exclude ModsCF_EXCLUDE_MODSExclude specific mods-

Next Steps ​

Released under the MIT License.