Getting Started & Basics

MacroAI is a cross-platform macro automation tool that supports both Windows and Android. It lets you build automation scripts that "click automatically, recognize images, and read on-screen text" — no programming experience required.

Typical use cases:

• Game assistance — auto-farming, auto-healing, auto daily quests
• Office automation — batch form filling, automating ERP/CRM operations
• Software testing — simulating user actions, regression testing
• Operations — scheduled inspections, automatic handling after monitoring alerts

Core capabilities: image recognition and positioning, OCR text recognition, color detection, screen change monitoring, mouse & keyboard simulation, and Lua script extension.

MacroAI organizes everything around projects. Before using any feature, you must create a project first:

1. Click the menu Project → New Project (or press Ctrl+N)
2. On first launch, you'll be guided to choose a workspace directory (where project files are stored) — just pick a folder you'll remember
3. Enter a project name (e.g. "Match Game Helper")
4. Set the design region (see the next question)
5. Click OK, and your project is created

Once created, you can add nodes in the node editor, record macros, and manage images.

The design region defines "the area your script works in". It tells MacroAI which area of the screen — the target window or view — you were looking at while building the script.

Why is it needed? Because the same script may run on computers with different resolutions. With the design region as a reference baseline, MacroAI can automatically convert coordinates so your script runs correctly on other machines too.

Two options:

• Full screen — the simplest choice if you're automating a full-screen game or the entire desktop
• Custom selection — if you only operate within a specific window (e.g. a browser or game window), drag to select that window

Tip for beginners: if you're unsure, choose "Full screen" — you can change it later in the project settings.

MacroAI has two working modes, each aimed at a different role:

• 🔧 Design mode — for the person who builds the script. Includes all 9 tabs: node editor, variable management, image management, and more. Used for creating and editing scripts.
• 🏃 Run mode — for the person who uses the script. Shows only project info, region calibration, personal configuration, and the run button. A clean interface focused on running.

How to choose?

• You're building the script yourself → design mode
• Someone sent you a script file and you just want to run it → run mode (importing a distribution package switches to it automatically)

You can switch at any time via the dropdown menu on the left side of the toolbar.

A node is a single action step in your script. For example, "mouse click (500,300)" is a node, "wait 2 seconds" is a node, and "find image" is also a node.

The node editor lets you line up these steps from top to bottom, like stacking building blocks. MacroAI executes them in order.

Basic operations:

• Add a node: click a node type in the left panel (e.g. "Find Image", "Mouse Click", "Wait")
• Configure a node: double-click the node to open its configuration dialog and set the parameters
• Reorder: simply drag nodes up or down
• Compose logic: drag nodes into a "Loop" or "Condition" container to implement repetition or branching

The node editor automatically generates the corresponding script code — you never need to write any code by hand.

The two are complementary:

• Macro recording — you perform the actions once, and MacroAI records every mouse and keyboard action, replaying them exactly. Best for simple operations with "fixed steps and no decision-making".
• Node editor — you build the flow manually and can add intelligent logic such as image recognition, conditions, and loops. Best for complex scenarios where you "need to make decisions based on screen content".

Recommended workflow:

1. First, quickly record a sequence of actions
2. Add a "Call Recorded Macro" node in the node editor
3. Add image search, condition, and other nodes around it to make the flow smarter

In short: recording handles "what to do", while the node editor handles "when to do it, how many times, and under what conditions".

In one sentence: a project is a container that holds nodes (the main flow), functions (reusable sub-flows), and macros (recorded action sequences).

• Project — a complete automation task. Contains all nodes, images, variables, functions, macros, and so on. Corresponds to one entry in the project list on the left.
• Node — a single step in the main flow. Managed in the "Node Editor" tab.
• Function — a group of nodes packaged into a reusable module that can be called multiple times from the main flow. Managed in the "Functions" tab.
• Macro — a recorded sequence of mouse and keyboard actions. It can be embedded in the main flow via a "Call Recorded Macro" node. Managed in the "Macro Manager" tab.

Execution order: when you run a project, it executes from top to bottom in the node editor's order. When it hits a "Call Function" node, it jumps to execute the function's content; when it hits a "Call Recorded Macro" node, it plays back the recorded actions.