Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
FHomps authored Feb 18, 2021
1 parent 9b9c39f commit 16f29e4
Showing 1 changed file with 8 additions and 9 deletions.
17 changes: 8 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,16 @@
# papermc_scripts
Simple custom scripts for PaperMC minecraft server administration.
# MCBC
## Minecraft Bash Controller

These scripts assume that your Paper server is installed in a folder named "paper" in the home directory of the user who runs them.
A simple custom script for minecraft server administration. Easy commands for turning the server on and off, automatically updating the jar file, and backing up the server.

The scripts are made to work nicely with cron to make backups of your server; ```backup.sh``` is smart and will not backup the server if no players were online since the last backup.
MCBC is made to work nicely with cron; the backup command is smart and will not backup the server if no players were online since the last backup.

You can still trigger all the scripts manually. ```backup.sh``` accepts the arguments --live (for backups while the server is online) and --noskip (for forcing a backup even with no detected player activity).

Note that if you execute ```stop.sh``` then ```start.sh```, ```backup.sh``` won't know if players were present before the restart and will skip backupping until a player logs in. ```restart.sh``` automatically asks for an offline backup and as such does not have this problem.
Note that if you stop then start the server, MCBC won't know if players were present before the restart and will skip backupping until a player logs in. Directly restarting with MCBC automatically asks for an offline backup and as such does not have this problem.

My personal crontab configuration:

```
50 1 * * * ~/paper/announce_restart.sh
0,30 0-1,3-23 * * * ~/paper/backup.sh --live
50 1 * * * ~/paper/mcbc.sh announce_restart
0 0-1,3-23 * * * ~/paper/mcbc.sh backup --live
30 * * * * ~/paper/mcbc.sh backup --live
```

0 comments on commit 16f29e4

Please sign in to comment.