MacroMod Documentation & API Guide

1. Macro Syntax Basics

MacroMod supports two execution formats: Inline Macros and Script Files.

Inline Macros

Inline macros are single-line instruction sets bound directly to a keyboard trigger or event inside the Configuration GUI. Chained actions are separated by a vertical bar (|).

# Simple inline look and walk combo (using name alias)
{LOOK 90 0} | {KEYDOWN forward} | {WAIT 100} | {KEYUP forward}

Script Files (.mcm)

Script files (ending in .mcm) are written sequentially line-by-line under the Scripts tab or in .minecraft/config/macromod/scripts/. Chaining vertical bars (|) are not used in script files.

# Walk forward and jump
{LOOK 90 0}
{KEYDOWN 87}
{WAIT 40}
{KEY 32}
{WAIT 40}
{KEYUP 87}

2. Built-in Special Actions

Special client actions are enclosed inside curly braces ({}). They simulate hardware inputs or instruct the macro execution flow:

3. Input Placeholders

You can pause macro execution to request input from the user before executing the command:

• $$?: Opens a generic text entry box.

  /pv $$?

• $$[Prompt Label]: Opens a text input box with a custom descriptive prompt label.

  /pv $$[Vault Number]  # Displays "Vault Number:" above the field

4. Script Control Flow & Advanced Logic

Write advanced logic statements within .mcm script library files PREMIUM FEATURE:

While Loops

while $health < 12
  execute "/heal"
  delay 40
endwhile

For Loops

for i 0 8
  execute "{SLOT $i}"
  delay 10
endfor

Conditionals & String Comparisons

if $dimension == "minecraft:the_nether"
  execute "{ECHO Caution: In Nether!}"
else
  execute "{ECHO Overworld location: $xpos, $zpos}"
endif

5. Read-Only Player & World Variables

Read-only player and world variables can be queried inside script conditions or printed using {ECHO}:

6. GLFW Keycodes & Game Action Aliases

Use keycode integers, key name strings, or game action aliases inside {KEY}, {KEYDOWN}, and {KEYUP} actions:

Mouse Buttons & Game Action Aliases

7. Container & Inventory Slot Index Map

Use these integer slot IDs with {SLOTCLICK slot [button] [type]}, {SHIFTCLICK slot}, and {ALLCLICK slot} actions:

Player Inventory Slot Map (46 Slots)

+-------------------------------------------------------------+
|                          CRAFTING                           |
|                    [ 1 ] [ 2 ]                              |
|                    [ 3 ] [ 4 ]   --->   [ 0 ] Result        |
+-------------------------------------------------------------+
|                           ARMOR                             |
|  [ 5 ] Helmet                                               |
|  [ 6 ] Chestplate                                           |
|  [ 7 ] Leggings                                             |
|  [ 8 ] Boots                                [ 45 ] Offhand  |
+-------------------------------------------------------------+
|                       MAIN INVENTORY                        |
|  [ 9 ] [10] [11] [12] [13] [14] [15] [16] [17]             |
|  [18] [19] [20] [21] [22] [23] [24] [25] [26]             |
|  [27] [28] [29] [30] [31] [32] [33] [34] [35]             |
+-------------------------------------------------------------+
|                          HOTBAR                             |
|  [36] [37] [38] [39] [40] [41] [42] [43] [44]             |
+-------------------------------------------------------------+

8. Companion Server Plugin (macromod-server)

MacroMod is designed as a player-first client-side mod. Server administrators can manage or restrict macro features on Paper, Folia, Velocity, or BungeeCord servers using our companion plugin:

# MacroModServer Policy Configuration (config.yml)
version: 1

allowMovement: true             # Allow movement actions ({KEYDOWN W}, etc.)
allowLook: true                 # Allow camera rotation actions ({LOOK}, {LOOKAT})
allowInventoryAutomation: true  # Allow slot clicking ({SLOTCLICK}, {SHIFTCLICK})
allowScriptFiles: true          # Allow executing multi-line .mcm script library files
allowLooping: true              # Allow while and for loop statements

maxLoopIterations: 1000         # Max loop iteration cap
chatRateLimitMs: 250            # Delay (ms) enforced between chat messages