Windows Installation

From ENIGMA
Jump to navigation Jump to search
The official logo of Windows based operating systems and environments.

This primary method of installing is 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!

Note: You need to run the self-extracting zip and the enigma.exe with administrative privileges before and after setup so the application can access AppData to output temporary build files, simply right click the file and select "Run as Administrator" on Windows Vista or later.


Source Code

For those looking for something a little more hands-on, you can set up your own subsystem for compiling ENIGMA from source code. MSVC is currently not supported, but we would like to facilitate such an installation at some point in the future.

MSYS2

These steps will help you configure an ENIGMA setup using the modern MSYS2 project. This setup better facilitates both 32-bit and 64-bit compilation and is actually used by ENIGMA's AppVeyor continuous integration.

- NOTE: The x86_64 download button will support compilation of both 32-bit and 64-bit games.
  • When you reopen MSYS2 you will need to use the included Pacman to obtain the packages used by ENIGMA for building games, which includes things like OpenAL. You will also likely want to install Git using Pacman so you can do a git pull to update your ENIGMA source code when there are changes made to our GitHub repository that you need.
- The Pacman command you will need to run is:
pacman -S base-devel git mingw-w64-x86_64-toolchain mingw-w64-x86_64-boost mingw-w64-x86_64-openal mingw-w64-x86_64-dumb mingw-w64-x86_64-libvorbis mingw-w64-x86_64-libogg mingw-w64-x86_64-flac mingw-w64-x86_64-mpg123 mingw-w64-x86_64-libsndfile mingw-w64-x86_64-libgme mingw-w64-x86_64-sfml mingw-w64-x86_64-gtk2 mingw-w64-x86_64-zlib mingw-w64-x86_64-libffi mingw-w64-x86_64-box2d mingw-w64-x86_64-bullet
- These include the same packages we use for AppVeyor CI.
  • Now that MSYS2 is configured you will want to clone the ENIGMA repository. First use the change directory command (cd path/to/directory) to change MSYS2 to the directory you want ENIGMA installed in. Then simply run: git clone https://github.com/enigma-dev/enigma-dev.git

MinGW

These steps will help you configure an ENIGMA setup using the original MinGW project.

  • Install MinGW (installer): To install: download the MinGW64 compiler toolkit installer: http://www.mingw.org/wiki/InstallationHOWTOforMinGW You may choose either regular MinGW or MinGW 64bit and 32bit either are fine, and be sure to leave the install directory to the default path. There are also many MinGW installers available on the internet and it also comes with CodeBlocks, we do not support the TDM installer however, just due to their general poor quality and missing backwards linking.
  • Clone the ENIGMA repo: Once you have git set-up you just need to check-out from the Repository. If you don't have (or know how to use) git but want to test still then you can alternatively download the enigma git repo as a zip from here: https://github.com/enigma-dev/enigma-dev/archive/master.zip (note though that by downloading). Make sure the repo is placed somewhere in your C:/ drive (like program files or user documents or where-ever) pretty much anywhere -except inside the MinGW folder!
  • Download the Windows dependencies (zip): Finally download the Windows dependencies from here: https://dl.dropboxusercontent.com/u/21117924/WinPatch_28_08_2013.zip (4.77mb's) and extract it. Then just copy all the files in this folder into the enigma-dev folder which was checked-out from the git repo. Now run "ENIGMA.exe", and you should be good to go, you may need to right click and run with administrative privileges the first time. If you want to make a desktop icon then right-click on ENIGMA.exe and send to desktop. It should compile and place a file "compileEGMf.dll" in the same folder as the .exe. If it fails then do manual compilation.
  • Manual compilation: In cases when the .dll is not compiled or the .exe is out of date, then it is recommend to recompile both of them. To do this, you must have a valid MinGW installation (from the first step), open bash (git-bash or maybe msys/cygwin would work as well), go to the enigma-dev folder and type "mingw32-make" or just "make". It should compile the .dll. To recompile .exe you must go into enigma-dev\CompilerSource\stupidity-buffer and type "mingw32-make" or just "make". This will create the .exe in this folder that then needs to be copied into the main directory. The .exe can be compiled from cmd (windows console), while the .dll requires bash.