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.

​
Installation

GTProxy can be installed using pre-built binaries from GitHub releases or built from source. Choose the method that best suits your needs.

​
Download pre-built binary

The easiest way to get started is to download a pre-built executable from the releases page.
1

Visit the releases page

Navigate to the GTProxy releases page on GitHub.
2

Download the latest release

Download the appropriate binary for your platform:
  • Windows: GTProxy-windows-x64.exe
  • Linux: GTProxy-linux-x64
  • macOS: GTProxy-macos-arm64 or GTProxy-macos-x64
3

Make executable (Linux/macOS only)

On Linux or macOS, make the binary executable:
chmod +x GTProxy-linux-x64
4

Run GTProxy

Launch the proxy:Windows:
GTProxy-windows-x64.exe
Linux/macOS:
./GTProxy-linux-x64
On first run, GTProxy will create a default config.json file in the current directory.
GTProxy will create a config.json configuration file and log files in the directory where you run it. Make sure you have write permissions.

​
Build from source

Building from source gives you the latest features and allows you to customize the proxy.

​
Prerequisites

1

Install build tools

Install the required build dependencies:CMake 3.24+Download from cmake.org or install via package manager:
# Ubuntu/Debian
sudo apt install cmake

# macOS
brew install cmake

# Windows
winget install Kitware.CMake
C++23 Compiler
  • GCC 11+ or Clang 14+ (Linux/macOS)
  • Visual Studio 2022+ with C++23 support (Windows)
  • Xcode 14+ (macOS)
2

Install Python and Conan

GTProxy uses Conan 2.0+ for dependency management.Install Python 3.5+Download from python.org or use your system package manager.
On Windows, make sure to select “Add Python to PATH” during installation.
Install Conan package manager
pip install "conan>2.0"
Verify the installation:
conan --version
# Should output: Conan version 2.x.x

​
Build process

1

Clone the repository

Clone GTProxy with all submodules:
git clone --recurse-submodules https://github.com/ZTzTopia/GTProxy.git
cd GTProxy
The --recurse-submodules flag is important as GTProxy includes external libraries (ENet, cpp-httplib) as Git submodules.
2

Configure the build

Create a build directory and run CMake configuration:Debug build (for development):
mkdir build
cd build
cmake .. -DCMAKE_BUILD_TYPE=Debug
Release build (for production):
cmake -B build -DCMAKE_BUILD_TYPE=Release
During configuration, CMake will automatically install required dependencies via Conan:
  • eventpp (event dispatching)
  • fmt (string formatting)
  • glaze (JSON serialization)
  • spdlog (logging)
  • lua + sol2 (scripting engine)
  • LibreSSL (TLS/SSL support)
  • magic_enum (enum reflection)
  • gtest (testing framework)
3

Build the project

Compile GTProxy:
cmake --build build --config Release
For debug builds:
cmake --build build --config Debug
The build process will compile the main proxy executable and test suite.
4

Run the executable

After building, the executable will be located in the build directory:
# From project root
./build/src/GTProxy
On Windows:
.\build\src\Release\GTProxy.exe

​
Platform-specific notes

Visual Studio ConfigurationIf using Visual Studio, you can open the project directly:
cmake -B build -G "Visual Studio 17 2022"
Then open build/GTProxy.sln in Visual Studio.Exception HandlingMSVC builds use the /EHsc flag for proper C++ exception handling.

​
Verify installation

To verify GTProxy is installed correctly, run the executable. You should see output similar to: 
[2026-03-02 10:30:45.123] [12345] [info] Starting GTProxy (v3.0.0)
[2026-03-02 10:30:45.234] [12345] [warn] Configuration file "config.json" not found. Creating default configuration file...
[2026-03-02 10:30:45.345] [12345] [info] Default configuration file "config.json" created successfully.
[2026-03-02 10:30:45.456] [12345] [info] Proxy server listening on port 16999
The proxy is now ready to accept connections. Continue to the Quick start guide to connect your Growtopia client.

​
Troubleshooting

​
Configuration file errors

If GTProxy fails to create or load config.json:
  • Ensure you have write permissions in the current directory
  • Check that the directory path doesn’t contain special characters
  • Verify the existing config.json has valid JSON syntax

​
Build errors

Conan package installation fails If Conan fails to fetch dependencies: 
# Clear Conan cache and retry
conan remove "*" -c
cmake -B build -DCMAKE_BUILD_TYPE=Release
Submodule errors If you get errors about missing files in lib/: 
# Initialize submodules if not cloned with --recurse-submodules
git submodule update --init --recursive
C++23 support errors Ensure your compiler supports C++23:
  • GCC 11 or newer
  • Clang 14 or newer
  • MSVC 19.30 (Visual Studio 2022) or newer

Build docs developers (and LLMs) love

Get started for freeTalk to us