Skip to content

Commit 5753ff7

Browse files
committed
chore: Update README
1 parent 0c3f0d0 commit 5753ff7

File tree

1 file changed

+43
-24
lines changed

1 file changed

+43
-24
lines changed

README.md

Lines changed: 43 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -8,51 +8,70 @@
88
A resource-saving Velocity plugin that automatically manages your Minecraft servers by starting them on demand and
99
shutting them down when idle, using either the [Pterodactyl](https://pterodactyl.io/) API or shell commands.
1010

11+
> [!IMPORTANT]
12+
> Support for this project is limited as I don't use it in production anymore.
13+
1114
---
1215

1316
## Community & Support
1417

1518
If you have any questions or suggestions, join the [Discord server](https://discord.gg/M2a9dxJPRy)!
1619

17-
## ✨ Key Features
20+
## Features
21+
22+
### 🔌 Energy & Resource Saving
23+
24+
Automatically shuts down empty servers after a configurable time with no players connected (default: 1 hour).
25+
26+
### 🚀 On-Demand Server Startup
27+
28+
Starts servers only when players connect, optimizing resource usage.
29+
30+
### 🔄 Seamless Player Experience
31+
32+
Redirects players to a lightweight waiting server during startup and transfers them automatically once the server is
33+
ready.
1834

19-
- 🔌 **Energy & Resource Saving** - Automatically shuts down empty servers after a configurable idle period (default: 1
20-
hour)
35+
### 🛡️ Kick Protection
2136

22-
- 🚀 **On-Demand Server Startup** - Starts servers only when players need them, optimizing resource usage
37+
Optionally redirects players to the waiting server when they are kicked from the backend server instead of disconnecting
38+
them.
2339

24-
- 🔄 **Seamless Player Experience**:
25-
- Redirects players to a lightweight waiting server during startup
26-
- Automatically transfers players when their destination server is ready
27-
- Keeps players informed with status messages throughout the process
40+
### 🔐 Whitelist Verification
2841

29-
- 🛡️ **Kick Protection** - Optionally redirects kicked players to your waiting server instead of disconnecting them
42+
Validate players against per-server whitelists before letting them join or start the server.
3043

31-
- 🔐 **Whitelist Verification** - Optionally validates players against per-server whitelists before letting them join or start the server
44+
### 🧰 Flexible Implementation
3245

33-
- 🧰 **Flexible Implementation**:
34-
- Works with Pterodactyl Panel API for managed hosting
35-
- Supports direct shell commands for self-hosted environments
36-
37-
- ⚙️ **Highly Configurable**:
38-
- Customizable shutdown delay
39-
- Multiple server status checking methods
40-
- Configurable shutdown behavior on proxy restart
46+
Works with the Pterodactyl Panel API or via direct shell commands for self-hosted setups.
4147

42-
- 🌐 **Multilingual Support** - Automatically translates messages based on the client's language (English, German,
43-
French)
48+
### ⚙️ Highly Configurable
4449

45-
- 🔍 **Diagnostic Tools** - Built-in doctor command to validate your configuration and troubleshoot issues
50+
Supports customizable shutdown delays, multiple server status check methods, and adjustable shutdown behavior on proxy
51+
restart.
52+
👉 See the [Wiki](https://github.com/Quozul/PterodactylPowerAction/wiki) for full details.
53+
54+
### 🌐 Multilingual Support
55+
56+
Automatically translates messages based on the client’s language (English, German, French).
57+
58+
### 🔍 Diagnostic Tools
59+
60+
Includes a built-in doctor command to validate configuration and help troubleshoot issues.
4661

4762
## How it Works
4863

49-
When a player tries to connect to a stopped server, they're temporarily sent to your waiting server while
64+
When a player tries to connect to an offline server, they're temporarily sent to your waiting server while
5065
PterodactylPowerAction starts their requested destination. Once the server is ready, they're automatically transferred.
51-
The plugin monitors player activity and intelligently shuts down empty servers to save resources.
66+
The plugin monitors player activity and shuts down empty servers to save resources.
5267

5368
![server-is-starting.png](docs/assets/server-is-starting.png)
5469
_Shader is Photon._
5570

71+
### Plus Version
72+
73+
You can find more features on the [plus](https://github.com/Quozul/PterodactylPowerAction/tree/plus) branch.
74+
5675
---
5776

5877
## Documentation
@@ -64,7 +83,7 @@ on [the wiki of this GitHub repository](https://github.com/Quozul/PterodactylPow
6483

6584
## Waiting/Limbo servers
6685

67-
Here is a small list of recommended lightweights servers software to use as waiting server:
86+
Here is a small list of recommended lightweight servers software to use as waiting server:
6887

6988
- [PicoLimbo](https://github.com/Quozul/PicoLimbo)
7089
- [NanoLimbo](https://www.spigotmc.org/resources/86198/)

0 commit comments

Comments
 (0)