Color theme

Installation & Setup

Eranio

Installation & Setup

Complete step-by-step guide to installing the Minecraft Modpacks plugin, configuring eggs, and preparing your server for modpack installations.


Prerequisites

  • Pelican Panel 1.0.0-rc.1 or newer installed and running
  • PHP 8.5 on the Panel server
  • A Minecraft server managed by the Panel
  • storage/ and bootstrap/cache/ writable (permissions 0755, owner: web server user)
  • Database user with CREATE TABLE privileges

Step 1: Install the Plugin

  1. Download the latest minecraft-modpacks plugin release
  2. Place it in your Pelican Panel's plugins/ directory:
    /var/www/pelican/plugins/minecraft-modpacks/
    
  3. Clear the application cache:
    php artisan cache:clear
    php artisan config:clear
    php artisan view:clear
    
  4. Verify the plugin appears under Admin Panel → Plugins

Auto-Seeder

The plugin runs its seeder automatically on every panel boot (wrapped in try-catch for safety). The seeder creates:

  • Minecraft Modpack Installer egg, Used during download, features: ['eula', 'java_version', 'minecraft', 'modpacks', 'plugins', 'mods', 'installer']
  • Minecraft Modpack Runtime egg, Standard Minecraft server egg

Docker images configured: Java 8, 9, 11, 16, 17, 21, 25. The plugin picks the right one for every install, see Installing Modpacks. The runtime egg has two start commands, Default (Java 9 to 25) and Java 8.


Step 2: Configure the Egg

The plugin uses the modpacks feature flag.

  1. Go to Admin Panel → Eggs
  2. Edit your Minecraft server Egg
  3. Add modpacks to the Features field:
    ["modpacks"]
    
  4. Click Save

Feature flag must be exactly modpacks (lowercase). The auto-created eggs already have this feature.


Step 3: Verify Eggs

After first load, verify both eggs exist:

Egg Purpose Key Features
Minecraft Modpack Installer Handles download + extraction Has MODPACK_PROVIDER, MODPACK_ID, MODPACK_VERSION_ID variables
Minecraft Modpack Runtime Runs the modpack server Java image and start command set per pack

The installer egg's variables are populated automatically during installation.


Step 4: First Use

  1. Navigate to your server → click Modpack Browser in the sidebar
  2. Provider tabs appear: Modrinth, CurseForge, ATLauncher, FTB, Technic, VoidsWrath
  3. Browse or search for a modpack
  4. Ready to install!

Verification Checklist

Check Expected If failing
Plugin in Admin → Plugins Listed Clear cache, check path
"Modpack Browser" in sidebar Visible Feature flag missing (modpacks)
Installer egg exists "Minecraft Modpack Installer" in Eggs Seeder didn't run, check logs
Runtime egg exists "Minecraft Modpack Runtime" in Eggs Seeder didn't run
Provider tabs visible 6 tabs JS/network error

Troubleshooting

Plugin not visible

  • Clear all caches: php artisan cache:clear && php artisan config:clear && php artisan view:clear
  • Check plugin.json exists in plugin root
  • Check storage/logs/laravel.log for errors

Eggs not auto-created

  • Seeder runs on every boot, check logs for seeder errors
  • Manual creation: copy egg configurations from plugin documentation
  • Database user may lack CREATE TABLE privileges

"Modpack Browser is not available for this server"

  • The plugin calls abort(403) when the modpacks feature is missing from the egg
  • Add modpacks to the egg's features and save