ImageGlass.Tools - Build tools for ImageGlass

ImageGlass.Tools is a set of APIs to integrate third-party software with ImageGlass. With ImageGlass.Tools, developers can extend the functionality of ImageGlass by integrating their own software solutions, making it a highly customizable and versatile tool for all image viewing needs.

You can download tools for ImageGlass 9 at: https://imageglass.org/tools

Getting started

Here are the simple steps to use APIS from ImageGlass.Tools. You can check out the DemoApp project for complete sample.

1. To get started, you need to download or clone this repo.
2. Create a new project in Visual Studio.
3. Add ImageGlass.Tools.csproj as a reference project into your software.
4. Create a new instance of ImageGlassTool:

private readonly ImageGlassTool _igTool = new ImageGlassTool();

5. Add event listeners to ImageGlass:

_igTool.ToolMessageReceived += IgTool_ToolMessageReceived;
_igTool.ToolClosingRequest += IgTool_ToolClosingRequest;

6. Handle event from ImageGlass:

private void IgTool_ToolMessageReceived(object? sender, MessageReceivedEventArgs e)
{
  if (string.IsNullOrEmpty(e.MessageData)) return;

  if (e.MessageName == ImageGlassEvents.IMAGE_LOADED)
  {
    Trace.WriteLine("Image is loaded");
    Trace.WriteLine(e.MessageData);
  }
}

7. Start connecting to ImageGlass:

await _igTool.ConnectAsync();

Add an external tool to ImageGlass 9

Use ImageGlass Settings

1. Open ImageGlass Settings, click on tab "Tools"
2. Click "Add..." button to add a new tool
3. Fill in all the fields accordingly
   • In Argument text box, fill <file> so that ImageGlass will send the full path of the current viewing image file to the tool
   • Check the option Integrated with ImageGlass.Tools if the tool has implementation of ImageGlass.Tools
   • Check command preview to make sure your inputs are correct
4. Click "OK" button to close the dialog, click "OK" or "Apply" button to apply the changes

Use igconfig.json

1. Open igconfig.json file with a text editor such as NotePad or VS Code.
2. Ensure that ImageGlass app is not running.
3. In the Tools section of the igconfig.json file, add the following code:

// in igconfig.json
"Tools": [
  {
    "ToolId": "Tool_MyDemoApp", // a unique ID
    "ToolName": "My Demo app", // name of the tool
    "Executable": "path\\to\\the\\DemoApp.exe",
    "Argument": "<file>", // file path to pass to the tool
    "Hotkeys": ["X", "Ctrl+E"], // press X or Ctrl+E to open/close the tool
    "IsIntegrated": true|false // true: if the tool supports 'ImageGlass.Tools'
  }
]

4. Save the file, and you're done!