krita_grid_generator/README.md

Krita Grid Generator

A Python plugin for Krita that generates customizable square and hexagonal grids on vector layers.

Features

• Square Grids: Customizable width and height with an optional aspect ratio lock.
• Hexagonal Grids: Generates regular hexagons based on a single side length for a perfect honeycomb pattern.
• Color Selection: Choose between Krita's Foreground or Background color for the grid lines.
• Custom Thickness: Specify the line thickness in pixels.
• Dockable UI: Operates as a Krita Docker for quick access without blocking your workspace.

Installation

Method 1: Easy Import (Recommended)

1. Download the project as a ZIP file
2. Open Krita.
3. Go to Tools > Scripts > Import Python Plugin from File...
4. Select the downloaded grid_generator.zip file (found in the root of the project).
5. Restart Krita.
6. Enable the plugin in Settings > Configure Krita... > Python Plugin Manager by checking Grid Generator.

Method 2: Manual Installation

1. Locate your Krita resource folder (Settings > Manage Resources... > Open Resource Folder).
2. Open the pykrita folder.
3. Copy the grid_generator.desktop file and the grid_generator folder from this repository into the pykrita folder.
4. Restart Krita and enable it via the Python Plugin Manager.

How to Use

1. Once installed and enabled, go to Settings > Dockers and check Grid Generator.
2. The Grid Generator panel will appear in your sidebar.
3. Choose your Grid Type (Square or Hexagon).
4. Adjust the Thickness, Dimensions, and Color.
5. Click Generate. A new vector layer named "grid" will be created with your pattern.

Requirements

• Krita 5.0 or newer.