Skip to content

Latest commit

 

History

History
86 lines (83 loc) · 3.17 KB

README.md

File metadata and controls

86 lines (83 loc) · 3.17 KB
Raw

PteroBot

PteroBot is simple discord bot utilizing pterodactyl api made using JDA and Pterodactyl4J.

First time running

You run this bot like any other Java application, simple java -jar PteroBot.jar.
On first startup you will be asked for some basic information that bot requires to function normally.

Setup

Features

  • Fully customizable (all messages and embeds)
  • Specific node info
  • Status of all nodes
  • Discord and pterodactyl account linking
  • Managing (sort of) servers over discord
  • Panel registration

Customizing

Templates of all embeds used by the bot are present in /embeds/ directory and are in json format.
Example of server info embed:

{
  "type": "IMAGE",
  "color": 39129,
  "author": {
    "icon_url": "",
    "name": ""
  },
  "footer": {
    "icon_url": "https://images.g2crowd.com/uploads/product/image/social_landscape/social_landscape_9f7bed1018bc7ad75c94da92c83c76de/pterodactyl-panel.png",
    "text": "PteroBot | %serverId"
  },
  "timestamp": "%timestamp",
  "title": "PteroBot",
  "description": "%serverName",
  "fields": [
    {
      "name": "Status",
      "value": "%statusEmoji %status",
      "inline": true
    },
    {
      "name": "Node",
      "value": "%nodeName",
      "inline": true
    },
    {
      "name": "Allocation",
      "value": "%primaryAllocation",
      "inline": false
    },
    {
      "name": "CPU usage",
      "value": "%cpuUsed %",
      "inline": true
    },
    {
      "name": "Disk usage",
      "value": "%diskUsed GB / %diskMax GB",
      "inline": true
    },
    {
      "name": "Memory usage",
      "value": "%usedMb MB %memoryUsageBar %maxMb MB",
      "inline": false
    }
  ]
}

For creating embeds, you can use site like Embed Builder with little customization (Removing embeds array and adding type property)

Specific node info

Node Info
It also comes with an option to automatically update message every 5 minutes.

Warning Be careful while using auto update option, bot might get rate-limited (Discord API being very strict for editing messages)

Nodes status

Node Status

Warning Same as with node info, there is option for auto update, be careful

Managing servers

By default, every member can manage servers with their own api key !

Registration

Registration
By default, /register command is admin only, you can enable it to everyone by going into Server Settings -> Integrations -> Your Bot and enable command for everyone