The basics

1. Download CORE.
2. Download and install Xcode (for Mac) and/or Microsoft Visual Studio (for Windows).
3. Build the sample plug-in(s) of your choice.
4. Duplicate and modify the Skeleton plug-in to start your own.

macOS

Illustrator and macOS have been around for many years, so system compatibility can get confusing; however, this list and an open-source shell script will fix you right up.

Xcode 4.5 or above is required to develop Illustrator plug-ins for macOS using CORE. We have tested full compatibility up to Xcode 10.3.0. Partial compatibility can be achieved in Xcode 11; compilation for Illustrator CS6 through CC 2017 does not appear to be possible (tested up to Xcode 11.6).

• To distribute plug-ins for macOS Catalina or later (10.15), you will need Xcode 10 or later to notarize your binary. Please refer to Apple's documentation on how to do this.
• To develop plug-ins for Illustrator CC 2021 (Ai 25), you will need the OS 10.14 SDK. This is included in Xcode 10.
• To develop plug-ins for Illustrator CC 2019 (Ai 23) or 2020 (Ai 24), you will need the OS 10.13 SDK. This is included in Xcode 9.
• To develop plug-ins for Illustrator CC 2018 (Ai 22), you will need the OS 10.12 SDK. This was included in Xcode 8, but not Xcode 9.
• To develop plug-ins for Illustrator CC 2017 (Ai 21), you will need the OS 10.11 SDK. This was included in Xcode 7, but not Xcode 8.
• To develop plug-ins for Illustrator CC 2015.x (Ai 19 or 20), you will need the OS X 10.9 SDK. This was included in some versions of Xcode 5 and 6, but not Xcode 7 or later.
• To develop plug-ins for Illustrator CC 2013 or CC 2014 (Ai 17 or 18), you will need the OS X 10.7 SDK. This was included in some versions of Xcode 4, but not Xcode 5 or later.
• To develop plug-ins for Illustrator CS6 (Ai 16), you will need the OS X 10.6 SDK. This was included in some versions of Xcode 3 and 4, but not Xcode 5 or later.

To be able to compile against all versions of CORE, your Xcode binary will need to be modified for legacy support. We recommend downloading Xcode 10.3.0, 9.4.1, 8.3.3, 7.3.1, 6.4.0, 5.1.1, 4.6.3, and 3.2.6. Otherwise, you will only be able to compile against the version of CORE corresponding to the macOS SDK versions listed above.

All the Xcode modifications are straightforward and are fully automated by this XcodeLegacy script on github. Simply download it (or checkout its git repository) and follow the instructions.

Windows

Microsoft Visual Studio 2015 Professional or above is required to develop Illustrator plug-ins for Windows using CORE.

Hot Door uses Microsoft Visual Studio 2015 Professional and has not tested later versions.

No modifications or additional downloads are needed to develop plug-ins for CS6 through 2021 (16-25).

CORE sample plug-ins

CORE contains four sample plug-ins: Annotate, Panel, Skeleton, and Tool.

The Annotate sample implements a simple rectangle drawing tool, which annotates its geometry during dragging.

The Skeleton sample simply acts as an empty plugin that performs no function, but which Illustrator recognizes and loads successfully. This is to provide a good foundation on which to start building your own plugin (see below).

The Tool plug-in implements a gear drawing tool. This demonstrates the creation of tools, modal dialogs with UI elements, preferences, and Illustrator art drawing.

The Panel plug-in demonstrates the creation of panels with UI elements, notifiers, timers, and Illustrator art object iteration.

CORE Skeleton plug-in

The easiest way to get your plug-in started using CORE is to duplicate and modify the Skeleton plug-in as a starting point.

1. Create a new project folder and copy the contents of the Skeleton folder to the new project folder.
2. Create a Libraries folder (anywhere is fine) and copy hdi_core into it. You do not need to copy the Samples or Documentation folders.
3. Open the project file in Xcode or Visual Studio.
4. Delete the hdi_core folder from the Libraries group and add the new hdi_core folder that you just placed into your Libraries folder.

You have two choices at this point: either start working with Skeleton as-is and add your own code, or follow these instructions to eliminate all traces of "Skeleton" and "skel" from your project.

• First, come up with a name for your project. If the name is long, you may want a shortened version for some of the config files. For example, "skel" is used in place of "skeleton".
• In the Configs folder, change the 'skel' portion of the file names to match your project
• In all of the config files (except skel-shared.xcconfig on Mac) edit the #include line to the name you just changed.
• In Headers, change skelPlugin.h file name to your new name.
• In Projects, change the project names to match your new name.
• In Resources, change Skeleton.json to match your new name.
• In Sources, change skelPlugin.cpp and skelSetup.cpp to match your new name.
• For Mac, open Skeleton.xcodeproj with a text editor and replace all instances of "Skeleton" and "skel" with your new name.
• For Windows, open Skeleton.sln, Skeleton.vcxproj, Skeleton.vcxproj.filters, and Skeleton.vcxproj.user with a text editor and replace all instances of "Skeleton" and "skel" with your new name.
• For Mac, in Configs/skel-shared.xcconfig, change the paths to CORE.
• For Mac, open Info.plist with a text editor and change as necessary.
• In the header file, change the namespace name from "skel" to your new name
• In the Resources/Skeleton.json file, change references to Skeleton to match your new name.
• Open the project files in Xcode or Visual Studio.
• Now add the appropriate .a / .lib binary files to the targets.
• Choose the desired target and build. The plug-in will install into /Applications/Illustrator <X>/Plug-ins (on Mac) or C:\Program Files\Adobe\Adobe Illustrator <X>\Plug-ins (on Windows). You may change this install path as necessary.