Sakura Updater

(中文版请向下滚动 | Scroll down for Chinese version)

Introduction

SakuraUpdater is a NeoForge Minecraft mod that enables automatic synchronization of mod files between a server and clients, allowing players to receive server updates automatically, similar to other games.

Features

• [x] 🔄 Automatic server update checks
• [x] 🕒 Display update logs in the update UI
• [x] 📁 Multiple sync modes supported (mirror, push, ignore)
• [x] 🎮 Graphical update UI
• [x] ⚙️ Configurable client and server settings
• [x] 🚀 The server can run independently

Installation

Server-side installation

1. Place sakuraupdater-[version].jar into the server's mods folder.
2. Start the server. Configuration files will be generated on first run.
3. Edit the server configuration file at config/sakuraupdater-server.toml.

Client-side installation

1. Place sakuraupdater-[version].jar into the client's mods folder.
2. Start the game. Configuration files will be generated on first run.
3. Edit the client configuration file at config/sakuraupdater-client.toml.

Server-side independent operation

1. Place sakuraupdater-[version].jar into a separate folder.
2. Run the server independently with java -jar sakuraupdater-[version].jar.
3. Edit the standalone server configuration file at sakuraupdater-common.toml.

Runtime dependencies

The same JAR supports NeoForge and java -jar standalone operation. Dependencies are no longer bundled. Standalone startup obtains SQLite JDBC 3.46.0.0, Gson 2.10, NightConfig core/toml 3.8.1, and SLF4J api/simple 2.0.9. NeoForge servers only obtain SQLite when opening the database; ordinary clients do not download these libraries.

First startup needs internet access: downloads try Aliyun Central (https://maven.aliyun.com/repository/central/) first, then Maven Central (https://repo.maven.apache.org/maven2/). Files are cached in lib/ relative to the process working directory. Every file is checked against a pinned SHA-256 before use; valid caches work offline and are not downloaded again.

To override the download source, set SAKURAUPDATER_MAVEN_REPO to an HTTP(S) Maven repository root before starting Java. For example, in PowerShell:

$env:SAKURAUPDATER_MAVEN_REPO = "https://maven.aliyun.com/repository/central/"
java -jar sakuraupdater-[version].jar

A nonblank value replaces both default sources; if it fails, no public-source fallback is attempted. Unset or blank values retain the default Aliyun → Maven Central order. A trailing slash is optional. The URL must not include credentials, query parameters, or a fragment. This applies to standalone and NeoForge processes; restart the process after changing the variable. SHA-256 checks still apply to custom sources.

Without internet, complete valid caches allow normal startup with no network requests. Missing or corrupt required files trigger a download attempt; if every configured source fails, startup stops at that dependency. Each source is attempted once, with a 10-second connection timeout and a 60-second read timeout (these are not an overall startup deadline). Standalone startup exits with code 1; a NeoForge server reports a mod initialization error and cannot finish startup. Existing database files are not deleted. Ordinary clients do not require these downloads. An accessible LAN Maven repository can also supply missing files without public internet access.

For offline setup, copy the required versioned JAR files into lib/ from a previously successful installation. Keep the exact filenames (for example, sqlite-jdbc-3.46.0.0.jar); standalone mode needs all six files. Existing valid lib/ files from older releases can be reused. Lock files may remain and should not be removed while the application is running.

If acquisition fails, the log names the library, attempted URLs, and causes. Check network access and write permissions for lib/, or prepopulate verified files, then restart. Corrupt files are replaced only after a complete, verified download. A missing dependency or database initialization failure stops server startup. JARs are loaded directly; SQLite extracts its platform native library automatically, so its JVM temporary directory must be writable.

Configuration

Server configuration (sakuraupdater-server.toml)

# File server port
port = 25564

# Sync directory configuration, format: ["target_dir:mode:source_dir:extra_source_dir:..."]
# Mode explanations:
# - mirror: mirror mode, fully synchronize source directory to the target directory
# - push: push mode, push server files to clients
# - pull: pull mode, pull files from clients to the server
# - ignore: ignore mode, ignore files matching the regex. Since the path is included, ".*filename$" is recommended.
SYNC_DIR = [
    "mods:mirror",                           # synchronize the mods folder
    "config:push:clientconfig:config",       # push config and clientconfig to the client
    "resourcepacks:mirror",                  # synchronize resourcepacks folder
    "mods:ignore:.*abc\.jar$"                # ignore files in mods ending with 'abc.jar'
]

Client configuration (sakuraupdater-client.toml)

# Server host address
host = "localhost"

# Server port (should match the sakuraupdater-server.toml configuration, especially if using frp or other proxies)
port = 25564

# Current client version (managed automatically; do not edit manually)
now_version = ""

Usage

1. Server administrator operations