README.md

HOMM Icons plugin for Craft CMS

Craft CMS Icon Picker

This plugin reads all images in the "icons" folder of your specified subvolumes. You should only upload SVG's in this folder!

Requirements

This plugin requires Craft CMS 4.x.

For the Craft CMS 3.x plugin version, see 0.x tags.

Installation

To install the plugin, follow these instructions.

1. Open your terminal and go to your Craft project:

    cd /path/to/project
   

2. Then tell Composer to load the plugin:

    composer require homm/hommicons
   

3. In the Control Panel, go to Settings → Plugins and click the “Install” button for HOMM Icons.

HOMM Icons Overview

This plugin reads all images in the "icons" folder of your specified subvolumes. You should only upload SVG's in this folder!

Configuring HOMM Icons

Go to Settings > HOMM Icons:

Here you can choose the desired assets volume which should be scanned.

Using HOMM Icons

1. Go to Settings > Fields and choose the desired field.
2. Within the Field Type choose HOMM Icons
3. Upload your SVG icons in your <VOLUME>/icons folder

Basic usage in the template (Twig):

{{ svg('@webroot/images/icons/' ~ entry.icon ~ '.svg') }}

HOMM Icons Roadmap

Some things to do, and ideas for potential features:

• Add option to choose (an optional) subfolder
• Provide Craft Variable to easily output the icon

Brought to you by HOMM interactive