跳到正文

relauncher

作者:juanmuscaria

JVM relaunch library for Java based applications.

收藏

介绍

中文介绍正在准备中,下面暂时显示原文。

Relauncher

JVM relaunch library for Java based applications. Drop a single JAR into your mods folder,
and it should work from Minecraft 1.6.4 to the latest version, or on Hytale Server as an early plugin or regular plugin.

What it does

Relauncher restarts the JVM process with additional arguments transparently and before the game loads.
This is useful for:

  • Adding JVM flags – GC tuning, -XX:+AlwaysPreTouch, system properties, etc., without needing to touch launcher settings
  • Modpack tooling – other mods can trigger a relaunch programmatically after installing dependencies or configuring the environment (javaagents, module layers, you name it)

The relaunch happens very early during startup, before any significant game state is initialized.
External launchers see a single continuous process with no extra windows, no orphaned processes.

Supported Versions

| Loader | Minecraft Versions | Entry Point |
|—————————|——————–|———————————————|
| Forge (LaunchWrapper) | 1.6.4 – 1.12.2 | ITweaker via manifest |
| Forge (ModLauncher) | 1.13.2+ | ITransformationService via SPI |
| NeoForge (ModLauncher) | up to 1.21.1 | ITransformationService via SPI |
| NeoForge (FancyModLoader) | 1.21.3+ | IModFileCandidateLocator via SPI |
| Fabric | 1.14+ | PreLaunchEntrypoint via fabric.mod.json |
| Quilt | 1.14+ | Uses Fabric’s PreLaunchEntrypoint |
| Hytale Server (early) | – | ClassTransformer SPI |
| Hytale Server (plugin) | – | JavaPlugin via manifest.json |

Java versions: 8 through 25

Platforms: Linux, Windows, and macOS, on both x86_64 and aarch64.

Installation

  1. Download the universal JAR (relauncher-universal-<version>.jar)
  2. Drop it into your mods/ folder
  3. Launch the game once, it will create a config file at config/relauncher/config.cfg
  4. Edit the config to add your JVM arguments and set enabled = true
  5. Relaunch the game

Configuration

The config file is at <game directory>/config/relauncher/config.cfg:

# Relauncher Configuration
# Extra JVM arguments to add when relaunching, one per line.
# Lines starting with # are comments, blank lines are ignored.

# Set to false to disable relaunching without removing your arguments.
enabled = true

# Add extra JVM arguments below, one per line:
-XX:+UseG1GC
-XX:+AlwaysPreTouch
-Dsome.java.property=true

The config enabled flag only controls the config file’s own arguments.
If another mod provides a CommandLineProvider SPI implementation, the relaunch will happen regardless of this flag.

How it works

Relauncher tries three strategies to restart the JVM, in order of preference:

  1. POSIX exec (Linux / macOS) – calls execvp() through a native Rust library to replace the current process in-place. Same PID, zero overhead, cleanest possible restart.
  1. Windows DLL – hooks DllMain(DLL_PROCESS_DETACH) to spawn a child process after the JVM has fully shut down. stdin/stdout/stderr are duplicated beforehand so they survive the teardown. The parent waits for the child and forwards its exit code.
  1. Fallback (pure Java) – starts a child process with inherited I/O, waits for it to finish, then halts. Works everywhere, but the original process sticks around for the duration of the game session.

Launcher Compatibility

| Launcher | Status |
|—————|———————————————————————————————————————————————————————————————————|
| Vanilla | Fully supported |
| PrismLauncher | Fully supported (system properties workaround) |
| CurseForge | Fully supported (delegates to vanilla) |
| Modrinth | Fully supported (theseus wrapper workaround) |
| ATLauncher | Fully supported |
| MultiMC | Not supported – relies on a stdin protocol that can’t be replayed after relaunch. A warning is logged and the relaunch is skipped. Consider switching launchers or applying the arguments manually. |

For Mod Developers

API dependency

Add relauncher-core as a compile-only dependency – the universal JAR will be present at runtime:

dependencies {
    compileOnly 'com.juanmuscaria:relauncher-core:<version>'
}

Programmatic relaunch

If your mod needs to restart the JVM (e.g., after installing a javaagent), call Relauncher.relaunch() directly:

import com.juanmuscaria.relauncher.Relauncher;
import com.juanmuscaria.relauncher.RelaunchResult;

List<String> extraArgs = Arrays.asList("-Dfoo=bar", "-XX:+AlwaysPreTouch");
RelaunchResult result = Relauncher.relaunch(extraArgs);

// If we get here, the relaunch didn't happen
if (result.isFailed()) {
    logger.error("Relaunch failed: " + result.reason());
} else if (result.isSkipped()) {
    logger.warn("Relaunch skipped: " + result.reason());
}

SPI provider

You can also inject JVM arguments without calling the API directly, just implement CommandLineProvider and register it
via ServiceLoader.
Relauncher scans the mods folder for service files on its own, so your mod doesn’t even need to be on the classpath yet.

import com.juanmuscaria.relauncher.CommandLineProvider;

public class MyProvider implements CommandLineProvider {
    @Override
    public List<String> extraJvmArguments() {
        return Collections.singletonList("-Dmy.mod.installed=true");
    }

    @Override
    public int priority() {
        return 0; // lower = runs first
    }
}

Register it in META-INF/services/com.juanmuscaria.relauncher.CommandLineProvider:

com.example.mymod.MyProvider

Checking relaunch state

Relauncher.isRelaunched()  // true if we're inside a relaunched JVM
Relauncher.getDepth()      // 0 = original, 1 = first relaunch, etc.

Debugging

Add -Drelauncher.debug=true to your launcher’s JVM arguments. This logs the full command-line extraction,
argument assembly, and strategy selection process. Useful for figuring out why a relaunch isn’t working the way you
expect.

Building from source

./gradlew build                           # Full build
./build-natives.sh                        # Cross-compile native libraries

You’ll need Java 17+ (used as a toolchain; the output still targets Java 8) and Gradle 9.
For cross-compiling the native Rust libraries you’ll also
need cross, cargo-xwin,
and cargo-zigbuild, and Zig toolchain.

License

Mozilla Public License 2.0

常见问题

relauncher 支持哪些 Minecraft 版本?

relauncher 支持 Minecraft Java 版 1.6.4–26.1.2,共 83 个版本,可用的加载器:Fabric / Forge / NeoForge / Quilt。下载时注意选择和你游戏版本一致的文件。

relauncher 怎么安装?

先用 PCL2 或 HMCL 启动器安装对应版本的 Fabric / Forge / NeoForge / Quilt,再把下载的 .jar 文件放进游戏目录的 mods 文件夹,重新启动游戏即可。开启了版本隔离的,mods 文件夹在 versions/版本名 下面。运行环境:客户端 / 服务端。

评论

登录后评论和评分

juanmuscaria 的其他作品

查看全部 →