AutoUpdatePlugins

AutoUpdatePlugins

[中文文档] -- [English document]

Download: https://modrinth.com/plugin/AutoUpdatePlugins

Functions and commands

• /aup Show plugin information

  • /aup reload Reload configuration
  • /aup update Run update manually
  • /aup log View full logs
  • /aup stop Stop the current update

• [x] Using the update directory for plugin updates

• [x] Automatically find download links based on plugin release page

  • GitHub, Jenkins, Spigot, Modrinth, Bukkit, Ghost Chop Build Station v2, MineBBS, CurseForge.
    • Support downloading pre-releases from GitHub.
    • Supports downloading files in GitHub Actions, enabling login-free downloading through https://nightly.link/
    • Support for specifying platforms in Modrinth
    • Support specifying the version in Modrinth

• [x] Support matching different files under the same release

  • GitHub, Jenkins, Modrinth.

• [x] Support for file integrity checking

• [x] Cache last update, no duplicate downloads.

• [x] No duplicate installation of updates

• [x] Error retry mechanism

• [x] Each update task can be configured individually.

• [x] Configurable certificate validation

• [x] Customizable output log level

• [x] Multi-language support!

• [ ] Support for running system commands while updating

[Usage statistics]

运行日志

[INFO]: [AUP] The update check will run after 64 seconds and repeat every 14400 seconds.
[INFO]: [AUP] [## Start running automatic updates ##]
[INFO]: [AUP] [EssentialsX.jar] Updating...
[INFO]: [AUP] [EssentialsX.jar] [Github] Version found: https://github.com/EssentialsX/Essentials/releases/download/2.20.1/EssentialsX-2.20.1. jar
[INFO]: [AUP] [EssentialsX.jar] Update complete [1.17MB] -> [2.92MB]
[INFO]: [AUP] [EssentialsXChat.jar] Updating...
[INFO]: [AUP] [EssentialsXChat.jar] [Github] Version found: https://github.com/EssentialsX/Essentials/releases/download/2.20.1/EssentialsXChat- 2.20.1.jar
[INFO]: [AUP] [EssentialsXChat.jar] Update complete [0.01MB] -> [0.01MB]
[INFO]: [AUP] [CoreProtect.jar] Updating...
[INFO]: [AUP] [CoreProtect.jar] [Modrinth] Version found: https://cdn.modrinth.com/data/Lu3KuzdV/versions/w3P6ufP1/CoreProtect-22.2.jar
[INFO]: [AUP] [CoreProtect.jar] file is up to date!
...
[INFO]: [AUP] [## Update all done ##]
[INFO]: [AUP] - Time consumed: 268 seconds
[INFO]: [AUP] - Failed: 2, Updated: 22, Completed: 24
[INFO]: [AUP] - Network requests: 48, Downloaded files: 40.10MB

配置

# How long to wait for the first update to run after the server has finished booting (seconds)
startupDelay: 64

# After the first run is complete, repeat the update at this frequency (seconds, reboot required after modification).
startupCycle: 14400 # 4h

# Plugin update directory, set as in bukkit.yml
# Note that the path must end with "/"
updatePath: './plugins/update/'

# Download the cache directory without modification
# New .jar files will be downloaded to the cache directory first, then moved to the plugin update directory after validation is complete
tempPath: './plugins/AutoUpdatePlugins/temp/'

# Directory of plugins or files the server is running, for hash checking
filePath: './plugins/'

# Enable the last update record and check for updates with this information (temp.yml)
enablePreviousUpdate: true

# File integrity check, only works on .jar / .zip files. Try to open it as a zip file, if it fails, it is incomplete.
zipFileCheck: true
# If the file configuration matches this regex, zip integrity checking is enabled, otherwise it is not enabled
zipFileCheckList: '\.(?:jar|zip)$'

# Do not move to the update directory if the hash of the downloaded file matches the hash of the file to be updated in the update directory (or the file running on the server) (MD5)
ignoreDuplicates: true

# Whether to enable SSL authentication, usually do not turn it off
sslVerify: true

# Failed network request retry count
fetchErrRetry: 4
# Initial retry delay, +2 seconds per retry
fetchErrRetryDelay: 5

# Setting up a web proxy
proxy:
  type: DIRECT # DIRECT | HTTP | SOCKS
  host: '127.0.0.1'
  port: 7890
  # Control proxy usage for different requests
  reqApi: true
  reqDownload: true

# Edit request headers in HTTP requests
setRequestProperty:
  - name: 'User-Agent'
    value: 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/142.0.0.0 Safari/537.36'

# 启用哪些日志等级
logLevel:
  - 'DEBUG'   # for debugging, can be commented out after testing is complete
  - 'MARK'    # Same as DEBUG, green color, used to mark task completion.
  - 'INFO'    # Output logs
  - 'WARN'    # Output warnings
  - 'NET_WARN'  # Warnings from the web request module


# Plugin List
# The URL supports automatic download of plugins from `GitHub, Jenkins, SpigotMC, Modrinth, Bukkit, 鬼斩构建站 v2, MineBBS, CurseForge` pages, while other links will download them directly.
# One of the `GitHub, Jenkins, Modrinth` pages can use the get parameter to download a specific file.
# GitHub links can be configured with `getPreRelease: true` to download the latest pre-release version.
list:

  - file: 'AutoUpdatePlugins自动更新.jar'
    url: https://modrinth.com/plugin/autoupdateplugins

### Example configurations ### Note Yaml formatting during testing

#  - file: 'EssentialsX.jar' # Github
#    url: https://github.com/EssentialsX/Essentials
#    get: 'EssentialsX-.*\.jar'  # If there is more than one file in the GitHub/Jenkins distribution, you need to match one of them, otherwise download the first one (using the regular expression

#  - file: 'EssentialsXChat.jar' # Match different files in the same release
#    url: https://github.com/EssentialsX/Essentials
#    get: 'EssentialsXChat-.*\.jar'

#  - file: 'TrPlugins.jar'  # Download the file from GitHub Actions
#    url: https://github.com/TrPlugins/TrChat/actions
#    get: 'TrChat Artifacts'  # Match the names of Artifacts Produced during runtime
#    zipGet: 'TrChat-[\.\d]+\.jar'  # Decompression: Match files in compressed packages

#  - file: 'Chat2QQ.jar'
#    url: https://github.com/ApliNi/Chat2QQ/actions
#    get: 'Chat2QQ\.jar'
#    zipGet: 'Chat2QQ\.jar'

#   - file: 'test.jar'
#     url: https://www.spigotmc.org/resources/invsee.82342/
#     zipGet: 'InvSee\+\+\.jar' # Unzip the file

#  - file: 'Geyser-Spigot.jar' # URL
#    url: https://download.geysermc.org/v2/projects/geyser/versions/latest/builds/latest/downloads/spigot

#  - file: 'ViaVersion-DEV.jar' # Jenkins
#    url: https://ci.viaversion.com/job/ViaVersion-DEV/

#  - file: 'ViaBackwards-DEV.jar'
#    url: https://ci.viaversion.com/view/ViaBackwards/job/ViaBackwards-DEV/

#  - file: 'CoreProtect.jar' # Modrinth
#    url: https://modrinth.com/plugin/coreprotect/

#  - file: 'simple-voice-chat.jar'
#    url: https://modrinth.com/plugin/simple-voice-chat
#    loader: paper # Specify platform
#    version: ServerVersion # Specify version, '1.21.10' / ServerVersion

#  - file: 'UseTranslatedNames.jar'
#    url: https://modrinth.com/plugin/usetranslatednames

#  - file: 'HttpRequests.jar' # SpigotMC
#    url: https://www.spigotmc.org/resources/http-requests.101253/

#  - file: 'Chunky.jar' # MineBBS
#    url: https://www.minebbs.com/resources/chunky-tps.7318/

#  - file: 'SF4_Slimefun4.jar' # 鬼斩构建站 v2
#    url: https://builds.guizhanss.com/StarWishsama/Slimefun4/master

#  - file: 'SF4_FluffyMachines.jar'
#    url: https://builds.guizhanss.com/SlimefunGuguProject/FluffyMachines/master

#  - file: 'Dynmap.jar'
#    url: https://legacy.curseforge.com/minecraft/bukkit-plugins/dynmap

#  # Configuration can be added to each file like this
#  # If the file configuration contains a path, the path parameter is automatically set.
#  - file: './serverConfig.yml'
#    url: 'http://[::]:5212/serverConfig.yml'


### All available configurations in list ###
# Unless you know what you're doing, don't use it willy-nilly.
# String file;              // File name
# String url;               // Download link
# String tempPath;          // download cache path, use global configuration by default
# String updatePath;        // update path, used globally by default
# String filePath;          // The final installation path, used globally by default.
# String path;              // Overriding both updatePath and filePath configurations
# String get;               // Regular expression to select the specified file, first one is selected by default. GitHub, Jenkins, Modrinth only.
# String zipGet;            // If you need to unzip files, use this parameter to specify the regular expression.
# String loader;            // Match platform tags, Modrinth only
# String version;           // Match plugin version, Modrinth only, Fill in "ServerVersion" to automatically select the server version
# String c_version_type;    // Version type (Release channel), For example beta, release, Modrinth only
# boolean getPreRelease;    // Allow downloading of pre-releases, false by default. GitHub only.
# boolean zipFileCheck;     // Enable zip file integrity checking
# boolean ignoreDuplicates; // Turn off hash checking


# Edit the messages the plugin may display here
message:
  updateCheckIntervalTooLow: '#### Update check interval too low will cause performance problems! ###'
  timer: 'The update check will run after %1 seconds and repeat at %2 second intervals'
  commandReloadOnUpdating: 'Currently running update, configuration reload will be postponed'
  commandReloadOK: 'Reload completed'
  commandRepeatedRunUpdate: 'There is already an unfinished update running'
  commandUpdateStart: 'Update is running!'
  commandFullLog: 'Full log:'
  commandStopUpdateIng: 'Current updates are being stopped...'
  stopUpdate: 'Too many requests'
  repeatedRunUpdate: '### The update program started repeatedly or with errors? ###'
  updateStart: '[### Start running automatic updates ##]'
  configErrList: 'Error configuring update list? '
  configErrUpdate: 'Update list configuration error? Item is empty.'
  configErrMissing: 'Error updating list configuration? Missing basic configuration'
  updateChecking: 'Checking for updates...'
  updateErrParsingDUrl: 'Error parsing direct file links, will skip this update'
  updateTempAlreadyLatest: '[Cached] file is already latest'
  updateErrDownload: 'Error downloading file, will skip this update'
  updateZipFileCheck: '[Zip integrity check] File is incomplete, will skip this update'
  updateFileAlreadyLatest: 'File is already latest'
  updateFulSizeDifference: 'Update completed [%1MB] -> [%2MB]'
  updateFul: '[## Update All Complete ##]'
  updateFulTime: 'Time taken: %1 seconds'
  updateFulFail: 'Failed: %1,'
  updateFulUpdate: 'Update: %1,'
  updateFulOK: 'Success: %1'
  updateFulNetRequest: 'Network Request: %1, '
  updateFulDownloadFile: 'Downloading file: %1MB'
  logReloadOK: 'Reload completed'
  debugGetVersion: 'Found version: %1'
  debugNoFileMatching: 'No file matching: %1'
  debugNoRepositoryPath: 'Repository path not found: %1'
  debugErrUrlResolveNoID: 'URL resolving error, plugin ID not included?'
  debugErrUrlResolveNoName: 'URL resolution error, project name not found: %1'
  debugErrNoID: 'Project ID not found: %1'
  urlInvalid: 'URL is invalid or irregular: %1'
  networkErrorRetry: 'Network error, please wait %1 seconds...'
  zipDecompressionFailed: 'ZIP decompression failed'

Some of the features and code references are from project NewAmazingPVP/AutoUpdatePlugins.