We decide to use only the Client part of the API to avoid potential big mistake like delete a server. This bot can only control server instances but not delete or manage them.

Bot Features#

It can currently:

/servers - Show informations about servers
/server {identifier} - Show informations about a specific server
/power {identifier} {state} - Provide a way to change server state (start, stop, kill, restart)
/send {identifier} {command} - Send a command to a server
/safemode 👑 - Stop, Kill and backups servers from lists
/backups {identifier} - Show all backups for a server
/create-backup {identifier} - Create a new backup for a server
/help - Show information about all available commands
/add-key - Add your api key to access your server information (only in bot private messages)

👑: only for admins

How to Install and Run the Project#

In a first time you need to duplicate and rename .env.exampleto .env and complete necessary variables.

In a second time:

# Install dependencies
$ yarn install

# Launch bot in development mode
# - I used nodemon to automatically relaunch server after file changes
$ yarn dev 

# Launch bot in production mode
$ yarn start

# Deploy commands
$ yarn command:deploy

Contribute#

The project respect the conventional commits, so follow the rules carefully.

In other hand, eslint check all code you write here, remember to check what you are doing with yarn lint and if you have some errors / warnings, it can be resolved with the yarn lint:fix command to simplify your life.

Happy coding everyone and see you on discord. 👋

Clone this repository

PteroBot - 🪶 A Discord Bot connected to your Pterodactyl API#

Bot Features#

How to Install and Run the Project#

Contribute#