Introduction

Growlauncher exposes a Lua API that allows you to:

• Interact with the Growtopia client.
• Automate actions like sending packets, moving, and reading game state.
• Create custom modules and user interfaces.

Overview

The API includes:

• Built-in functions - Core functionality for game interaction
• Custom modules - Extensible module system for custom features
• Struct data types - Data structures for game objects and information
• Namespaces - Organized API access for different functionality areas
• ImGui integration - Custom UI creation and management
• Hooks & callbacks - Event-driven programming capabilities

Key Features

Game Interaction

• Send and receive network packets
• Manipulate tiles and world objects
• Control player actions and movement
• Access inventory and item information

User Interface

• Create custom ImGui interfaces
• Build module UI components
• Design interactive overlays
• Manage user preferences and settings

Automation

• Hook into game events
• Create automated scripts
• Schedule tasks and coroutines
• Monitor game state changes

Getting Started

1. Read the Getting Started Guide for basic setup
2. Explore Functions for core API calls
3. Check Namespaces for organized functionality
4. Learn about Structs for data structures
5. Discover ImGui for UI creation
6. Understand Hooks for event handling
7. Reference Enums for constants

Example Usage

-- Basic script structure
function onDrawImGui(deltaTime)
    if ImGui.Begin("My Script", true) then
        ImGui.Text("Hello from Growlauncher!")
        
        if ImGui.Button("Send Chat") then
            growtopia.sendChat("Hello World!")
        end
        
        ImGui.End()
    end
end

addHook(onDrawImGui, "onDraw")
applyHook()

Next Steps

• Visit the Getting Started guide for detailed setup instructions
• Browse the Functions documentation for available API calls
• Check out the Examples for practical examples