Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/ZTzTopia/GTProxy/llms.txt

Use this file to discover all available pages before exploring further.

​
Introduction

GTProxy includes a powerful command system that allows you to interact with the proxy at runtime. Commands are executed in-game through the chat interface and provide various debugging, modification, and utility features.

​
How Commands Work

Commands are prefixed with / (the default prefix) and executed by sending them in the Growtopia chat. The proxy intercepts these messages, executes the command, and sends responses back to you.

​
Command Structure

/command [arguments]
  • Command name: The identifier for the command (e.g., help, warp, debug)
  • Arguments: Optional parameters that modify the command’s behavior

​
Example Usage

/help
/warp START
/debug player 1
/nick CustomName

​
Built-in Commands

GTProxy comes with several built-in commands:

/help

List all available commands or show command usage

/debug

Show debug information about players, world, tiles, or objects

/proxy

Test command to verify proxy functionality

/warp

Warp to a different world

/nick

Change your display name

/skin

Change your skin code

/exit

Exit the current world

​
Command Results

Commands return one of three result types:
  • Success: Command executed successfully
  • InvalidArguments: Command received incorrect or missing arguments
  • Failed: Command execution failed for some reason
When a command fails, you’ll receive an error message explaining what went wrong.

​
Custom Commands via Lua

You can register custom commands using Lua scripts. See the Lua Scripting API for details on creating your own commands.

​
Example: Custom Command

command.register("hello", "Say hello", function(ctx)
    logger.info("Hello from custom command!")
    return true
end)

​
Command Prefix

The default command prefix is /. This can be customized programmatically through the CommandRegistry::set_prefix() method if you’re modifying the source code.

​
Next Steps

Try Commands

Start with the /help command to see all available commands

Lua Scripting

Learn how to create custom commands with Lua

Build docs developers (and LLMs) love

Get started for freeTalk to us