Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/master' into chore/node_20
Browse files Browse the repository at this point in the history
# Conflicts:
#	package-lock.json
#	package.json
  • Loading branch information
vwi committed Dec 5, 2024
2 parents b60dede + c9ee7d4 commit e499bc2
Show file tree
Hide file tree
Showing 11 changed files with 1,333 additions and 2,247 deletions.
3 changes: 3 additions & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# These are supported funding model platforms

ko_fi: vincs48633
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ whitelist.json
bukkit.yml
commands.yml
permissions.yml
permissions.json
help.yml
spigot.yml
server.properties
Expand Down
165 changes: 86 additions & 79 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,16 +15,15 @@

- Minecraft Java: up to
1.20.2 [node-minecraft-protocol](https://github.com/PrismarineJS/node-minecraft-protocol)
- Bedrock: Waiting for third party compatibility ( you can use the web-gui as a
workarround ) [JSPrismarine](https://github.com/JSPrismarine/JSPrismarine)
- Bedrock: 1.21.40 [JSPrismarine](https://github.com/JSPrismarine/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
- 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.
- You can also type 'quit' in your console to start minecraft's server.

**Works better with [EmptyServerStopper](https://github.com/vincss/mcEmptyServerStopper), a plugin
that automatically
Expand All @@ -40,7 +39,7 @@ There are multiple ways to run SleepingServerStarter:
2. Place the executable in the same folder as your server file (`spigot.jar`, `paper.jar`, etc...)
3. Make sure your server is stopped
4. Run the executable
- On Linux, try `chmod +x mcsleepingserverstarter-linux-x64` if you can't run the executable
- On Linux, try `chmod +x mcsleepingserverstarter-linux-x64` if you can't run the executable

### 📜 Manually install and compile

Expand Down Expand Up @@ -84,8 +83,9 @@ via [Unofficial pterodactyl-installer](https://github.com/vilhelmprytz/pterodact
> same folder as the
> executable

| Setting | Description | Default value |
|-----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------|
| --------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------- |
| `serverName` | The name of your server.<br>You can specify [colour codes](https://motd.gg) by using the `§` prefix (Does not work on Bedrock) | "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. (Still does not work on Bedrock) | Same as `serverName` |
| `serverPort` | The port of your Java Edition server (0 to disable) | 25565 |
Expand All @@ -108,7 +108,9 @@ via [Unofficial pterodactyl-installer](https://github.com/vilhelmprytz/pterodact
| `version` | Force compatibility with a specific Minecraft. If set to false, it should handle any compatible version | "" |
| `favIconPath` | Path to a PNG file to use as the server icon.<br>If this is set to `server-icon.png` then it will use the same icon as the server. | "" |
| `favIcon` | Use a custom server-icon 64x64 png converted using https://www.base64-image.de/ (needs to be encoded in base64) | "" |
| `discordWebhookUrl` | Setup a [Discord WebHook](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks) to your channel | "REPLACE_ME" |
| `discordWebhook.url` | Setup a [Discord WebHook](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks) to your channel | "REPLACE_ME" |
| `discordWebhook.name` | Name of the bot in the Discord WebHook | "SleepingServerStarter" |
| `discordWebhook.avatar` | Avatar of the bot in the Discord WebHook | "https://raw.githubusercontent.com/vincss/mcsleepingserverstarter/master/docs/sleepingserver.png" |
| `blackListedAddress` | Prevent connections from those addresses to wake up the server | ["127.0.0.1"] |
| `whiteListedNames` | Only allow people with their name on the white list to wake the server up | ["vincss"] |
| `useWhitelistFile` | Use Minecraft `whitelist.json` instead of the `whiteListedNames` property. Checks both username and UUID | false |
Expand Down Expand Up @@ -174,118 +176,123 @@ Give a ⭐️ if you like the project!
[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://paypal.me/vincss)

## 📜 ChangeLog

- 1.11.0 - MC 1.21.x / Bedrock 1.21.40 :
- change discord settings
- change default useLegacyLogin & serverOnlineMode as a workarround
- update minecraft-protocol: 1.51.0
- 1.10.0 - MC 1.20.2 / Bedrock 1.21.40 :
- update @jsprismarine/prismarine : 0.12.0 ( bedrock 1.21.40 )
- 1.9.1 - 1.20.2 :
- add useLegacyLogin parameter, to use old login internally
- add useLegacyLogin parameter, to use old login internally
- 1.9.0 - 1.20.1 :
- add useWhitelistFile parameter to switch to whitelist.json instead of whiteListedNames (thanks
to spanasiuk)
- add useBlacklistFiles parameter to use banned-ips.json and banned-players.json (thanks to
spanasiuk)
- add useNativeFiles parameter to use server.properties for getting serverPort, maxPlayers,
serverOnlineMode, useWhitelistFile, and useBlacklistFiles properties (thanks to spanasiuk)
- change stdio streams on Windows when web-gui is used.
- add useWhitelistFile parameter to switch to whitelist.json instead of whiteListedNames (thanks
to spanasiuk)
- add useBlacklistFiles parameter to use banned-ips.json and banned-players.json (thanks to
spanasiuk)
- add useNativeFiles parameter to use server.properties for getting serverPort, maxPlayers,
serverOnlineMode, useWhitelistFile, and useBlacklistFiles properties (thanks to spanasiuk)
- change stdio streams on Windows when web-gui is used.
- 1.8.0 - 1.20.1 :
- add webAllowRestart parameter
- add minecraftAutostart parameter
- add restartDelay parameter
- add webAllowRestart parameter
- add minecraftAutostart parameter
- add restartDelay parameter
- 1.7.1 - 1.20.1 :
- Run mcsleeperstarter as a non-root user within the docker container
- Run mcsleeperstarter as a non-root user within the docker container
- 1.7.0 - 1.20.1 :
- [Feature] Added serverMOTD setting ( thanks to gavinhsmith )
- [UX] Made the Sleep button disappear while server is online when "preventStop" is true (
thanks to gavinhsmith )
- [Feature] Added serverMOTD setting ( thanks to gavinhsmith )
- [UX] Made the Sleep button disappear while server is online when "preventStop" is true (
thanks to gavinhsmith )
- 1.6.0 - 1.20.1 :
- add hideOnConnectionLogs parameter
- update minecraft-protocol: 1.43.2 ( minecraft 1.20.1 )
- add hideOnConnectionLogs parameter
- update minecraft-protocol: 1.43.2 ( minecraft 1.20.1 )
- 1.5.13 - 1.20.1 :
- add environement variable DISABLE_FILE_LOGS to disable file logs
- add environement variable DISABLE_FILE_LOGS to disable file logs
- 1.5.12 - 1.20.1 :
- update minecraft-protocol: 1.43.0 ( minecraft 1.20.1 )
- update minecraft-protocol: 1.43.0 ( minecraft 1.20.1 )
- 1.5.11 - 1.19.4 :
- update minecraft-protocol: 1.42.0 ( minecraft 1.19.4 )
- update minecraft-protocol: 1.42.0 ( minecraft 1.19.4 )
- 1.5.10 - 1.19.3 :
- webServeDynmap setting can be set to an url
- webServeDynmap setting can be set to an url
- 1.5.9 - 1.19.3 :
- backup config file before setting to default
- backup config file before setting to default
- 1.5.8 - 1.19.3 :
- reload settings on restart
- reload settings on restart
- 1.5.7 - 1.19.3 :
- restart on 'uncaughtException'
- restart on 'uncaughtException'
- 1.5.6 - 1.19.3 :
- do not exit on 'uncaughtException'
- do not exit on 'uncaughtException'
- 1.5.5 - 1.19.3 :
- add hideIpInLogs parameter
- add hideIpInLogs parameter
- 1.5.4 - 1.19.3 :
- add version number in start/stop minecraft
- add version number in start/stop minecraft
- 1.5.3 - 1.19.3 :
- docker: copy only needed binary
- docker: copy only needed binary
- 1.5.2 - 1.19.3 :
- docker: base image eclipse-temurin:17-jre-jammy
- docker: base image eclipse-temurin:17-jre-jammy
- 1.5.1 - 1.19.3 :
- add docker generation (@markmetcalfe)
- fix minecraftDirectory not being used as base path when serving dynmap via web GUI (
@markmetcalfe)
- add docker generation (@markmetcalfe)
- fix minecraftDirectory not being used as base path when serving dynmap via web GUI (
@markmetcalfe)
- 1.5.0 - 1.19.3 :
- add setting webSubPath
- add more architectures builds
- add setting favIconPath to use a png as icon.
- handle motd in serverName
- Thanks to markmetcalfe for thoses improvements
- update minecraft-protocol: 1.41.2
- add setting webSubPath
- add more architectures builds
- add setting favIconPath to use a png as icon.
- handle motd in serverName
- Thanks to markmetcalfe for thoses improvements
- update minecraft-protocol: 1.41.2
- 1.4.1 - 1.19.3 :
- update minecraft-protocol: 1.41.1
- disable bedrock by default
- add whiteListedNames
- update minecraft-protocol: 1.41.1
- disable bedrock by default
- add whiteListedNames
- 1.4.0 - 1.19.3 :
- set option 'version' to false by default (it should handle any compatible version).
- set option 'version' to false by default (it should handle any compatible version).
- 1.3.1 - 1.19.3 :
- update minecraft-protocol: 1.41.0
- update minecraft-protocol: 1.41.0
- 1.3.0 - 1.19.3 :
- add blackListedAddress parameters
- add dynmap
- add preventStop
- update minecraft-protocol: 1.40.3
- add blackListedAddress parameters
- add dynmap
- add preventStop
- update minecraft-protocol: 1.40.3
- 1.2.6 - 1.19.3 :
- update third-parties
- update third-parties
- 1.2.5 - 1.19.3 :
- update minecraft-protocol for MC 1.19.3
- update minecraft-protocol for MC 1.19.3
- 1.2.4 - 1.19.2 :
- update minecraft-protocol for MC 1.19.2 (no 1.19.3 yet)
- update minecraft-protocol for MC 1.19.2 (no 1.19.3 yet)
- 1.2.3 - 1.19 :
- update to Node18
- update to Node18
- 1.2.2 - 1.19 :
- add arm64 builds (Raspberry Pi)
- add arm64 builds (Raspberry Pi)
- 1.2.1 - 1.19 :
- update node-minecraft-protocol for MC 1.19 (no 1.19.1 & 1.19.2 yet)
- update node-minecraft-protocol for MC 1.19 (no 1.19.1 & 1.19.2 yet)
- 1.2.0 - 1.18.2 :
- Add settings webStopOnStart
- Change settings startMinecraft to boolean
- Add settings webStopOnStart
- Change settings startMinecraft to boolean
- 1.1.5 - 1.18.2 :
- Add more logs when it fails to retreive settings
- update node-minecraft-protocol ^1.34.0
- Add more logs when it fails to retreive settings
- update node-minecraft-protocol ^1.34.0
- 1.1.4 - 1.18.2 :
- update node-minecraft-protocol ^1.32.0
- update node-minecraft-protocol ^1.32.0
- 1.1.3 - 1.18.1 :
- Fixed concurent wake up : ./issues/68
- update node-minecraft-protocol ^1.30.0
- Fixed concurent wake up : ./issues/68
- update node-minecraft-protocol ^1.30.0
- 1.1.2 - 1.18.1 :
- Compress binaries ( GZip )
- Compress binaries ( GZip )
- 1.1.1 - 1.18.1 :
- update node-minecraft-protocol ^1.29.0 -> 1.18.1
- update node-minecraft-protocol ^1.29.0 -> 1.18.1
- 1.1.0 - 1.17.1 :
- **Feature** Add Discord Notification
- Update dependencies (node16, npm8, typescript,...)
- **Feature** Add Discord Notification
- Update dependencies (node16, npm8, typescript,...)
- 1.0.4 - 1.17.1 :
- update node-minecraft-protocol ^1.26.1
- update node-minecraft-protocol ^1.26.1
- 1.0.3 - 1.16.5 :
- update security
- update security
- 1.0.2 - 1.16.5 :
- add maxPlayers in settings
- add maxPlayers in settings
- 1.0.1 - 1.16.5 :
- Include version in log.
- Include version in log.
- 1.0.0 - 1.16.5 :
- **Feature** Add web-gui
- **Feature** Add web-gui
- 1.16.4 :
- Add bedrock support.
- Add bedrock support.
- ...
Loading

0 comments on commit e499bc2

Please sign in to comment.