Skip to content

Commands

rfresh2 edited this page May 9, 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

Connect the current player to the server

Aliases: c

disconnect

Disconnect the current player from the server

Aliases: dc

help

ZenithProxy command list

Aliases: h

Usage

help

help <category>

help <command>

spectator

Configure the Spectator feature

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

status

Gets the current proxy status

Aliases: s

Usage

status

status modules

update

Restarts and updates the proxy software

Aliases: restart / shutdown / reboot

whitelist

Manage the proxy's whitelist. Only usable by users with the account owner role. autoAddClient will automatically add the account logged into by ZenithProxy to the whitelist

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/meteor/prism>

auth email <email>

auth password <password>

auth mention on/off

auth openBrowser on/off

auth maxRefreshIntervalMins <minutes>

auth useClientConnectionProxy on/off

autoUpdate

Configures the autoupdater.

Usage

autoUpdate on/off

chatRelay

Configures the ChatRelay feature

Usage

chatRelay on/off

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 sendMessages on/off

clientConnection

Manages the client's connection configuration

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 bindAddress <address>

clientConnection timeout on/off

clientConnection timeout <seconds>

clientConnection ping mode <tablist/packet>

clientConnection ping packetInterval <seconds>

commandConfig

Configures settings related to ZenithProxy commands

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 what 2b2t server data is collected by the proxy. No database logs personal data.

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

debug

Debug settings for developers

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 sendChunksBeforePlayerSpawn on/off

debug binaryNbtComponentSerializer on/off

debug kickDisconnect on/off

debug dc

debug teleportResync on/off

discord

Manages the discord bot configuration

Usage

discord on/off

discord channel <channel ID>

discord relayChannel <channel ID>

discord token <token>

discord role <role ID>

discord manageProfileImage on/off

discord manageNickname on/off

discord manageDescription on/off

discord showNonWhitelistIP on/off

displayCoords

Sets whether proxy status commands 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

Kick a user from the proxy. Only usable by account owners

Usage

kick <player>

reconnect

disconnect and reconnect the proxy client

channel

Changes the current release channel.

Aliases: release / releaseChannel

Usage

channel list

channel set <platform> <minecraft version>

server

Change the server the proxy 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 bind 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 timeout on/off

serverConnection timeout <seconds>

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

Info Commands

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 someone on 2b2t

Aliases: pt

Usage

playtime <playerName>

prio

Configure the mentions for 2b2t priority & priority ban updates

Usage

prio mentions on/off

prio banMentions on/off

prio check

clientConnectionMessages

Send notification messages when a client connects to the proxy

Usage

clientConnectionMessages on/off

queueStatus

Prints the current 2b2t queue status

Aliases: queue / q

queueWarning

Configure warning messages for when 2b2t queue positions are reached

Usage

queueWarning on/off

queueWarning position <integer>

queueWarning mention on/off

raycast

Raycast to the block in front of you

seen

Gets the first and last times a player was seen on 2b2t

Aliases: firstseen / lastseen

Usage

seen <playerName>

stats

Gets the 2b2t stats of a player

Usage

stats <playerName>

tablist

Displays the current server's tablist

Aliases: tab

Module Commands

actionLimiter

Limits player 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/8Yif" Time format: XX:XX, e.g.: 1:42, 14:42, 14:01

Usage

activeHours on/off

activeHours timezone <timezone ID>

activeHours add/del <time>

activeHours status

activeHours forceReconnect on/off

activeHours queueEtaCalc on/off

antiAFK

Configure the AntiAFK feature

Aliases: afk

Usage

antiAFK on/off

antiAFK rotate on/off

antiAFK rotate delay <int>

antiAFK swing on/off

antiAFK swing delay <int>

antiAFK walk on/off

antiAFK walk delay <int>

antiAFK safeWalk on/off

antiAFK walkDistance <int>

antiAFK jump on/off

antiAFK jump onlyInWater on/off

antiAFK jump delay <int>

antiAFK sneak on/off

antiKick

AntiKick automatically 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. Modes:

  • Health: Disconnects when health is below a set threshold
  • 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

Global Settings:

  • 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 <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 feature

Usage

autoEat on/off

autoEat health <int>

autoEat hunger <int>

autoEat warning on/off

autoFish

Configures the AutoFish module

Usage

autoFish on/off

autoFish castDelay <ticks>

autoFish rotation <yaw> <pitch>

autoFish rotation sync

autoReconnect

Configure the AutoReconnect feature

Usage

autoReconnect on/off

autoReconnect delay <seconds>

autoReconnect maxAttempts <number>

autoReply

Configure the AutoReply feature

Usage

autoReply on/off

autoReply cooldown <seconds>

autoReply message <message>

autoRespawn

Automatically respawn the player after dying.

Usage

autoRespawn on/off

autoRespawn delay <milliseconds>

autoTotem

Automatically equips totems in the offhand

Usage

autoTotem 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

Extra chat commands

Usage

extraChat hideChat on/off

extraChat hideWhispers on/off

extraChat hideDeathMessages on/off

extraChat showConnectionMessages on/off

extraChat logChatMessages on/off

ignore

Ignores a player

Usage

ignore add/del <player>

ignore list

ignore clear

killAura

Attacks entities near the player.

Custom targets list: http://gg.gg/19i5rc

Aliases: ka

Usage

killAura on/off

killAura attackDelay <ticks>

killAura targetPlayers on/off

killAura targetHostileMobs 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 autoRecordMode <off/proxyConnected/playerConnected>

respawn

Performs a player respawn

sendMessage

Sends a message in-game.

Aliases: say / msg / m

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>

spammer

Spams messages

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.

spook

Automatically spooks nearby players

Usage

spook on/off

spook delay <ticks>

spook mode <visualRange/nearest>

stalk

Configures the stalk module which sends discord mentions when a player connects

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 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 enter on/off

visualRange enter mention on/off

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>

Clone this wiki locally