Modpack Installer - BuiltByOtte Documentation

Requirements

Pterodactyl Panel v2.0 or newer (the extension system).
The Panel's standard cron entry: * * * * * php /var/www/pterodactyl/artisan schedule:run.
A Minecraft (Java) server running Fabric, Forge, NeoForge or Quilt.
Outbound internet access for the Panel and the nodes, so packs and their files can be downloaded from Modrinth.
The user opening the page needs the server permission file.read.
Installing or uninstalling a pack needs file.create, file.update and file.delete.

Installation

The entire install happens in the Panel. There is nothing to upload to your nodes.

Step 1: Download the extension

Extract the product ZIP and keep both modpack-installer-1.0.0.pteroext (the installable build) and modpack-installer-source.zip (the editable source) if you want to customize the extension.

Step 2: Install in the Panel

Sign in to your Panel as an administrator.
Go to Admin → Extensions.
Click Install and upload the .pteroext file.
Toggle the extension on to enable it, then reload the page.

A Modpacks tab now appears in the sidebar of each server.

Alternative: install from the command line

php artisan p:extension:install modpack-installer-1.0.0.pteroext --enable

Using the installer

Browse and install a modpack

Open a server and click Modpacks in the server sidebar. In Browse modpacks, use the filters to find a pack:

Choose the Loader: Fabric, Forge, NeoForge or Quilt.
Optionally choose a Minecraft version.
Sort by relevance, downloads, followers, newest or recently updated.
Search by name or keyword, then click Details to view the Modrinth project or Install to continue.

In the install dialog, pick the pack version and check its loader and Minecraft versions. Tick Remove the existing files in /mods first to start from a clean mods folder. After the install the dialog shows which Minecraft and loader version the pack needs.

The install runs on the Panel in the background. It downloads every server side mod and copies the pack's config and override files into the server. Client only mods are skipped. Progress is shown at the top of the Modpacks page, and you can close the dialog or leave the page while it runs. Restart the server when the install is done.

Cancel an install

Click Cancel install on the progress banner. The install stops after the file it is working on, and the files it already added are removed again.

Uninstall a modpack

Switch to Installed modpack to see the pack that was installed with the extension, its version and when it was installed. Click Uninstall to delete the files the pack added. Config files and worlds are kept.

Permissions

The Modpacks page requires file.read. Installing, cancelling or uninstalling a pack requires file.create, file.update and file.delete. Server owners and administrators normally have these permissions; grant them in the server's User editor for sub users.

Managing the extension

Action	How
Disable without removing	Toggle the extension off, or `php artisan p:extension:disable modpack-installer`
Update	Install the newer `.pteroext` over the top from the Extensions page
Remove	Click Remove on the Extensions page, or `php artisan p:extension:remove modpack-installer`

Notes

Modpack search, versions and downloads are provided by Modrinth. Only files hosted on Modrinth, GitHub and GitLab are downloaded.
One modpack install can run per server at a time, and at most two installs run on the Panel at once. Others wait their turn.
An install that has not started after a few seconds is picked up by the Panel's scheduler within a minute. Make sure the cron entry from the requirements is in place.
Installing a pack does not change the server's startup settings. Make sure the server runs the Minecraft and loader version the pack needs.
Installing or uninstalling a pack does not restart the server.

Need Help?

Join our Discord Server and open a ticket for support.