v1.0.5

Minecraft Modpacks Documentation

Browse, install, and manage Minecraft modpacks from 6 providers with automatic egg switching, backup management, config merging, and cross-plugin cleanup.

12
Endpoints
6
Handler
REST
Architecture
JSON
Format

About Minecraft Modpacks

Minecraft Modpacks is a Pelican Panel plugin by TimVida & Eranio that allows server administrators to browse, install, update, and manage complete Minecraft modpacks directly from the panel. It supports 6 modpack providers, handles the complex installation process automatically (including egg switching, file preservation, backup creation, and config merging), and integrates with the Game Mods and Minecraft Plugins plugins for cross-plugin cleanup.

Supported Providers

Provider Search Direct Install Requires Launcher API Key Required Version Filter
Modrinth Full-text Yes No No Yes
CurseForge Full-text Yes No Yes (free) Yes
ATLauncher Full-text No Yes No No
FeedTheBeast Full-text No Yes No No
Technic Full-text No Yes No No
VoidsWrath Browse only Yes (server pack) No No No

How Modpack Installation Works

Unlike individual mod installation, modpacks require a complex multi-step process:

Step Name What Happens
1 Preserve Important files (server.properties, eula.txt, ops.json, ban lists, whitelist, usercache, /config/, /plugins/) saved to memory
2 Backup ZIP backup created with German-language name based on installation type
3 Delete All server files deleted except protected directories (worlds, plugins, logs)
4 Download Server killed → switched to installer egg → reinstalled → waits for download (300s timeout)
5 Extract File stability monitored — 3 consecutive stable checks = decompression complete
6 Restore Preserved files restored (conditionally skips /config/ and /plugins/ for later merging)
7 Merge Wait up to 45s for mods/config dirs to appear, then merge configs (JSON, YAML, Properties, TOML)
8 Finalize Switch back to runtime egg, save tracking file (.installed_modpack.json)

Installation Types

Type Condition Emoji Behavior
Fresh No .installed_modpack.json found 🟢 Full install
Update Same modpack, different version 🟠 Options to keep or delete configs
Change Different modpack_id 🔴 Full cleanup + install
Reinstall Same modpack + same version 🔵 Reinstall current version

Key Features

  • 6 Provider Support — Modrinth, CurseForge, ATLauncher, FeedTheBeast, Technic, VoidsWrath
  • Automatic Egg Switching — Switches between installer egg (with download variables) and runtime egg
  • Smart Backup — Automatic backup creation before every installation with configurable limits
  • Config Merging — Preserves your customizations across modpack updates (JSON, YAML, Properties, TOML)
  • Plugin Config Merging — Scans /plugins/PluginName/ and merges individual config files
  • Cross-Plugin Cleanup — Clears Game Mods and Minecraft Plugins data when modpack changes
  • Progress Widget — Real-time 8-step progress indicator with auto-redirect on completion
  • Direct Install — Modrinth (.mrpack) and CurseForge (manifest.json) can install directly without launcher
  • Tracking File.installed_modpack.json tracks what's installed for update detection

Requirements

  • Pelican Panel 1.0.0 or newer
  • PHP 8.1, 8.2, or 8.3
  • The modpacks feature on your Egg
  • An installer egg (auto-created by seeder) and a runtime egg
  • CurseForge API key (only for CurseForge — free at console.curseforge.com)
  • storage/ and bootstrap/cache/ writable (permissions 0755)

API Reference

Guides