v1.0.0

Game Mods Installer Documentation

Browse and install game mods from Modrinth, CurseForge, and Modtale directly through the Pelican Panel. Supports Minecraft, Hytale, and more.

8
Endpoints
3
Handler
REST
Architecture
JSON
Format

About Game Mods Installer

Game Mods Installer is a Pelican Panel plugin by Eranio that lets server administrators browse, install, update, and manage game mods directly from the panel — no command line, no SFTP, no manual file handling.

Supported Platforms

Platform Search One-Click Install Ratings Version Filter Dependency Resolution API Key Required
Modrinth Full text search Yes Yes By MC version + mod loader Yes (automatic) No
CurseForge Full text search Yes Yes By MC version + mod loader Yes (recursive) Yes (free)
Modtale Full text search Yes Yes By game No Optional
Manual Upload Via SFTP/File Manager

Supported Games

The plugin automatically detects your game type from the Egg Tags, Egg Name, or Nest Name (checked in that order):

Game Detection Keyword CurseForge Game ID
Minecraft (Java) minecraft 432
Minecraft Bedrock bedrock 432
Hytale hytale 70216
Among Us among us
Palworld palworld
Stardew Valley stardew
Terraria terraria

Key Features

  • Visual Mod Browser — Browse mods with icons, descriptions, download counts, and author info across all platforms
  • One-Click Installation — Select a version and install with a single click directly to the server
  • Automatic Minecraft Version Detection — Uses 11 different detection methods (JAR analysis, version.json, server.properties, and more)
  • Update Tracking — Periodically checks source platforms for newer versions and shows update badges (cached 24 hours)
  • Auto-Replace Versions — Automatically removes old mod versions when installing new ones (configurable)
  • Enable/Disable Mods — Toggle mods on and off without deleting them by renaming with a -bak suffix
  • Dependency Resolution — Automatically detects and installs required library mods (e.g., Fabric API)
  • ZIP Export — Download all installed mods as a single ZIP archive with JWT-signed URLs (30-minute expiry)
  • Console Widget — Shows update notifications directly on the server console page
  • Smart Caching — File-based cache with GM_ prefix and configurable TTLs per operation
  • Upload Detection — Mods installed manually via SFTP are auto-detected and tracked
  • JAR Metadata Extraction — Reads plugin.yml, fabric.mod.json, and META-INF/mods.toml from JARs

How It Works

  1. The plugin downloads the mod file via DaemonFileRepository::pull() — with a cURL fallback (60s timeout) if that fails
  2. The filename is detected with up to 3 retries (200ms → 300ms → 500ms delays) for filesystem latency
  3. JAR metadata is extracted (up to 30 MB, 256 MB memory limit) to read the mod's display name
  4. The installation is tracked in the server_installed_mods database table
  5. If auto-replace is enabled, old versions are deleted

Requirements

  • Pelican Panel 1.0.0 or newer
  • PHP 8.1, 8.2, or 8.3
  • The mods feature on your Egg
  • CurseForge API key (only if using CurseForge — free at console.curseforge.com)
  • storage/ and bootstrap/cache/ writable (permissions 0755)

API Reference

Guides