HSGamer / MCServerUpdater

A program to update Minecraft server jar

Home Page:https://www.spigotmc.org/resources/mcserverupdater.98003/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

MCServerUpdater

This is a simple program that will check for updates to Minecraft server jar and download them if they are available.

Download

Download the latest version of MCServerUpdater from here

Arguments

Option                           Description
------                           -----------
--help                           Get the list of arguments
--projects                       Get the list of projects
--output <String>                The output file path (default: server.jar)
--project <String>               The project to download (default: paper)
--version <String>               The project version (default: default)

Examples

  • List all available projects
    • java -jar MCServerUpdater.jar --projects
  • Download the latest build of Paper
    • java -jar MCServerUpdater.jar
    • java -jar MCServerUpdater.jar --project paper
  • Download the latest build of Paper and save it to the file server.jar
    • java -jar MCServerUpdater.jar --output server.jar
    • java -jar MCServerUpdater.jar --project paper --output server.jar
  • Download the latest build of Paper 1.17.1
    • java -jar MCServerUpdater.jar --project paper --version 1.17.1

Use this in your projects

  1. Add this as a dependency
  • Maven
<repositories>
    <repository>
        <id>codemc-repo</id>
        <url>https://repo.codemc.io/repository/maven-public/</url>
    </repository>
</repositories>
<dependencies>
    <dependency>
        <groupId>me.hsgamer</groupId>
        <artifactId>mc-server-updater-lib</artifactId>
        <version>VERSION</version>
    </dependency>
</dependencies>
  • Gradle
repositories {
    maven { url = "https://repo.codemc.io/repository/maven-public/" }
}

dependencies {
    compileOnly(group: 'me.hsgamer', name: 'mc-server-updater-lib', version: 'VERSION')
}
  1. Use the UpdateBuilder to create, execute the update process and get the result as UpdateStatus
import java.util.concurrent.CompletableFuture;

class Main {
  public static void main(String[] args) {
    UpdateBuilder builder = UpdateBuilder.updateProject("paper")
            .version("1.17.1")
            .outputFile("server.jar");

    // Execute the update process asynchronously
    CompletableFuture<UpdateStatus> future = builder.executeAsync();
    
    // Execute the update process synchronously
    UpdateStatus status = builder.execute();
  }
}
  1. Do whatever you want with the UpdateStatus

Additional System Properties

Name Description Default
MCServerUpdater.javaExecutable The Java executable to run external processes (Spigot Updater, etc.) java