8000 GitHub - FyreBlitz/pteroly: Pteroly is a API wrapper for the Pterodactyl Panel, it supports all versions after v1 and is fast
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

FyreBlitz/pteroly

Repository files navigation

Npmjs GitHub GitHub issues GitHub pull requests Build

Pteroly

A high-speed API wrapper for pterodactyl which can easily utilize the latest API of the panel and with amazing customizability, update-checker, support in the Discord, and very fast caching. Caching (when enabled) speeds up speed by 98.49% on average.

Pteroly Documentation | NpmJS Package | Pteroly PayPal | Pteroly Discord

Benefits of Pteroly:

  • Extremely fast
  • Supports auto-complete of your IDE, so you don't always need to vist docs
  • Supports latest version of the Pterodactyl Panel
  • Supports virtually every API feature of Pterodactyl
  • Global API login for the entire Node.JS project
  • Always Up-To-Date
  • Easy-to-Use
  • Typescript

Quick Start Guide

First install the package to your Node.JS app/project:

npm install pteroly@latest

Then you require the package and login into the Pterodactyl API:

const pteroly = require('pteroly');
const admin = pteroly.Admin;
const client = pteroly.Client;

// You only need to login once in your entire app/project
admin.login('HOST_PANEL_URL', 'YOUR_ADMIN_API_KEY', (loggedIn, errorMsg) => {
    console.log('Login status Admin: ' + loggedIn);
    if (!loggedIn) console.error(errorMsg);
});

client.login('HOST_PANEL_URL', 'YOUR_CLIENT_API_KEY', (loggedIn, errorMsg) => {
    console.log('Login status Client: ' + loggedIn);
    if (!loggedIn) console.error(errorMsg);
});

And then you can call any function you want like this, to find all the functions of the panel consider visiting our documentation.

// As a .then function
admin.functionName(<ARGUMENTS>).then((response) => {
    // TODO: Insert your code here.
}).catch((err) => console.error(err));

client.functionName(<ARGUMENTS>).then((response) => {
    // TODO: Insert your code here.
}).catch((err) => console.error(err));

// With await
const resultAdmin = await admin.functionName(<ARGUMENTS>).catch((err) => console.error(err));
const resultClient = await client.functionName(<ARGUMENTS>).catch((err) => console.error(err));

Changelog

Version 1.10.1:

  • Added the used resources to nodeDetails and listNodes

To-do list

  • Class support and support of new instances (with v2.0.0)
  • More features (please suggest features on GitHub)

About

Pteroly is a API wrapper for the Pterodactyl Panel, it supports all versions after v1 and is fast

Topics

Resources

License

Security policy

Stars

Watchers

Forks

Sponsor this project

Packages

No packages published

Contributors 5

0