Plugin Code

Now that the plugin files are in place, the next step is to modify the required files in your Pterodactyl Panel to enable the Plugin manager. This step involved adding several lines of code in specific files to register the plugin's routes, UI components and logic.

Let's start.

1. Open /var/www/pterodactyl/routes/admin.php

Scroll to the bottom of the file and paste the following code at the end:

/*
|--------------------------------------------------------------------------
| Plugin Manager Routes
|--------------------------------------------------------------------------
|
| Endpoint: /admin/plugin_manager
|
*/
Route::group(['prefix' => 'plugin_manager'], function () {
    Route::get('/', [Admin\PluginManagerController::class, 'index'])->name('admin.plugin_manager');
    Route::post('/', [Admin\PluginManagerController::class, 'update'])->name('admin.plugin_manager.update');
});

Example:

2. Open /var/www/pterodactyl/routes/api-client.php

Find this line:

use Pterodactyl\Http\Middleware\Api\Client\Server\AuthenticateServerAccess;

Directly under it, add:

use Pterodactyl\Http\Controllers\Api\Client\PluginManagerController;

Search for this block:

Route::group(['prefix' => '/settings'], function () {
    Route::post('/rename', [Client\Servers\SettingsController::class, 'rename']);
    Route::post('/reinstall', [Client\Servers\SettingsController::class, 'reinstall']);
    Route::put('/docker-image', [Client\Servers\SettingsController::class, 'dockerImage']);
});

Directly under it, add:

    Route::group(['prefix' => '/plugin-manager'], function() {
        Route::get('/', [PluginManagerController::class, 'index']);
        Route::get('/installed', [PluginManagerController::class, 'installed']);
        Route::post('/install/{pluginId}', [PluginManagerController::class, 'install']);
        Route::delete('/uninstall/{pluginId}', [PluginManagerController::class, 'uninstall']);
    });

The last change will be at the bottom of the file and paste the following code at the end:

Route::group(['prefix' => '/plugin-manager'], function() {
   Route::get('/eggs', [PluginManagerController::class, 'eggs']); 
});

Example:

3. Open /var/www/pterodactyl/resources/views/layouts/admin.blade.php

Find this block:

                        <li class="{{ ! starts_with(Route::currentRouteName(), 'admin.nests') ?: 'active' }}">
                            <a href="{{ route('admin.nests') }}">
                                <i class="fa fa-th-large"></i> <span>Nests</span>
                            </a>
                        </li>

Paste the following right after the </li>

                        <li class="header">THEODOR.WORK</li>
                        <li class="{{ ! starts_with(Route::currentRouteName(), 'admin.plugin_manager') ?: 'active' }}">
                            <a href="{{ route('admin.plugin_manager') }}">
                                <i class="fa fa-th-large"></i> <span>Plugin manager</span>
                            </a>
                        </li>

4. Open /var/www/pterodactyl/resources/scripts/state/server/index.ts

Locate this line:

import isEqual from 'react-fast-compare';

And add this directly below:

import { getEggsVisibility } from '@/api/server/plugin';

Find the following line in the ServerDataStore interface:

permissions: string[];

Add these lines below it:

eggVisibility: Record<number, boolean>;
setEggVisibility: Action<ServerDataStore, Record<number, boolean>>;
fetchEggVisibility: Thunk<ServerDataStore, void, Record<string, unknown>, ServerStore, Promise<void>>;

Search for:

    setPermissions: action((state, payload) => {
        if (!isEqual(payload, state.permissions)) {
            state.permissions = payload;
        }
    }),

Below this, add:

    eggVisibility: {},
    setEggVisibility: action((state, payload) => {
        state.eggVisibility = payload;
    }),

    fetchEggVisibility: thunk(async (actions) => {
        const data = await getEggsVisibility();
        actions.setEggVisibility(data);
    }),

5. Open /var/www/pterodactyl/resources/scripts/api/server/getServer.ts

We do this to get the egg id in the server information object. If you have already done this please skip.

Find the following line:

eggFeatures: string[];

Below this, add:

   eggId: number;

Find the following line:

    eggFeatures: data.egg_features || [],

Below this, add:

    eggId: data.egg_id,

6. Open /var/www/pterodactyl/resources/scripts/routers/routes.ts

Search for the following import:

import ServerActivityLogContainer from '@/components/server/ServerActivityLogContainer';

Add this line right below it:

import PluginManagerContainer from '@/components/server/plugin_manager/PluginManagerContainer';

Search for:

interface ServerRouteDefinition extends RouteDefinition {

Replace with:

export interface ServerRouteDefinition extends RouteDefinition {

Scroll down to the server: [ array. Search for the following route definition:

        {
            path: '/settings',
            permission: ['settings.*', 'file.sftp'],
            name: 'Settings',
            component: SettingsContainer,
        },

Directly below it, add the new route:

        {
            path: '/plugin-manager',
            permission: null,
            name: 'Plugin manager',
            component: PluginManagerContainer,
        },

7. Open /var/www/pterodactyl/resources/scripts/routers/ServerRouter.tsx

Search for the following import:

import routes from '@/routers/routes';

Add the following line right below:

import resolveServerRoutes from '@/helpers/server-routes';

Search for this line:

const clearServerState = ServerContext.useStoreActions((actions) => actions.clearServerState);

Directly below it, add:

    const eggId = ServerContext.useStoreState((state) => state.server.data?.eggId);
    const eggsVisibility = ServerContext.useStoreState((state) => state.server.eggVisibility);
    const filteredRoutes = resolveServerRoutes(routes.server, eggId, eggsVisibility);
    const fetchEggVisibility = ServerContext.useStoreActions((actions) => actions.server.fetchEggVisibility);

Search for the useEffect(() => { that contains getServer(match.params.id)

Insidee it, after:

        getServer(match.params.id).catch((error) => {
            console.error(error);
            setError(httpErrorToHuman(error));
        });

Add:

fetchEggVisibility();

Example:

Replace {routes.server with filteredRoutes

Search for this block:

                                {routes.server
                                    .filter((route) => !!route.name)
                                    .map((route) =>

Replace it with:

                                {filteredRoutes
                                    .filter((route) => !!route.name)
                                    .map((route) =>

Search for:

{routes.server.map(({ path, permission, component: Component }) => (

Replace it with:

{filteredRoutes.map(({ path, permission, component: Component }) => (

8. Open /var/www/pterodactyl/app/Transformers/Api/Client/ServerTransformer.php

Search for this line:

          'egg_features' => $server->egg->inherit_features,

Bellow it, add:

            'egg_id' => $server->egg_id,

And that's it!