Installation

Where to get the plug-in

Most users don’t have to “get” the plug-in anywhere, as there is an automatic installation built into IDEA.  See “Install the plugin using IDEA” (below).

Published versions of the Haxe plug-in for IDEA are available through JetBrains’ plug-in repository and github.

Pre-release and feature test versions are available at github.


Installing IntelliJ IDEA

If you don’t have IntelliJ IDEA (or Android Studio or another of JetBrains’ products) installed, you will need to download and install the program using your operating system’s normal installation methods.  We recommend using IntelliJ IDEA Ultimate so that the full feature set of the plugin will be available.  However, the Community Edition is just fine for most purposes.  Debugging is the major feature that is not supported in CE (JetBrains’ limitation).  IDEA is found at https://www.jetbrains.com/idea.

When downloading, the latest regular release is recommended.  Early Access (EAP) versions are not tested and not officially supported by the plugin team.  We do appreciate bug reports, though!

When installing, a large number of optional features, languages, frameworks, etc. are presented for installation.  We recommend installing the minimum set that you will normally use.  Every optional feature installed slows IDEA both during startup and at run-time.  (Because IDEA’s internal architecture asks every plugin whether it has to be involved at every operation, — for example, indexing, find, completion — and many plugins provide functionality as “embedded languages” in another source file).


To install the plugin using IDEA (from the IntelliJ Plug-in Repository)

Install and start IDEA.

If you do not have a project open in IDEA (and after first-time setup):

  1. On the IDEA welcome screen, select “Configure(dropdown)->Plugins”
  2. Click on the “Browse Repositories…” button.
  3. Type ‘haxe’ to see the description for the plugin.
  4. Select ‘Install’ to install it.
  5. Allow IDEA to restart and initialize the plugin.

If you already have a project open in IDEA:

  1. Open the Settings dialog (File->Settings…)
  2. Highlight “Plugins” in the leftmost column
  3. Click on the “Browse Repositories…” button.
  4. Type ‘haxe’ to see the description for the plugin.
  5. Select ‘Install’ to install it.
  6. Allow IDEA to restart and initialize the plugin.

To manually install the latest or a previous Github release

Download the `intellij-haxe.jar` file from the release you want from Github releases.
More recent releases have begun to be named `intellij-haxe-<release>.jar`, where <release> is the version of Idea for which the Jar is built. (e.g. `intellij-haxe-17.jar`)
Make sure that you pick the proper one for your release.  A message should pop up and warn you if a release is incompatible.

If you do not yet have a project open in IDEA (and after first-time setup):

  1. On the IDEA welcome screen, select “Configure(dropdown)->Plugins”
  2. Click “Install plugin from disk…”
  3. Select the “intellij-haxe.jar” file you downloaded
  4. Allow IDEA to restart and initialize the plugin.

If you already have a project open in IDEA:

  1. Open the Settings dialog (File->Settings…)
  2. Highlight “Plugins” in the leftmost column
  3. Click “Install plugin from disk…”
  4. Select the “intellij-haxe.jar” file you downloaded
  5. Allow IDEA to restart and initialize the plugin.

 


IntelliJ IDEA Documentation

JetBrains’ official plugin installation documentation is at https://www.jetbrains.com/idea/plugins/.
The Haxe plugin page is https://plugins.jetbrains.com/plugin/6873?pr=idea.