____                __  __        __     __         
  / __/__ ____ __ __  / / / /__  ___/ /__ _/ /____ ____
 / _// _ `(_-</ // / / /_/ / _ \/ _  / _ `/ __/ -_) __/
/___/\_,_/___/\_, /  \____/ .__/\_,_/\_,_/\__/\__/_/   
             /___/       /_/                          

README LANGUAGES [ English | 中文 ]

EasyUpdater

Easy (to keep) updates!

Advanced plugin and config updater, which can keep plugins up-to-dates and mixin specific configuration files.

Features & Advantages

• Pattern (Regex) support!
• Transfer files from the sources!
• Mixin specific configuration files!
• Import other update configs!

Usages & Examples

Download the latest version of the EasyUpdater from the releases and put it in the folder of your application.

Then, create a new file named updates.yml or any other name you like.

# Import other update configs, which will be loaded before this file.
# All configs will be run in order.
import:
  - "<path-to-other-config>/general-updates.yml"

# Transfer files from the sources.
transfer:
  "task1":
    source: "<path-to-plugin-source>/ExamplePlugin-(.*)-SNAPSHOT.jar" # The source file path.
    target: "plugins/ExamplePlugin(.*).jar" # The target file path.
    options:
      rename: "ExamplePlugin-$1.jar"
  "task2":
    source: "<path-to-plugin-source>/some-files/"
    target: "libraries" # Target folder
    options:
      override: true # Override the files in the target folder.
      filter:
        - "*.log"
        - "*.log.gz"

# Mixin specific configuration files.
mixin:
  task1:
    schema: YAML # Optional, auto-detected by file suffix if not provided.
    source: "<path-to-source>/xxx.yaml"
    target: "plugins/some-plugin/config.yml"
  task2:
    source: "<path-to-source>/survival.properties"
    target: "server.properties"

Finally, run java -jar EasyUpdater.jar [config-file-path] to start the updater before your own application boot up.

Support and Donation

If you appreciate this plugin, consider supporting me with a donation!

Thank you for supporting open-source projects!

Many thanks to Jetbrains for kindly providing a license for us to work on this and other open-source projects.

Open Source License

This project's source code is licensed under the GNU LESSER GENERAL PUBLIC LICENSE.