Skip to content

Commands

github-actions[bot] edited this page Nov 11, 2024 · 29 revisions

ZenithProxy Commands Documentation

Command Prefixes

Discord

. (e.g. .help)

In-game

/ OR ! (e.g. /help)

Terminal

N/A (e.g. help)

Core Commands

connect

Connects ZenithProxy to the destination MC server

Aliases: c

Usage

connect

disconnect

Disconnects ZenithProxy from the destination MC server

Aliases: dc

Usage

disconnect

help

ZenithProxy command list

Aliases: h

Usage

help

help <category>

help <command>

spectator

Configures the Spectator feature.

The spectator whitelist only allows players to join as spectators.

Players who are regular whitelisted (i.e. with the whitelist command) can always join as spectators regardless.

Spectator entities control what entity is used to represent spectators in-game.

Full commands allow spectators access to all standard ZenithProxy commands like connect, disconnect, etc.

If this is disabled, spectators only have access to a limited set of core commands.

Usage

spectator on/off

spectator whitelist add/del <player>

spectator whitelist list

spectator whitelist clear

spectator entity list

spectator entity <entity>

spectator chat on/off

spectator fullCommands on/off

spectator fullCommands requireRegularWhitelist on/off

status

Prints the current status of ZenithProxy, the in-game player, and modules.

Aliases: s

Usage

status

status modules

update

Restarts and updates the proxy software

Aliases: restart / shutdown / reboot

Usage

update

whitelist

Manages the list of players allowed to login.

Whitelisted players are allowed to both control the account in-game and spectate.

Aliases: wl

Usage

whitelist add/del <player>

whitelist list

whitelist clear

whitelist autoAddClient on/off

Manage Commands

auth

Configures the proxy's authentication settings.

To switch accounts, use the clear command.

attempts configures the number of login attempts before wiping the cache.

alwaysRefreshOnLogin will always refresh the token on login instead of trusting the cache. This can cause

Microsoft to rate limit your account. Auth tokens will always refresh in the background even if this is off.

deviceCode is the default and recommended authentication type.

If authentication fails, try logging into the account on the vanilla MC launcher and joining a server. Then try again in Zenith.

If this still fails, try one of the alternate auth types.

Usage

auth clear

auth attempts <int>

auth alwaysRefreshOnLogin on/off

auth type <deviceCode/emailAndPassword/deviceCode2/prism>

auth email <email>

auth password <password>

auth mention on/off

auth openBrowser on/off

auth maxRefreshIntervalMins <minutes>

auth useClientConnectionProxy on/off

auth chatSigning on/off

autoUpdate

Configures the AutoUpdater.

Updates are not immediately applied while the client is connected.

When an update is found, it will be applied 30 seconds after the next disconnect, or immediately if already disconnected.

Usage

autoUpdate on/off

chatRelay

Configures the Discord ChatRelay feature.

The ChatRelay is a live feed of chat messages and/or connection messages from the server to a Discord channel.

Mentions can be configured when a whisper is received or your name is seen in chat.

Messages typed in the ChatRelay discord channel will be sent as chat messages in-game

Discord message replies will be sent as whispers in-game

Usage

chatRelay on/off

chatRelay channel <channelId>

chatRelay connectionMessages on/off

chatRelay whispers on/off

chatRelay publicChat on/off

chatRelay deathMessages on/off

chatRelay serverMessages on/off

chatRelay whisperMentions on/off

chatRelay nameMentions on/off

chatRelay mentionsWhileConnected on/off

chatRelay ignoreQueue on/off

chatRelay sendMessages on/off

clientConnection

Manages the connection configuration from ZenithProxy to the destination MC server.

Usage

clientConnection autoConnect on/off

clientConnection proxy on/off

clientConnection proxy type <type>

clientConnection proxy host <host>

clientConnection proxy port <port>

clientConnection proxy user <user>

clientConnection proxy password <password>

clientConnection proxy auth clear

clientConnection bindAddress <address>

clientConnection timeout on/off

clientConnection timeout <seconds>

clientConnection ping mode <tablist/packet>

clientConnection ping packetInterval <seconds>

commandConfig

Configures ZenithProxy command prefixes and settings.

Usage

commandConfig discord prefix <string>

commandConfig ingame on/off

commandConfig ingame slashCommands on/off

commandConfig ingame slashCommands replaceServerCommands on/off

commandConfig ingame prefix <string>

database

Configures the database module used for https://api.2b2t.vc

This is disabled by default. No ZenithProxy users contribute or collect data, this is purely for use with my own accounts.

Aliases: db

Usage

database on/off

database queueWait on/off

database queueLength on/off

database publicChat on/off

database joinLeave on/off

database deathMessages on/off

database restarts on/off

database playerCount on/off

database tablist on/off

database playtime on/off

debug

Debug settings for features in testing or for use in development.

Usage

debug sync inventory

debug sync chunks

debug clearEffects

debug packetLog on/off

debug packetLog client on/off

debug packetLog server on/off

debug packetLog filter <string>

debug binaryNbtComponentSerializer on/off

debug kickDisconnect on/off

debug dc

debug teleportResync on/off

debug ncpStrictInventory on/off

debug debugLogs on/off

debug chunkCacheFullbright on/off

discord

Manages the Discord bot's configuration.

The relay is configured using the chatRelay command

Usage

discord on/off

discord channel <channel ID>

discord token <token>

discord role <role ID>

discord relayChannel <channelId>

discord manageProfileImage on/off

discord manageNickname on/off

discord manageDescription on/off

discord showNonWhitelistIP on/off

displayCoords

Configures whether the discord bot's messages should display coordinates. Only usable by account owner(s).

Aliases: coords

Usage

displayCoords on/off

friend

Manage the friend list.

Friends change behavior for various modules like VisualRange, KillAura, and AutoDisconnect

Usage

friend add/del <player>

friend list

friend clear

kick

Kicks all players or a specific player. Only usable by account owners.

Usage

kick

kick <player>

reconnect

Disconnect and reconnects from the destination MC server.

Can be used to perform a reconnect "queue skip" on 2b2t

Usage

reconnect

channel

Configures the current AutoUpdater release channel.

The release channel is a combination of a platform (java or linux) and a Minecraft protocol version.

.

Aliases: release / releaseChannel

Usage

channel list

channel set <platform> <minecraft version>

server

Change the MC server ZenithProxy connects to.

Usage

server <IP>

server <IP> <port>

serverConnection

Configures the MC server hosted by Zenith and players' connections to it

The proxyIP is the IP players should connect to. This is purely informational.

The bind argument changes the port ZenithProxy listens on..

The ping arguments configure the server list ping response ZenithProxy sends to players.

onlinePlayers = MC profiles of players

onlinePlayerCount = number of players connected

maxPlayers = number of players that can connect

lanBroadcast = LAN server broadcast

log = logs pings

The timeout arguments configures how long until players are kicked due no packets being received.

Usage

serverConnection proxyIP <ip>

serverConnection port <port>

serverConnection ping on/off

serverConnection ping onlinePlayers on/off

serverConnection ping onlinePlayerCount on/off

serverConnection ping maxPlayers <int>

serverConnection ping lanBroadcast on/off

serverConnection ping log on/off

serverConnection enforceMatchingConnectingAddress on/off

serverConnection timeout on/off

serverConnection timeout <seconds>

serverConnection autoConnectOnLogin on/off

spectatorEntity

Changes the current spectator entity. Only usable by spectators

Aliases: e

Usage

spectatorEntity

spectatorEntity <entity>

entityToggle

Toggles the visibility of spectator entities. Only usable by spectators.

Aliases: etoggle

Usage

entityToggle

playerCam

Toggles spectators between player and entity cameras. Only usable by spectators

Usage

playerCam

theme

Changes the color theme of alerts and messages.

Use theme list to see available colors.

Where Colors Are Used:

  • Primary: Most embeds and command responses if not an error.

  • Success: General "this worked" responses, server join, and friends

  • Error: Error responses, server leave, and enemies

  • In Queue: The proxy is in queue, reconnecting, or is in a transitional state

Aliases: color

Usage

theme list

theme primary <color>

theme success <color>

theme error <color>

theme inQueue <color>

transfer

Transfers connected players to a destination MC server

Usage

transfer

unsupported

Unsupported settings that cause critical security issues.

Do not use edit these unless you absolutely understand what you are doing.

No user support will be provided if you modify any of these settings.

All subcommands are only usable from the terminal.

Usage

unsupported whitelist on/off

unsupported verifyUsers on/off

unsupported auth type offline

unsupported auth offlineUsername <username>

Info Commands

connectionTest

Tests whether this proxy or another MC server is accessible from the public internet.

If the test succeeds, that means other people can connect.

If the test fails, either the proxyIP setting is not set to a public IP address or your instance is not

exposed on the public internet.

To configure the proxyIP use the help serverConnection command

On a VPS this is usually due to a firewall needing to be disabled.

On a home PC you would need both disable any firewall and configure port forwarding in your router.

Usage

connectionTest

connectionTest <address>

connectionTest testOnStart on/off

discordNotifications

Configures various discord notifications regarding player and proxy connections, deaths, and more.

Aliases: alerts / notifications

Usage

discordNotifications role set <roleId>

discordNotifications role reset

discordNotifications connect mention on/off

discordNotifications online mention on/off

discordNotifications disconnect mention on/off

discordNotifications startQueue mention on/off

discordNotifications death mention on/off

discordNotifications serverRestart mention on/off

discordNotifications loginFailed mention on/off

discordNotifications clientConnect mention on/off

discordNotifications clientDisconnect mention on/off

discordNotifications spectatorConnect mention on/off

discordNotifications spectatorDisconnect mention on/off

discordNotifications nonWhitelistedConnect mention on/off

inventory

Show and interact with the player's inventory

Aliases: inv

Usage

inventory

inventory show

inventory hold <slot>

inventory swap <from> <to>

inventory drop <slot>

inventory drop stack <slot>

map

Generate and render map images.

Map ID's to render must be cached during the current session

Generated maps can optionally be aligned to the vanilla map grid, or generated with a custom view distance.

Generated maps cannot be larger than what chunks are currently cached in the proxy

Usage

map render <mapId>

map render all

map generate

map generate align

map generate <viewDistance>

playtime

Gets the playtime of a player on 2b2t using https://api.2b2t.vc/

Aliases: pt

Usage

playtime <playerName>

prio

Configure alerts for 2b2t priority queue status and bans

Usage

prio mentions on/off

prio banMentions on/off

prio banCheck

prio banCheck <playerName>

queueStatus

Gets the current 2b2t queue length and wait ETA

Aliases: queue / q

Usage

queueStatus

queueWarning

Configure alerts sent when 2b2t queue positions are reached

Usage

queueWarning on/off

queueWarning position <integer>

queueWarning mention on/off

raycast

Debug testing command. Gets the block or entity the player is currently looking at.

Usage

raycast

seen

Gets the first and last times a player was seen on 2b2t using https://api.2b2t.vc

Aliases: firstseen / lastseen

Usage

seen <playerName>

stats

Gets the 2b2t stats of a player using https://api.2b2t.vc

Usage

stats <playerName>

tablist

Prints the current MC server's player list

Aliases: tab

Usage

tablist

tablist header

Module Commands

actionLimiter

Limits player actions and movements.

Players who login with the same account as the one used by ZenithProxy will be immune to these restrictions.

If the movement limits are reached by a player, they will be disconnected while the proxy account will stay logged in.

Other limits do not disconnect players and instead cancel the actions.

Aliases: al

Usage

actionLimiter on/off

actionLimiter allowMovement on/off

actionLimiter movementDistance <distance>

actionLimiter movementHome <x> <z>

actionLimiter movementMinY <y>

actionLimiter allowInventory on/off

actionLimiter allowBlockBreaking on/off

actionLimiter allowInteract on/off

actionLimiter allowEnderChest on/off

actionLimiter allowUseItem on/off

actionLimiter allowBookSigning on/off

actionLimiter allowChat on/off

activeHours

Set active hours for the proxy to automatically be logged in at.

By default, 2b2t's queue wait ETA is used to determine when to log in.

The connect will occur when the current time plus the ETA is equal to a time set.

If Queue ETA calc is disabled, connects will occur exactly at the set times instead.

Time zone Ids ("TZ Identifier" column): https://w.wiki/A2fd

Time format: XX:XX, e.g.: 1:42, 14:42, 14:01

Aliases: schedule

Usage

activeHours on/off

activeHours timezone <timezone ID>

activeHours add/del <time>

activeHours status

activeHours forceReconnect on/off

activeHours queueEtaCalc on/off

antiAFK

Configures the AntiAFK module.

To avoid being kicked on 2b2t the only required action is swing OR walk.

The walk action will move the player roughly in a square shape. To avoid falling down any ledges, enable safeWalk

For delay settings, 1 tick = 50ms

Aliases: afk

Usage

antiAFK on/off

antiAFK rotate on/off

antiAFK rotate delay <ticks>

antiAFK swing on/off

antiAFK swing delay <ticks>

antiAFK walk on/off

antiAFK walk delay <ticks>

antiAFK safeWalk on/off

antiAFK walkDistance <ticks>

antiAFK jump on/off

antiAFK jump onlyInWater on/off

antiAFK jump delay <int>

antiAFK sneak on/off

antiKick

AntiKick kicks players controlling the proxy client if they are inactive for a set amount of time.

Inactivity is defined as not moving, fishing, or swinging - which are what prevents 2b2t from kicking players.

Usage

antiKick on/off

antiKick playerInactivityKickMins <minutes>

antiKick minWalkDistance <blocks>

antiLeak

Configures the AntiLeak module. Cancels chat packets that could leak your coordinates.

i.e. due to inputting incorrect baritone commands, sharing waypoints, etc.

rangeCheck -> only cancels if the numbers in the chat message are within a range of your current coordinates.

rangeFactor -> How near the coordinates in your chat have to be to actual coords to be cancelled.

Equation: actualCoord / rangeFactor < chatCoord < actualCoord * rangeFactor

Example: If your coordinates are [500, 800], rangeFactor=10 will cancel if the chat contains a number between 50-5000 or 80-8000.

Usage

antiLeak on/off

antiLeak rangeCheck on/off

antiLeak rangeFactor <number>

autoArmor

Automatically equips the best armor in your inventory.

Usage

autoArmor on/off

autoDisconnect

Configures the AutoDisconnect module.

Every mode and setting requires the module to be enabled to be active.

Modes:

  • Health: Disconnects when health is below a set threshold level

  • Thunder: Disconnects during thunderstorms (i.e. avoid lightning burning down bases)

  • Unknown Player: Disconnects when a player not on the friends list, whitelist, or spectator whitelist is in visual range

Multiple modes can be enabled, they are non-exclusive

Settings non-exclusive to modes:

  • WhilePlayerConnected: If AutoDisconnect should disconnect while a player is controlling the proxy account

  • AutoClientDisconnect: Disconnects when the controlling player disconnects

  • CancelAutoReconnect: Cancels AutoReconnect when AutoDisconnect is triggered. If the proxy account has prio this is ignored and AutoReconnect is always cancelled

Aliases: autoLog

Usage

autoDisconnect on/off

autoDisconnect health on/off

autoDisconnect health <integer>

autoDisconnect thunder on/off

autoDisconnect unknownPlayer on/off

autoDisconnect whilePlayerConnected on/off

autoDisconnect autoClientDisconnect on/off

autoDisconnect cancelAutoReconnect on/off

autoEat

Configures the AutoEat module

Usage

autoEat on/off

autoEat health <int>

autoEat hunger <int>

autoEat warning on/off

autoFish

Configures the AutoFish module.

AutoFishing will prevent you from being AFK kicked. It's recommended to disable AntiAFK.

Usage

autoFish on/off

autoFish castDelay <ticks>

autoFish rotation <yaw> <pitch>

autoFish rotation sync

autoMend

Equips items that are both damaged and have the mending enchantment to the offhand.

Can be enabled while at an XP farm to repair items in your inventory.

Usage

autoMend on/off

autoReconnect

Configures the AutoReconnect module

Usage

autoReconnect on/off

autoReconnect delay <seconds>

autoReconnect maxAttempts <number>

autoReply

Configures the AutoReply module.

Automatically replies to whispers with a custom message.

Usage

autoReply on/off

autoReply cooldown <seconds>

autoReply message <message>

autoRespawn

Automatically respawns the player after dying.

Usage

autoRespawn on/off

autoRespawn delay <milliseconds>

autoTotem

Automatically equips totems in the offhand

Usage

autoTotem on/off

autoTotem inGame on/off

autoTotem health <int>

autoTotem popAlert on/off

autoTotem popAlert mention on/off

autoTotem noTotemsAlert on/off

autoTotem noTotemsAlert mention on/off

chatHistory

Caches and sends recent chat history to players and spectators who connect to the proxy.

Includes whispers, chat, and system messages.

Usage

chatHistory on/off

chatHistory seconds <seconds>

chatHistory maxCount <maxCount>

chatHistory spectators on/off

esp

Manages the entity ESP module

Usage

esp on/off

extraChat

Configures the ExtraChat module.

Allows hiding types of messages in-game or in the terminal chat log.

Usage

extraChat on/off

extraChat hideChat on/off

extraChat hideWhispers on/off

extraChat hideDeathMessages on/off

extraChat showConnectionMessages on/off

extraChat logChatMessages on/off

ignore

Hides chat and death messages and notifications for a configured list of players.

Usage

ignore add/del <player>

ignore list

ignore clear

killAura

Attacks entities near the player.

Custom targets list: https://link.2b2t.vc/1

Aliases: ka

Usage

killAura on/off

killAura attackDelay <ticks>

killAura targetPlayers on/off

killAura targetHostileMobs on/off

killAura targetHostileMobs onlyAggressive on/off

killAura targetNeutralMobs on/off

killAura targetNeutralMobs onlyAggressive on/off

killAura targetArmorStands on/off

killAura targetCustom on/off

killAura targetCustom add/del <entityType>

killAura weaponSwitch on/off

killAura range <number>

replay

Captures a ReplayMod recording.

Replays can optionally be uploaded to discord if they are under the discord message size limit.

A maxRecordingTime of 0 means there is no limit, however, recording are always stopped on disconnects.

autoStart will automatically start a new recording when the proxy connects.

Additional recording modes can be configured in the visualRange command.

Usage

replay start

replay stop

replay discordUpload on/off

replay maxRecordingTime <minutes>

replay autoRecord mode <off/proxyConnected/playerConnected/health>

replay autoRecord health <integer>

respawn

Performs a respawn

Usage

respawn

sendMessage

Sends a message in-game.

Aliases: say / msg / m

Usage

sendMessage

switch

Switch the connected player to an alternate MC server.

Can be used to switch between multiple ZenithProxy instances quickly.

Servers being switched to must have transfers enabled and be on an MC version >=1.20.6

Usage

switch register <name> <address> <port>

switch list

switch <name>

skin

Temporarily change your skin to another player's skin.

This is only client-side and only affects how you see yourself.

Usage

skin

spammer

Spams messages or whispers in-game. Use with caution, this can and will get you muted.

Aliases: spam

Usage

spammer on/off

spammer whisper on/off

spammer delayTicks <int>

spammer randomOrder on/off

spammer appendRandom on/off

spammer list

spammer clear

spammer add <message>

spammer addAt <index> <message>

spammer del <index>

swap

Swaps the current controlling player to spectator mode.

Usage

swap

spook

Rotates and stares at players in visual range.

Can often confuse other players in-game into thinking you are a real player.

Usage

spook on/off

spook mode <visualRange/nearest>

stalk

Sends alerts when players join or leave

Usage

stalk on/off

stalk list

stalk add/del <player>

via

Configure the integrated ViaVersion module.

zenithToServer -> ZenithProxy connecting to the MC server

playerToZenith -> players connecting to ZenithProxy

Usage

via zenithToServer on/off

via zenithToServer disableOn2b2t on/off

via zenithToServer autoConfig on/off

via zenithToServer version <MC version>

via playerToZenith on/off

visualRange

Configure the VisualRange notification feature.

Alerts are sent both in the terminal and in discord, with optional discord mentions.

replayRecording settings will start recording when players enter your visual range and stop

when players leave, after the set cooldown.

enemy mode will only record players who are not on your friends list.

all mode will record all players, regardless of being on the friends list.

To add players to the friends list see the friends command.

Aliases: vr

Usage

visualRange on/off

visualRange list

visualRange enter on/off

visualRange enter mention on/off

visualRange enter whisper on/off

visualRange enter whisper message <message>

visualRange enter whisper cooldown <seconds>

visualRange leave on/off

visualRange logout on/off

visualRange ignoreFriends on/off

visualRange replayRecording on/off

visualRange replayRecording mode <enemy/all>

visualRange replayRecording cooldown <minutes>