A Discord Bot connected to your Pterodactyl API.
docs: update readme
authored by
Cosmeak
721fa34c
5e2b2a08
+41
+41
README.md
+41
README.md
···
1
1
# PteroBot - 🪶 A Discord Bot connected to your Pterodactyl API
2
+
This Discord Bot is a mission gived by `MrJuju0319#5801` to connect his Pterodactyl Panel to a Bot.
3
+
4
+
We decide to use only the Client part of the API to avoid potential big mistake like delete a server.
5
+
6
+
## Bot Features
7
+
It can actually:
8
+
- [x] `/servers` - Show informations about servers
9
+
- [x] `/server {identifier}` - Show informations about a specific server
10
+
- [x] `/power {identifier} {state}` - Provide a way to change server state (start, stop, kill, restart)
11
+
- [x] `/send {identifier} {command}` - Send a command to a server
12
+
- [x] `/safemode` 👑 - Stop, Kill and backups servers from lists
13
+
- [x] `/backups {identifier}` - Show all backups for a server
14
+
- [x] `/create-backup {identifier}` - Create a new backup for a server
15
+
16
+
<small style="color:slategray;">👑: only for admins</small>
17
+
18
+
## How to Install and Run the Project
19
+
In a first time you need to duplicate and rename `.env.example`to `.env` and complete necessary variables.
20
+
21
+
In a second time:
22
+
```bash
23
+
# Install dependencies
24
+
$ yarn install
25
+
26
+
# Launch bot in development mode
27
+
# - I used nodemon to automatically relaunch server after file changes
28
+
$ yarn dev
29
+
30
+
# Launch bot in production mode
31
+
$ yarn start
32
+
33
+
# Deploy commands
34
+
$ yarn command:deploy
35
+
```
36
+
37
+
## Contribute
38
+
The project respect the [conventional commits](https://www.conventionalcommits.org/fr/v1.0.0/), so follow the rules carefully.
39
+
40
+
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.
41
+
42
+
Happy coding everyone and see you on discord. 👋