diff --git a/README.md b/README.md index 1343940..aca1228 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,16 @@ # GalacticCogs -Custom cogs/cog modifications intended for the GalacticFactory discord server. \ No newline at end of file +Custom cogs/cog modifications intended for the GalacticFactory discord server. + +## Pterodactyl + +The Pterodactyl Management cog interacts with the [Pterodactyl API](https://dashflo.net/docs/api/pterodactyl/v1/), and allows for remote management of a [Pterodactyl](https://pterodactyl.io) server from Discord. Currently, it only supports client API Keys, but this may change in the future. + +Current features: + +* Per-Server Configuration + * Includes API keys, server ID, and **base urls**, meaning it can be used on hosts that use Pterodactyl, assuming their api structure is the same. +* Remote updating + * Supports using tools like [packwiz](https://packwiz.infra.link) to update modpacks. + +If you're looking for a good server host that works with this Cog, check out [Bloom](https://bloom.host). Not sponsored or anything, they're just a great option.