Mcsleepingserverstarter
Put your minecraft server to rest, while SleepingServerStarter is watching !
Install / Use
/learn @vincss/McsleepingserverstarterREADME
Tutorial Video | Based on minecraft-protocol | Based on JSPrismarine | Original idea
</p> </div>✅ Compatible versions
- Minecraft Java: up to 1.20.2 (partial 1.21.3) by node-minecraft-protocol
- Bedrock: 1.21.40 by JSPrismarine
🧰 Features
- Listen on the same port as your minecraft server.
- Option to connect from BedRock (Portable version of Minecraft)
- Web-gui, to turn on or off your server from anywhere
- When someone connects, immediately launch your minecraft server.
- You can also type 'quit' in your console to start minecraft's server
Works better with EmptyServerStopper (1.13-1.19+) or NoPlayerShutdown (1.20.1-1.21.1+), a plugin that automatically stops your server after a definied amount of time
📀 Install
There are multiple ways to run SleepingServerStarter:
📦 Download the binaries (easiest)
- Download binaries corresponding to your OS
- Place the executable in the same working directory
- same folder as your server file (
spigot.jar,paper.jar, etc)
- same folder as your server file (
- Make sure your server is stopped
- Run the executable
- On Linux, try
chmod +x mcsleepingserverstarter-linux-x64if you can't run the executable
- On Linux, try
📜 Manually install and compile
- Requires NodeJS v16+
- Clone the repo or download the project as Zip
- Unzip or clone it in the same folder as your minecraft server
- Launch
npm ci - Start the project with
npm start
🐋 Docker
SleepingServerStarter is available as a Docker image: ghcr.io/vincss/mcsleepingserverstarter
It supports both x64 and arm64 host system architectures.
For detailed examples and instructions for setup via Docker, see the wiki page here.
🐡 PufferPanel
If you're using PufferPanel, you can import this template as JSON to use Paper Spigot with Sleeping Server Starter via PufferPanel
🐦 Pterodactyl
If you're using Pterodactyl, you can import this egg as JSON to use Paper Spigot with Sleeping Server Starter OR you can also import this egg as JSON to use Vanilla Minecraft with Sleeping Server Starter on Pterodactyl
Pterodactyl can be installed via Unofficial pterodactyl-installer
⚙️ Settings
SleepingServerStarter configfile: sleepingSettings.yml
JSPrismarine configfile: config.yaml
Change sleepingSettings.yml for Java Edition, Change config.yaml for Bedrock Edition
sleepingSettings.yml except bedrockPort for Bedrock Edition
Note: If running from binaries, the settings file will be created after the first execution in the same folder as the executable.
SleepingServerStarter config
| Setting | Description | Default value |
| --------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------- |
| serverName | The name of your server.<br>You can specify colour codes by using the § prefix. | "SleepingServer, waiting for his prince..." |
| serverMOTD | The MOTD to display for Minecraft Servers.<br>You can specify colour codes just as you can for serverName. Defaults to serverName if not set. | SleepingServer, waiting for his prince... [MOTD] |
| serverPort | The port of your Java Edition server (0 to disable) | 25565 |
| bedrockPort | The port of your Bedrock Edition server (0 to disable) | 19132 |
| loginMessage | Message shown when the server is off and someone is trying to connect | "...Waking server up, come back in a minute..." |
| serverOnlineMode | Check if players has premium accounts | false |
| maxPlayers | Maximum amount of players | 20 |
| useNativeFiles | Use Minecraft server.properties to overwrite serverPort, maxPlayers, serverOnlineMode, useWhitelistFile, and useBlacklistFiles properties | false |
| webPort | Port for the Web-Gui | 0 |
| webStopOnStart | Stop the web-server when minecraft starts | false |
| webServeDynmap | true or an absolute path to enable it, by default it will serve './plugins/dynmap/web/'. You can specify an absolute path to serve instead or an url to redirect to. How use with dynamp | false |
| webSubPath | Set the path to the Web-GUI if serving from behind a reverse proxy | "" |
| webAllowRestart | Add a button in the web-ui to restart the minecraft server proxy | false |
| startMinecraft | Start the Minecraft Server (false to disable) | true |
| minecraftCommand | The command used to start the server | "java -jar paper.jar --nogui" |
| minecraftAutostart | Automatically start the real server instead of the sleeping one | false |
| restartDelay | Customise the delay between when the minecraft server stops and the sleeping server restarts ( to ensure conection are closed ) ( in milliseconds ) | 5000 |
| preventStop | Prevent the user to stop the server (trought web-server or cli). | false |
| minecraftWorkingDirectory | Set a custom Working Directory for the server **EDIT ONLY IF Y
