📌 What am I?

Pterom is a open source API wrapper for Pterodactyl that is built with TypeScript. It will support the Application & Client side of the API. Currenty it is a work in progress.

❓ How do I work?

This library works by querying the Pterodactyl API V1 (REST requests) using a library called AXIOS.

💻 Getting started with installation

First install pterom with your package manager.

npm i pterom
or
yarn add pterom

// Import it

// ESM
import Pterom from 'pterom';

// CJS
const Pterom = require('pterom');

// Create a new instance
// Remember that client and app sides have diffrent API keys
const pt = new Pterom('YourHostHere', 'YourApiKeyHere');

// Choose what class you want to use

// For client
pt.client;
// For application
pt.app;

// You can then use the functions after choosing the class
pt.client.listServers();
pt.app.listServers();

// To use app and client in the same file there needs to be 2 instances to separate them
const appSide = new Pterom('appHost', 'appApiKey');
const clientSide = new Pterom('clientHost', 'clientApiKey');

appSide.app.listServers();
clientSide.client.listServers();

// And away you go coding!
// Any issues please just open a issue on github
// And join the convo by clicking the discord button above

📖 Documentation (coming soon)

The full documentation will be started on once there is a stable version. But JSDocs will be included within the code.

🧾 License

This project is licensed under the terms of the GPL-3.0 License.

You can check out the full license HERE

✨ Contributors

Thanks goes to these wonderful people:

| Emoji/Type | Represents | Comments | | :--------------------------: | :--------------------: | :----------------------------------------------------------------------------------: | | 🐛 bug | Bug reports | Links to issues reported by the user on this project | | 💻 code | Code | Links to commits by the user on this project | | 📖 doc | Documentation | Links to commits by the user on this project, Wiki, or other source of documentation | | 💡 example | Examples | People that have created examples to help others | | 💵 financial | Financial Support | People or orgs who provide financial support | | 🤔 ideas | Ideas & Planning | | | 🚧 maintenance | Maintenance | People who help in maintaining the repo | | 🧑‍🏫 mentoring | Mentoring | People who mentor new contributors | | 📆 projectManagement | Project Management | | | 💬 question | Answering Questions | Answering Questions in Issues etc. | | 👀 review | Reviewed Pull Requests | | | 🛡️ security | Security | Identify and/or reduce security threats, Privacy, etc | | ⚠️ test | Tests | People that have created tests | | ✅ tutorial | Tutorials | content creators that have made tutorials on this wrapper | | 📓 userTesting | User Testing | People that have found an issue via testing |