Install - hpgDesigns/hpgdesigns-dev.io GitHub Wiki

This page documents the official installation procedure for all platforms. Note that these ENIGMA installations include by default the Plugin and LateralGM (which is used as an IDE for ENIGMA).

Platforms

Windows

  • 1. Download the MinGW install executable from here: http://sourceforge.net/projects/mingw/files/latest/download?source=files. Note that this is a newer version than is typically available for download. We need this particular version for certain binaries and bug fixes that prior versions don't offer. Run the MinGW installer. Pre-packaged vs latest repository catalogues doesn't matter (we recommend pre-packaged only because it's a faster install). Make sure to leave the selected drive as C:\MinGW and to choose the 'C compiler, C++ compiler, ObjC compiler and MSYS Basic System' options when prompted which components to install.
  • 2. After the MinGW installation is complete download the ENIGMA zip at github from here: https://github.com/enigma-dev/enigma-dev/zipball/master. Unzip the ENIGMA folder to a directory of your choosing, it should be fine in any location on C:/ (like Program Files), just don't place it in the MinGW directory.

Linux

Currently no Linux packages have been built. Instead, you should check out from the Repository.

Mac

Currently no builds are available for the Mac. Instead, you should check out from the Repository.

Other

If your platform is not listed, it may or may not be supported. You're welcome to try and install ENIGMA anyways either using any of the above methods, or by checking out from the Repository, and let us know if it works. Please also share any additional steps you may have needed to get it to work.

Compiling a Sample Game

After installation, it is a good idea to try compiling a sample game, as this will make sure the installation was done successfully. Note that the first time you compile a game it can take several minutes, however after this it will usually only take a few seconds, even when compiling another game. It's a good idea to start with a known working game instead of using one of your own; a few can be found here:

Open the game in LateralGM (by using File > Open) then in the ENIGMA menu at the top click the Run button. At this point, one of several things can happen:

  1. A dialog box may appear stating that ENIGMA is not ready. If this happens it is usually because ENIGMA has not finished initializing. In this case wait a little while and try again. If the problem persists for longer than 5 minutes, something probably went wrong.
  2. A dialog may state that ENIGMA cannot run due to prior errors - which you should have seen earlier, in which case you should attempt to resolve the prior error before you proceed.
  3. You should see a window with a text log appear, named ENIGMA Progress Console. This is the good window to see as it means ENIGMA is attempting to compile your game. From this the compile will either be successful, in which case you will be greeted with a playable game, or it will fail and will show an error in its backlog. Starting from the bottom of the log and working your way up, you can probably find the problem (usually highlighted in red). Alternatively, if you don't understand it, copy and paste the full log into a pastebin website and ask for help on either the forums or the IRC.