0.0.7 โข Published 3 years ago
pterom v0.0.7
๐ 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 |