Skip to content

Installation

Shallowplague edited this page Jun 16, 2026 · 2 revisions

Installation & running

AquariusProxy runs on Java 21+. It's a headless proxy: it opens a local Minecraft server you connect through, and logs your account into the destination server (2b2t by default).

⚠️ Java only — supported platforms & specs. AquariusProxy is designed for and validated only on the Java release channel (the .jar, run on Java 21+) on Windows, Ubuntu/Linux, and macOS. The native GraalVM (linux) build and any other OS or runtime are not tested or validated — always use the Java jar / java channel. The JVM + ViaVersion need roughly 600 MB on top of the OS, so run it on a host with at least 1 GB of RAM (2 GB recommended). A 512 MB VPS is not enough.

Get the jar

A. Build it (recommended for this fork)

git clone https://github.com/aquariusnetwork9/AquariusProxy.git
cd AquariusProxy
./gradlew shadowJar          # Windows: gradlew.bat shadowJar
java -jar build/libs/AquariusProxy.jar

B. Download it — grab AquariusProxy.jar from the Releases page and java -jar AquariusProxy.jar.

On first start it generates config.json and launch_config.json in the working directory and opens a server on localhost:25565. Connect with a Minecraft 1.21.4 client (any version via ViaVersion), or drive it from the terminal / Discord. Use the connect command to log the bot into the destination server.

Control surfaces

All three share the same command set — only the prefix differs:

Surface How to send a command
Terminal type the command directly, no prefix (aquariusminer on)
Discord configured prefix, default . (.aqm on)
In-game chat configured prefix / or ! (/aqm on)

This wiki uses the . (Discord / in-game) prefix in examples.

Running under the ZenithProxy launcher

The official ZenithProxy launcher (auto-update, service management, native builds) expects a file named ZenithProxy.jar. To run AquariusProxy under it, deploy the built AquariusProxy.jar to the launcher directory renamed to ZenithProxy.jar — the file contents are what matter; the banner will still read AquariusProxy. Set auto_update: false in launch_config.json so the launcher keeps your custom jar (or point repo_owner/repo_name at aquariusnetwork9/AquariusProxy to pull AquariusProxy releases).

The launcher setup, hosting providers, Linux/VPS notes, and Docker instructions from upstream ZenithProxy all still apply — see the ZenithProxy wiki for those.

Running on a server (keep it alive)

Run it inside a terminal multiplexer so it survives your SSH session closing:

For multiple bots, give each its own folder with its own launcher files, config, port, and Discord bot.

First commands

connect                # log the account into the destination server
help                   # list every command
status                 # release channel, connection state, modules

See the Command Reference for the built-in modules.

Clone this wiki locally