jiriks74/msman.sh
1
0
Fork 0
Code Issues Pull requests Projects Releases 20 Packages Wiki Activity

Merge pull request #4 from jiriks74/devel

Browse source 
Refactor, allow version changing, update readme
This commit is contained in:
Jiří Štefka 2023-02-23 05:21:21 +01:00 committed by GitHub
commit 53b399616b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 425 additions and 243 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

97
README.md
View file

@ -1,42 +1,107 @@
# start_papermc.sh
A better script for running Paper Minecraft server with features such as automatic build updates, automatic downlading, interactive eula accepting, interactive updating, etc.
> **Warning**
>
> - This script is not made for migrating versions. If you're migrating versions, delete your old server's `.jar` file and change the version in the script's settings
> - I am not responsible for any lost data
> - If enough people request it (or someone creates a PR) I'll add this functionality
A better script for running Paper Minecraft server with features such as
version downlading, automatic build update, interactive eula accepting, protection
against accidental version update, Aikar's flags out of the box, etc.
## Table of contents
<!-- TOC start -->
- [Dependencies](#dependencies)
- [Basic setup](#basic-setup)
- [Updating](#updating)
- [Builds](#builds)
- [Versions](#versions)
- [Default JVM flags used](#default-jvm-flags-used)
<!-- TOC end -->
<!-- TOC --><a name="start_papermcsh"></a>
<!-- TOC --><a name="dependencies"></a>
## Dependencies
- `jq`
- `awk`
- `curl`
Most, if not all, of these should be already available on your system if you're running something like Ubuntu.
<!-- TOC --><a name="basic-setup"></a>
## Basic setup
> **Note**
>
> Everything mentioned below is modified at the top of the `start.sh` file
1. Clone this repository and enter the directory: `git clone https://github.com/jiriks74/start_papermc.sh minecraft_server && cd minecraft_server`
1. Clone this repository and enter the directory:
```bash
git clone https://github.com/jiriks74/start_papermc.sh minecraft_server && cd minecraft_server
```
> **Note**
>
> If you want to have the server under some specific directory name, just change `minecraft_server` to something else
> If you want to have the server under some specific directory name, just change
`minecraft_server` to something else
2. Open `star.sh` in your favorite editor *(eg. `nano start.sh)*
2. Open `start.sh` in your favorite editor *(eg. `nano start.sh`)*
3. Change the `version` variable to the version you want
```bash
version="1.12.2"
3. Change the `select_version` variable to the version you want
```bash
select_version="1.12.2"
```
4. If you want a specific build, set the `select_build` variable. Othervise the sript will download the latest build:
```bash
```bash
select_build="1620"
```
5. Select how much memory you want your server to use ***(in megabytes)***:
```bash
```bash
mem="8000M"
```
6. Allow executing ov the script with `chmod +x start.sh`
7. Run the script with `./start.sh`
6. Add execute flag to the script:
```bash
chmod +x start.sh
```
7. Start the script
```bash
./start.sh
```
<!-- TOC --><a name="updating"></a>
## Updating
<!-- TOC --><a name="builds"></a>
### Builds
This script can automatically update to the latest papermc build available for the
Minecraft version you selected. If you want this behaviour, leave the `select_build`
veriable empty.
Otherwise select the build you want and the script will download it for you.
<!-- TOC --><a name="versions"></a>
### Versions
> **Warning**
>
> - This script is not made for migrating versions. It won't make sure your plugins
are working or that your worlds won't get corrupted. It only downloads a new server
file, nothing else.
> - **I am not responsible for any lost data**
This script is able to update/downgrade versions as you please. Just change the
`select_version` variable to the version you want and the script will download
it for you.
<!-- TOC --><a name="default-jvm-flags-used"></a>
## Default JVM flags used
By default this script uses [Aikar's Flags](https://docs.papermc.io/paper/aikars-flags). It's set up so that it automatically modifies them if over

BIN
paper-1.12.2-1620.jar
View file

Binary file not shown.

459
start.sh
View file

@ -18,7 +18,7 @@
# I am not responsible for any loss of data #
# !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! #
# If enough people request it (or someone creates a PR) I'll add the functionality to migrate versions
version="1.12.2"
select_version="1.19.3"
# Leave blank to use the latest build (auto updates on every run)
select_build=""
@ -32,96 +32,71 @@ select_build=""
# lower than your available memory if you're running just the #
# minecraft server. #
# !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! #
mem="2000M"
mem="6000M"
#############
# Overrides #
#############
# Shouldn't be needed, but if for whatever reason you want to override some things, use the below options
java_version_override=false
# Aikar's flags are used by defauls (https://docs.papermc.io/paper/aikars-flags)
# And are set by memory usage so if you allocated more than 12GB or RAM they are set automatically
override_java_flags=false
java_launchoptions=""
# Flags for the server itself
mc_launchoptions="-nogui"
# ------------------------------------------------
# You shouldn't need to change anything below this
# ------------------------------------------------
# Options for the server
mc_launchoptions="-nogui"
# API URL
api_url="https://api.papermc.io/v2/projects/paper/versions/$select_version/builds"
if [[ "${mem%M}" -gt 12000 ]]; then
G1NewSize=40
G1MaxNewSize=50
G1HeapRegionSize=16M
G1Reserve=15
InitiatingHeapOccupancy=20
else
G1NewSize=30
G1MaxNewSize=40
G1HeapRegionSize=8M
G1Reserve=20
InitiatingHeapOccupancy=15
fi
# Aikar's flags are used by default
# See https://docs.papermc.io/paper/aikars-flags
java_launchoptions="-Xms$mem -Xmx$mem -XX:+UseG1GC -XX:+ParallelRefProcEnabled -XX:MaxGCPauseMillis=200 -XX:+UnlockExperimentalVMOptions -XX:+DisableExplicitGC -XX:+AlwaysPreTouch -XX:G1NewSizePercent=$G1NewSize -XX:G1MaxNewSizePercent=$G1MaxNewSize -XX:G1HeapRegionSize=$G1HeapRegionSize -XX:G1ReservePercent=$G1Reserve -XX:G1HeapWastePercent=5 -XX:G1MixedGCCountTarget=4 -XX:InitiatingHeapOccupancyPercent=$InitiatingHeapOccupancy -XX:G1MixedGCLiveThresholdPercent=90 -XX:G1RSetUpdatingPauseTimePercent=5 -XX:SurvivorRatio=32 -XX:+PerfDisableSharedMem -XX:MaxTenuringThreshold=1 -Dusing.aikars.flags=https://mcflags.emc.gs -Daikars.new.flags=true"
# Api url
url="https://api.papermc.io/v2/projects/paper/versions/$version/builds"
##########
# Checks #
##########
# Check if selected version exists
if curl -s "$url" | grep -q '{"error":"Version not found."}'; then
echo "Error: Invalid version selected: $version"
exit 1
else
# Check if selected build exists
if [ ! -z "$select_build" ]; then
if curl -Is "https://api.papermc.io/v2/projects/paper/versions/$version/builds/$select_build/downloads/paper-$version-$select_build.jar" | grep "HTTP/2 404" >/dev/null; then
echo "Error: Invalid build selected: $select_build"
exit 1
fi
fi
fi
# Check if curl is installed
if ! command -v curl &> /dev/null
then
# Check for dependencies
function check_dependencies {
# Check if curl is installed
if ! command -v curl &> /dev/null
then
echo "Error: Curl is not installed"
exit 1
fi
fi
# Check if jq is installed
if ! command -v jq &> /dev/null
then
# Check if jq is installed
if ! command -v jq &> /dev/null
then
echo "Error: jq is not installed"
exit 1
fi
fi
# Check if awk is installed
if ! command -v awk &> /dev/null
then
# Check if awk is installed
if ! command -v awk &> /dev/null
then
echo "Error: awk is not installed"
exit 1
fi
fi
}
# Check if java is installed
if ! command -v java &> /dev/null
then
echo "Error: Java is not installed"
java_version="0"
fi
#####################################################
# Check if the correct version of Java is installed #
#####################################################
#
# Extract the middle number of the Minecraft version
minecraft_middle=$(echo "$version" | awk -F '.' '{print $2}')
# If java is installed, get the version (the java_version won't be 0)
if [[ $java_version != "0" ]]; then
# Get the current Java version and extract the build number
java_version=$(java -version 2>&1 | awk -F '"' '/version/ {print $2}' | awk -F '.' '{print $1}')
fi
# Check if the version and build are valid
function check_version_valid {
if curl -s "$api_url" | grep -q '{"error":"Version not found."}'; then
echo "Error: Invalid version selected: $select_version"
exit 2
else
# Check if selected build exists
if [ ! -z "$select_build" ]; then
if curl -Is "https://api.papermc.io/v2/projects/paper/versions/$select_version/builds/$select_build/downloads/paper-$select_version-$select_build.jar" | grep "HTTP/2 404" >/dev/null; then
echo "Error: Invalid build selected: $select_build"
exit 2
fi
fi
fi
}
# Ask if the user wants to continue anyway
# If the user doesn't answer in 15 seconds, the script will exit
@ -130,153 +105,266 @@ function ask_continue {
answer=""
echo "You have 15 seconds to respond before the script exits."
read -t 15 -p "Do you want to continue anyway? [y/N]: " answer
if [[ $answer != "y" ]] || [[ $answer != "Y" ]]; then
if [[ $answer != "y" ]] && [[ $answer != "Y" ]]; then
echo "Exiting..."
exit 1
fi
fi
}
# Check if the correct version of java is installed
# Check if the correct version of Java is installed
# For version 1.8 to 1.11 use java 8
# For version 1.12 to 1.16.4 use java 11
# For version 1.16.5 use java 16
# For version 1.17.1 to 1.18.1+ use java 17
if (( 8 <= minecraft_middle && minecraft_middle <= 11 )); then
function check_java {
# Check if java is installed
if ! command -v java &> /dev/null
then
echo "Error: Java is not installed"
java_version="0"
fi
# Extract the middle number of the Minecraft version
minecraft_middle=$(echo "$select_version" | awk -F '.' '{print $2}')
# If java is installed, get the version (the java_version won't be 0)
if [[ $java_version != "0" ]]; then
# Get the current Java version and extract the build number
java_version=$(java -version 2>&1 | awk -F '"' '/version/ {print $2}' | awk -F '.' '{print $1}')
fi
# Check if the correct version of java is installed
if (( 8 <= minecraft_middle && minecraft_middle <= 11 )); then
if ! [[ $java_version -eq 8 ]]; then
echo "Java 8 is required for Minecraft version $version. Please install Java 8."
echo "Java 8 is required for Minecraft version $select_version. Please install Java 8."
if [[ $java_version == 0 ]]; then
exit 1
exit 3
fi
ask_continue
fi
elif (( 12 <= minecraft_middle && minecraft_middle <= 16 )); then
elif (( 12 <= minecraft_middle && minecraft_middle <= 16 )); then
if ! [[ $java_version -eq 11 ]]; then
if [[ $java_version == 0 ]]; then
exit 1
exit 3
fi
echo "Java 11 is required for Minecraft version $version. Please install Java 11."
echo "Java 11 is required for Minecraft version $select_version. Please install Java 11."
ask_continue
fi
elif (( minecraft_middle == 17 )); then
elif (( minecraft_middle == 17 )); then
if ! [[ $java_version -eq 16 ]]; then
echo "Java 16 is required for Minecraft version $version. Please install Java 16."
echo "Java 16 is required for Minecraft version $select_version. Please install Java 16."
if [[ $java_version == 0 ]]; then
exit 1
exit 3
fi
ask_continue
fi
elif (( 18 <= minecraft_middle )); then
elif (( 18 <= minecraft_middle )); then
if ! [[ $java_version -eq 17 ]]; then
echo "Java 17 is required for Minecraft version $version. Please install Java 17."
echo "Java 17 is required for Minecraft version $select_version. Please install Java 17."
if [[ $java_version == 0 ]]; then
exit 1
exit 3
fi
ask_continue
fi
else
echo "Unsupported Minecraft version $version."
else
echo "Unsupported Minecraft version $select_version."
if [[ $java_version == 0 ]]; then
exit 1
exit 3
fi
ask_continue
fi
fi
}
# Check if some server already exists
if ls paper-*.jar 1> /dev/null 2>&1; then
# Get existing version and build
function get_existing_version {
if ls paper-*.jar 1> /dev/null 2>&1; then
# Get the current server file name
server_file=$(basename ./paper-*.jar)
# Extract the build number using cut command
# Extract the version and build number using cut command
current_version=$(echo "$server_file" | cut -d'-' -f2)
current_build=$(echo "$server_file" | cut -d'-' -f3)
current_version="${current_version%-*}"
current_build="${current_build%.jar}"
echo "Current server file: $server_file"
echo " - Version $current_version"
echo " - Build $current_build"
else
echo "No old server file found."
server_file=false
fi
}
# Check if select_build variable is set
if [ -z "$select_build" ]; then
echo "Checking for newer build..."
json_response=$(curl -s "$url") # Get all the versions from the paper api
# Download server set by $select_version and $download_build
function download_server {
# Download the server
echo "Downloading PaperMC server..."
echo " - Version $select_version"
echo " - Build $download_build"
curl -s "https://api.papermc.io/v2/projects/paper/versions/$select_version/builds/$download_build/downloads/paper-$select_version-$download_build.jar" -o "./paper-$select_version-$download_build.jar"
echo "Download complete."
}
# Delete old server file with name $old_server_file
function delete_old_server {
# Delete the old server file
echo "Deleting old server file $server_file..."
rm "$old_server_file"
echo "Old server file deleted."
}
# Set arguments for java
function set_java_args {
# Check if $override_flags is not true
if [[ $override_flags != true ]]; then
if [[ "${mem%M}" -gt 12000 ]]; then
G1NewSize=40
G1MaxNewSize=50
G1HeapRegionSize=16M
G1Reserve=15
InitiatingHeapOccupancy=20
else
G1NewSize=30
G1MaxNewSize=40
G1HeapRegionSize=8M
G1Reserve=20
InitiatingHeapOccupancy=15
fi
# Aikar's flags are used by default
# See https://docs.papermc.io/paper/aikars-flags
java_launchoptions="-Xms$mem -Xmx$mem -XX:+UseG1GC -XX:+ParallelRefProcEnabled -XX:MaxGCPauseMillis=200 -XX:+UnlockExperimentalVMOptions -XX:+DisableExplicitGC -XX:+AlwaysPreTouch -XX:G1NewSizePercent=$G1NewSize -XX:G1MaxNewSizePercent=$G1MaxNewSize -XX:G1HeapRegionSize=$G1HeapRegionSize -XX:G1ReservePercent=$G1Reserve -XX:G1HeapWastePercent=5 -XX:G1MixedGCCountTarget=4 -XX:InitiatingHeapOccupancyPercent=$InitiatingHeapOccupancy -XX:G1MixedGCLiveThresholdPercent=90 -XX:G1RSetUpdatingPauseTimePercent=5 -XX:SurvivorRatio=32 -XX:+PerfDisableSharedMem -XX:MaxTenuringThreshold=1 -Dusing.aikars.flags=https://mcflags.emc.gs -Daikars.new.flags=true"
fi
}
# Ask if the new server version differs from the old one
function ask_version_differs {
echo
echo
echo "The server version differs from the one you selected."
echo "The server version is $current_version and the selected version is $select_version."
echo "Do you want to update the server version?"
echo "This can cause many issues if you don't know what you are doing."
echo
echo "I am not responsible for any damage caused by updating the server version."
echo
echo "You have 15 seconds to respond, or the script will exit"
read -t 15 -p "Do you want to update the server version? [y/N] " version_differs
if [ "$version_differs" != "y" ] && [ "$version_differs" != "Y" ]; then
echo "Server version not updated."
echo "To start the server again with the current version, change the version in the config to $current_version."
exit 4
fi
if [ "$version_differs" == "y" ] || [ "$version_differs" == "Y" ]; then
read -t 15 -p "Are you sure you want to update the server version? [y/N] " version_differs
if [ "$version_differs" != "y" ] && [ "$version_differs" != "Y" ]; then
echo "Server version not updated."
echo "To start the server again with the current version, change the version in the config to $current_version."
exit 4
fi
fi
}
# Check if up to date
function check_up_to_date {
if [[ $server_file == false ]]; then
download_build=$latest_build
update_version=true
update_build=true
fi
# Check if $select_build is empty
if [[ -z $select_build ]]; then
# Check if the current version is the same as the one selected
if [[ $current_version == $select_version ]]; then
# Check if the current build is the same as the one selected
if [[ $current_build == $latest_build ]]; then
echo "Server is up to date."
else
echo "Server is not up to date."
download_build=$latest_build
update_build=true
fi
else
# Check if $server_file is false
if [[ $server_file != false ]]; then
ask_version_differs
echo "Server is not up to date."
download_build=$latest_build
update_version=true
fi
fi
else
# Check if the current version is the same as the one selected
if [[ $current_version == $select_version ]]; then
# Check if the current build is the same as the one selected
if [[ $current_build == $select_build ]]; then
echo "Server is up to date."
else
echo "Server is not up to date."
download_build=$select_build
update_build=true
fi
else
# Check if $server_file is false
if [[ $server_file != false ]]; then
ask_version_differs
echo "Server is not up to date."
download_build=$select_build
update_version=true
fi
fi
fi
}
# Get the latest build number
function get_latest_build {
# Get the latest build number
latest_build=$(curl -s $url | jq '.builds[-1].build')
latest_build=$(curl -s $api_url | jq '.builds[-1].build')
}
# Check if the latest build is newer than the current build
if [ "$latest_build" -gt "$current_build" ]; then
echo "Newer build available: $latest_build"
# Check for updates
function check_and_update {
# Get current version and build
get_existing_version
# Ask the user if they want to download and install the new build
echo
echo
echo "You have 15 seconds to answer, then the new build will be downloaded automatically"
read -t 15 -p "Do you want to download and install the new build? (Y/n) " answer
# If the user doesn't answer set the answer to "y"
if [ -z "$answer" ]; then
answer="y"
fi
if [ "$answer" == "y" ]; then
# Download the new build
echo "Downloading the new build..."
curl -s "https://api.papermc.io/v2/projects/paper/versions/$version/builds/$latest_build/downloads/paper-$version-$latest_build.jar" -o "./paper-$version-$latest_build.jar"
echo "Download complete"
# Remove the old server file
echo "Removing the old server file..."
rm "$server_file"
echo "Old server file removed"
server_file=$(basename ./paper-*.jar)
else
echo "Skipping download and installation"
fi
else
echo "Server is up to date"
fi
else
if [ "$current_build" -ne "$select_build" ]; then
echo "The current build is not the selected build"
echo "Downloading the selected build..."
curl -s "https://api.papermc.io/v2/projects/paper/versions/$version/builds/$select_build/downloads/paper-$version-$select_build.jar" -o "./paper-$version-$select_build.jar"
echo "Download complete"
echo "Removing the old server file..."
rm "$server_file"
echo "Old server file removed"
server_file=$(basename ./paper-*.jar)
fi
fi
# If no server file exists
else
# Check if select_build variable is set
if [ -z "$select_build" ]; then
echo "Downloading the latest build of version $version..."
json_response=$(curl -s "$url")
echo Checking for updates...
# Get the latest build number
latest_build=$(curl -s $url | jq '.builds[-1].build')
get_latest_build
curl -s "https://api.papermc.io/v2/projects/paper/versions/$version/builds/$latest_build/downloads/paper-$version-$latest_build.jar" -o "./paper-$version-$latest_build.jar"
echo "Download complete"
# Check if the current version is up to date
check_up_to_date
# Check if $build_update is true or $version_update is true
if [[ $update_build == true ]] || [[ $update_version == true ]]; then
if [[ $server_file != false ]]; then
old_server_file=$server_file
server_file="paper-$select_version-$download_build.jar"
download_server
# Delete the old server file
delete_old_server
else
echo "Downloading version $version build $select_build..."
curl -s "https://api.papermc.io/v2/projects/paper/versions/$version/builds/$select_build/downloads/paper-$version-$select_build.jar" -o "./paper-$version-$select_build.jar"
echo "Download complete"
server_file="paper-$select_version-$download_build.jar"
download_server
fi
fi
fi
}
if test "$(cat eula.txt 2>/dev/null)" != "eula=true"; then
# Accept EULA
function accept_eula {
if test "$(cat eula.txt 2>/dev/null)" != "eula=true"; then
echo
echo
echo "'eula.txt' does not exist or is not accepted"
echo "Please agree to the Minecraft EULA by entering 'y'"
echo "'eula.txt' does not exist or EULA is not accepted"
echo "You have to accept the Minecraft EULA to run the server"
echo "By entering 'y' you are indicating your agreement to Minecraft's EULA (https://aka.ms/MinecraftEULA)."
echo "You have 15 seconds to respond, or the script will exit"
read -t 15 -p "Do you agree to the Minecraft EULA? [y/N] " eula_agreed
if [ "$eula_agreed" == "y" ]; then
if [ "$eula_agreed" == "y" ] || [ "$eula_agreed" == "Y" ]; then
if [ ! -f eula.txt ]; then
# Write eula_agreed to eula.txt
echo "eula=true" > eula.txt
else
rm eula.txt
@ -292,10 +380,39 @@ if test "$(cat eula.txt 2>/dev/null)" != "eula=true"; then
echo "Exiting..."
exit 1
fi
fi
fi
}
# Run the server
echo
echo
echo "Starting the server..."
java $java_launchoptions -jar "$(basename ./paper-*.jar)" $mc_launchoptions
# Launch the server
function launch_server {
echo
echo
echo "Starting the server..."
echo
echo
java $java_launchoptions -jar "$(basename ./paper-*.jar)" $mc_launchoptions
}
# Main function
function main {
# Check dependencies
check_dependencies
# Check if the version and build are valid
check_version_valid
# Check if the correct java version is installed
check_java
# Check if the server is up to date and if not, update it
check_and_update
# Accept EULA
accept_eula
# Launch the server
launch_server
}
# Run the main function
main