README

Documentation

Quick start

For Pterodactyl Panel v1, you may need to install v2 version of this sdk, otherwise some functions may not work properly.

There is no stable version and full documentation for v2 yet, you may need to read the source code to use this sdk.

composer require vexura/pterodactyl-sdk:dev-develop

To install the SDK in your project you need to require the package via composer:

composer require vexura/pterodactyl-sdk

Then use Composer's autoload unless you are using a framework that support composer autoload:

require __DIR__.'/../vendor/autoload.php';

And finally create an instance of the SDK:

$pterodactyl = new \HCGCloud\Pterodactyl\Pterodactyl(API_KEY_HERE, BASE_URI_HERE);

Then you can call the apis.

Usage

Please check the documentation for more details.

Support

You can get support by going to our Discord server or submitting new issue.

As a third-party API wrapper, We recommend you not asking for help elsewhere, or we may not be able to help you.

License

hcgcloud/pterodactyl-sdk is licensed under the MIT License (MIT). Please see the license file for more information.