Creating custom tools with Brush Engine

Since PixiEditor 2.1, you can create your own toolsets and tools based on Brushes.

Go to %localappdata/PixiEditor/Configs and create a file called ToolSetsConfig.json. Now, the contents of the file may look like this:

{
  "CustomTools": [
    {
      "ToolName": "Gradient",
      "Brush": "path/to/brush/GradientBrush.pixi",
      "Icon": "path/to/icon.png",
      "ToolTip": "Allows for drawing gradients",
      "DefaultShortcut": "G",
      "ActionDisplays": [
        {
          "ActionDisplay": "Click and drag to create a gradient"
        },
        {
          "Modifiers": "Ctrl",
          "ActionDisplay": "Click and drag to create an inverted gradient."
        }
      ]
    }
  ],
  "ToolSets": [
    {
      "Name": "Toolset",
      "Icon": "icon-noise",
      "Tools": [
        "Gradient"
      ]
    },
    {
      "Name": "PAINT_TOOLSET",
      "Icon": "icon-paint-brush",
      "Tools": [
        {
          "ToolName": "MoveViewport",
          "Icon": "path/to/new/icon.png"
        }
      ]
    }
  ]
}

For icons, you can use .png, .svg or icon-name to use PixiEditor’s built-in icons. All glyphs can be found here.

You can overwrite built-in toolsets settings and icons. It is not possible to remove any existing items.