Install

From ENIGMA

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). For all installations you currently need to have the Java Runtime Environment (JRE) installed as it is used by the LateralGM IDE, most people will already have java installed but if you don't make sure it is.

If you are having any problems with installation then please post on the forum or on our irc channel. Once the installation is complete it's advisory to test if everything is working by running a sample game (you can find some at the bottom or this page) or you could also just test by running an empty game.

Windows

Easy Installation

• Download: ENIGMA Zip Installer (55MB).

This file a self-extracting 7z executable which we created for high convenience and portability. It's an all-inclusive zip and provides you with everything you need to run ENIGMA.

Once the file is extracted just click ENIGMA.exe inside the folder and it will run ENIGMA/LGM. If you want to create a desktop shortcut right-click on ENIGMA.exe and goto Send To->Desktop. The first time you run ENIGMA.exe it will automatically download the ENIGMA repo for you before running LGM so wait for the installation to finish.

That should be it!

Source Installation

If you want more control over things then you can check-out the git repo manually and compile and install from source code.

Linux

Source Installation

Currently no Linux packages have been built, you can check-out the git repo manually and compile and install from source code.

Mac

Source Installation

The Mac repo is currently not stable and unlikely to work. If you wish to try it though feel free to attempt to get it working and compile and install from source code.

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:

• Catch the Clown (topic)
• Simple Maze Game

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.