LibreAutomate

LibreAutomate is a C# script editor and library designed for automating tasks on Windows. It allows developers to automate desktop and web UIs using keyboard, mouse, and API interactions. The platform supports finding and clicking buttons, links, and images, as well as managing files, windows, and programs.

Key capabilities include:

• UI Automation: Find and interact with UI elements (buttons, links, images).
• Triggers: Implement hotkeys, autotext (auto-replace/expand), and window-based triggers.
• Custom UI: Create custom toolbars (attachable to windows or screen edges), menus, and complex dialog windows.
• Extensibility: Use the full power of C#, .NET, NuGet libraries, and the Windows API.
• Deployment: Create independent .exe programs or .dll libraries.
• Development Tools: Includes a C# code editor with IntelliSense, a script manager, a cookbook, a debugger, and tools for recording keyboard/mouse input.

LibreAutomate is a C# script editor and automation library for Windows built on .NET 10. It provides two primary ways to interact with the system:

Automation Library

• UI Automation: Automate desktop and web interfaces using keyboard, mouse, or API. Supports finding and clicking buttons, links, and images.
• System Management: Launch programs, manage files/windows, and process text/data.
• Triggers & Input: Implement hotkeys, autotext (auto-replace/expand text while typing), auto-close windows, and key remapping.
• UI Customization: Create custom toolbars (attachable to windows or screen edges), menus, and complex custom dialog windows via code.
• Integration: The library can be embedded into other programs.

Script Editor App

• C# Scripting: Uses C# as the scripting language, featuring an editor with Intellisense, a script manager, a cookbook, and a debugger.
• Recording Tools: Tools for recording keyboard/mouse input and selecting UI objects (buttons, links, images).
• Extensibility: Supports .NET and other libraries, including NuGet, Windows API, and icon sets.
• Output: Capability to create independent .exe programs and .NET libraries.

syntax, which allows for concise code. A script can contain the following components in this specific order (all are optional):

1. Comments or documentation comments: e.g., /// File description.
2. Properties: Defined via /*/ properties /*/. These can be managed through the Properties dialog.
3. using directives: Note that these do not need to be specified in the global.cs file.
4. script.setup() or runtime property setup: Code used to configure the script's environment.
5. Script code: The main logic, which can include local functions.
6. Classes and other types: Definitions for custom types used within the script.

If you prefer the traditional C# structure, you can use a class with a Main function by selecting Code > Simple > Add function Main from the menu.

/// <summary>
/// My script description
/// </summary>

/*/ properties /*/

using System;

// Script code using top-level statements
Console.WriteLine("Hello from LibreAutomate!");

// Custom types
public class MyHelper { }

LibreAutomate manages NuGet packages using a two-tier storage system:

1. Global Cache: Packages are first downloaded to the shared cache at folders.Profile + ".nuget\packages". This folder is safe to delete.
2. Workspace Folder: LibreAutomate copies the required files from the cache to workspace\.nuget\<folder_specified_in_combo_box>. This is the folder used by the editor and scripts.

Key Behaviors:

• Isolation: You can install different versions of the same package into different folders (e.g., FolderA for version 1 and FolderB for version 2) to avoid conflicts.
• Dependencies: When you install a top-level package, its dependencies are also installed. While the tool only shows the top-level package, all dependencies are available for use in your scripts.
• exeProgram Scripts: When compiling a script with the exeProgram role, runtime files are copied to the output folder.

Snippet code supports specific fields (for tab-stops) and variables (for dynamic content).

Fields (Tab-stops)

Used to navigate through the snippet during insertion using the Tab key:

• $0: The final text cursor position after pressing Enter or multiple Tab presses.
• ${n:text}: A field with tab-stop index n and default text. Example: ${1:i}.
• $n or ${n}: A reference to an existing ${n:text} field. Updating one updates all matching instances.

Variables

• ${SELECTED_TEXT}: The currently selected text (used only with the Surround feature).
• ${RANDOM}: A random decimal number.
• ${RANDOM_HEX}: A random hexadecimal number.
• ${GUID}: A new GUID.
• ${VAR}: A local variable of the type specified in the snippet's \${VAR} property.

Escape Sequences

Use \$, \\, or \} to escape these characters.

Note: Other VSCode snippet variables and features are not supported.

for (int ${1:i} = 0; $1 < ${2:count}; $1++) {
	${SELECTED_TEXT}$0
}

A workspace is a folder on disk that contains the following structure:

• files/: Contains the workspace's files and folders.
• files.xml: The list of files and folders in the workspace.
• settings.json: Workspace-specific settings.
• bookmarks.csv: Saved bookmarks.
• .state/: Stores code editor states (folding, markers, current position).
• exe/ and dll/: Default output folders for files compiled with roles exeProgram or classLibrary.

File Types

• Script: C# code files that can be executed directly like a program.
• Class: C# code files containing classes/functions used by other files.
• Text files: .txt, .xml, etc., editable in the code editor.
• Other files: Non-editable files (e.g., images) that can be added to exe program resources.

Folder Types

• Simple folders: Standard directories.
• Project folders: Folders named with the @ prefix (e.g., @Name).