User Guide

Quick Start

1. Download & Install from scriptsmonkey.com/macro
2. Launch and sign in (required for free tier)
3. Create your first macro with our step-by-step guide
4. Set a hotkey trigger to run your automation
5. Test and refine until it works perfectly

Guide Navigation

Essential Guides

• 🚀 Quick Start – Installation, interface tour, and first macro
• 🛠️ Creating Macros – Build automations with step‑by‑step instructions
• ⌨️ Triggers & Hotkeys – Configure hotkeys and trigger modes
• 🗂️ Organizing Macros – Folders, import/export, and management

Reference & Safety

• ⚙️ Settings & Preferences – Key configuration options
• 🌟 Account & Premium – Free vs premium, authentication
• 🛡️ Safety & Best Practices – Emergency stop, rate limiting, ethical use
• 🔧 Troubleshooting & FAQ – Common issues and solutions

Need Help?

• Community Support: Join our Discord

Installation

• Windows 10/11
• 4GB RAM (8GB recommended)
• 200MB free space

First Launch

1. Sign in – Required for the free tier (60 minutes every 12 hours). You can use Google, Discord, or Twitch accounts.
2. Skip or follow the quick tutorial – You can always revisit it from the Help menu.
3. Explore the interface – The main window is divided into:
   • Sidebar: Navigation, macro list, and folders
   • Playground: Where you build and test macros
   • Header: Macro name, description, and time remaining

Creating Your First Macro

1. Click New Macro in the sidebar.
2. Name it “Test Macro” (optional description).
3. From the action palette on the right, add a Delay action and set it to 1000ms.
4. Add a Key Press action, select the H key.
5. Add another Delay (500ms), then add key presses for the remaining letters: e, l, l, o, Space, W, o, r, l, d.
6. Click Set Trigger, press F9, and choose the trigger_run mode.
7. Save your macro (Ctrl+S).

Core Concepts

• Macro: A sequence of automated actions (mouse moves, key presses, delays).
• Action: A single step in a macro.
• Trigger: A hotkey that starts the macro.
• Trigger Modes:
  • trigger_run: Tap hotkey to run once (default)
  • hold_loop: Hold to repeat, release to stop
  • one_shot: Hold to run once, can release anytime

Free Tier vs Premium

Next Steps

• Try different actions (mouse moves, clicks, scrolling)
• Adjust delays for perfect timing
• Organize macros with folders
• Learn more in Creating Macros

Creating Macros

1. Plan Your Automation

• Which application will the macro run in?
• What exact steps are needed? (List each mouse/keyboard action)
• What timing is required between steps?
• How will you activate the macro? (Hotkey)
• What could go wrong? (Plan for errors)

1. Select all text (Ctrl+A)
2. Copy (Ctrl+C)
3. Switch to target app (Alt+Tab)
4. Wait 500ms for it to load
5. Paste (Ctrl+V)

2. Create a New Macro

• Click + New Macro in the sidebar, or press Ctrl+N.
• Give it a descriptive name (e.g., “Invoice Data Entry”).
• Add an optional description to explain its purpose.

3. Add Actions

1. Click a category in the palette.
2. Choose the specific action type.
3. Configure its parameters (click to edit).

• Delays: Start with longer delays (1000ms) and reduce after testing.
• Mouse Moves: Use absolute coordinates (e.g., 500, 300) or relative moves (+100, -50).
• Clicks: Choose from single, double, hold, or separate down/up.
• Keyboard: Use standard key names (Control, Shift, Enter). For combinations, write Control+C.
• Comments: Add notes to document your macro—they don’t affect execution.

4. Set a Trigger

1. Click the Set Trigger button in the playground.
2. Press your desired hotkey (e.g., F9).
3. Choose a trigger mode:
   • trigger_run (default): Tap hotkey to run once.
   • hold_loop: Hold to repeat, release to stop.
   • one_shot: Hold to run once, can release anytime.
4. Click Save.

• Avoid system shortcuts (Ctrl+Alt+Delete, Win+L).
• Use modifier combinations like Ctrl+Shift+F.
• Keep a list of your hotkeys to avoid conflicts.

5. Test and Refine

1. First test in a safe environment (e.g., Notepad).
2. Have the emergency stop (Ctrl+Shift+Esc) ready.
3. Press your trigger hotkey and watch the macro run.
4. Adjust delays, coordinates, and order as needed.

• Macro doesn’t trigger: Check that the macro is active (green play button) and ScriptsMonkey is running.
• Mouse misses target: Update screen coordinates or use relative moves.
• Timing inconsistent: Add buffer delays and account for system load.

6. Save and Organize

• Save your macro with Ctrl+S.
• Use folders (drag macros in the sidebar) to keep your collection tidy.
• Export macros as .json files to share or backup.

Next Steps

• Try different actions and fine‑tune timing.
• Explore Triggers & Hotkeys for more trigger options.
• Learn how to organize your macros in Organizing Macros.
• For a complete list of actions, see Action Reference.

Triggers & Hotkeys

Setting a Trigger

1. Open your macro in the playground.
2. Click the Set Trigger button in the bottom toolbar.
3. Press the key combination you want to use (e.g., F9, Ctrl+Shift+F).
4. Choose a trigger mode from the dropdown.
5. Click Save.

Trigger Modes

Choosing Hotkeys

• Function keys: F9, F10, F11, F12
• Modifier combinations: Ctrl+Shift+Letter, Alt+Shift+Number
• Numpad keys (with NumLock off)

• System shortcuts: Ctrl+Alt+Delete, Alt+F4, Win+L
• Common application shortcuts: Ctrl+S (Save), Ctrl+C (Copy)
• Single common keys: A, Enter, Space, Tab

• Pick easy‑to‑reach keys for frequently used macros.
• Use more complex combinations for dangerous macros.
• Keep a list of your hotkeys to avoid conflicts.

Safety

• Emergency stop: Press Ctrl+Shift+Esc to halt all macros immediately.
• For macros that could cause harm, use one_shot mode or add a confirmation delay.
• Regularly review your trigger assignments.

Troubleshooting

• Make sure the macro is active (green play button).
• Check that ScriptsMonkey is running.
• Test the hotkey in a simple text editor first.

• Look for duplicate hotkeys.
• Verify the correct macro is selected in the sidebar.

Organizing Macros

Folders

• Drag a macro onto empty space in the sidebar, or
• Right‑click in the sidebar and choose New Folder.

• Drag macros into folders.
• Drag folders to reorder or nest them (up to 3 levels).
• Right‑click a folder to rename or delete it (deleting a folder moves its macros to the root).

Import & Export

• Right‑click the macro in the sidebar and select Export.
• A .json file is saved with all the macro’s data.

• Right‑click in the sidebar (or a folder) and choose Import.
• Select the .json file; the macro appears in the current location.

• Back up important macros.
• Share useful automations with others.
• Move macros between computers.

Duplicate & Templates

• Right‑click a macro and select Duplicate.
• The copy appears with _copy added to its name.

1. Build a macro with placeholder actions (e.g., “UPDATE COORDINATES”).
2. Name it with [TEMPLATE] prefix.
3. Duplicate it whenever you need a similar macro, then fill in the details.

Search

Best Practices

• Start with a simple folder structure and refine as your collection grows.
• Regularly delete test macros and archive old versions.
• Export your important macros periodically as a backup.

Action Reference

Delay Actions

Delay: 2000ms # Wait 2 seconds

Mouse Actions

Mouse Move

# Move to exact coordinates (top‑left is 0,0)
Type: absolute
X: 500
Y: 300

# Move 100px right, 50px down from current position
Type: relative
X: 100
Y: 50

Mouse Click

# Single left‑click
Button: left
Type: single

# Right‑click and hold for 1 second
Button: right
Type: hold
Duration: 1000

Mouse Scroll

Direction: vertical
Amount: -10 # Scroll up 10 lines

Keyboard Actions

Key Press

# Type the letter 'A'
Key: A
Type: press

# Press Ctrl+C (copy)
Key: Control+C
Type: press

# Hold Shift key down
Key: Shift
Type: down

# Release Shift key
Key: Shift
Type: up

Comment Actions

Text: "=== FORM FILLING SECTION ==="

Skip Point Actions

Settings & Preferences

Accessing Settings

Appearance

• Dark mode (default) – dark background, light text.
• Light mode – light background, dark text.

Sound

• Macro start/complete
• Error alerts
• Trigger activation
• Emergency stop

Hotkeys

• Default macro trigger: F9 (can be changed)
• Active toggle: F10 (enable/disable all macros)
• Emergency stop: Ctrl+Shift+Esc (fixed, cannot be changed)

Safety

• Minimum delay between actions: 10ms (default). Increase for gaming or slower systems.
• Maximum actions per second: 100 (default).

Updates

• Stable – fully tested releases (recommended).
• Beta – preview new features (may be unstable).
• Alpha – development builds (unstable).

Data

• Create manual backups anytime.
• Set up automatic backups (daily, weekly, monthly).
• Restore from a backup file if needed.

Account & Premium

Authentication

Free Tier

• All macro creation and editing tools.
• All action types (delay, mouse, keyboard, etc.).
• Folder organization, import/export.
• Basic trigger configuration.
• Safety features (emergency stop, rate limiting).

• The header shows minutes remaining.
• Plan longer automation sessions to stay within the limit.
• You’ll see warnings when you’re close to running out.

Premium Tier

• Advanced triggers (conditional, scheduled, etc.).
• Analytics and reporting.
• Team/enterprise management.

Pricing

Safety & Best Practices

Emergency Stop

Rate Limiting

• Minimum delay between actions: 10ms (default). Increase to 50‑100ms for productivity macros, 100‑500ms for gaming.
• Maximum actions per second: 100 (default).

Safe Macro Design

• Rapid clicking without delays (can overload the system).
• File operations without backups or confirmation.
• Infinite loops with no way to stop.

Testing

Ethical Use

Regular Safety Check

• Review your macros periodically for safety issues.
• Ensure the emergency stop still works.
• Update rate limiting and allowlists as needed.

Troubleshooting & FAQ

Quick Steps

1. Emergency stop: Press Ctrl+Shift+Esc.
2. Restart ScriptsMonkey.
3. Check for updates (Settings → Updates → Check now).
4. Reinstall ScriptsMonkey.

Installation

• Ensure Windows 10/11, 4GB RAM, 200MB free space.
• Install Visual C++ Redistributable.
• Temporarily disable antivirus, then add an exception for ScriptsMonkey.

Macro Execution

• Check that the macro is active (green play button).
• Verify ScriptsMonkey is running (system tray/taskbar).
• Test the hotkey in Notepad first (if characters appear, the hotkey works).
• Close other automation software.

• Increase delays between actions.
• Update mouse coordinates (screen resolution or window position may have changed).
• Make sure the target application is in the foreground (add an Alt+Tab action if needed).

• Adjust the minimum delay between actions in Safety settings.
• Add/remove delays in the macro itself.

Interface & Performance

• Close unused macros and collapse folders.
• Export and archive old macros.
• Update to the latest version.

• Adjust interface scale.
• Move ScriptsMonkey to your primary monitor.

Authentication & Account

• Allow pop‑ups for scriptsmonkey.com.
• Check that Google/Discord/Twitch is not down.
• Ensure internet connection and firewall allow ScriptsMonkey.

• Wait 5–10 minutes for processing.
• Sign out and back in.
• Contact support with your transaction ID.

• Verify system clock is accurate.
• Usage aggregates across all devices signed into your account.

Data & Files

• Always export important macros as backup.
• Look for backup files in %APPDATA%\ScriptsMonkey\backups\ (Windows)

• Ensure the file is valid JSON (open in a text editor).
• Check that the exported version matches your ScriptsMonkey version.
• Try exporting/importing a single macro first.

FAQ

Contact Support

• Discord community server

1. ScriptsMonkey version (Settings → About).
2. Operating system and version.
3. Steps to reproduce the issue.
4. Error messages (screenshots help).
5. What you’ve already tried.