Building MAME using Microsoft Visual Studio compilers - Revision history

Mhavoc: Updated Page for Version change to Visual Studio 2017

2018-12-02T20:31:51Z

Updated Page for Version change to Visual Studio 2017

Cuavas at 23:13, 29 June 2017

2017-06-29T23:13:59Z

← Older revision		Revision as of 01:13, 30 June 2017
Line 3:		Line 3:
	Alternatively, you can configure MAME to build using Visual Studio. Once you have done that, you can debug problems in MAME using the Visual Studio debugger, which is a huge step up from gdb.		Alternatively, you can configure MAME to build using Visual Studio. Once you have done that, you can debug problems in MAME using the Visual Studio debugger, which is a huge step up from gdb.

	Since MAME uses modern C++ features, Visual Studio 2015 is required~~, and [https://www.visualstudio.com/en-us/news/vs2015-update2-vs.aspx~~ Update ~~2] is preferred as it fixes various compiler bugs~~. If you don't have a paid license, [https://www.visualstudio.com/en-us/products/visual-studio-community-vs.aspx Visual Studio Community 2015] is available from Microsoft for free (but requires sign-in with a Microsoft account).		Since MAME uses modern C++ features, Visual Studio 2015 with Update 3 is required (Update 3 adds minimal support for variable templates used by MAME). If you don't have a paid license, [https://www.visualstudio.com/en-us/products/visual-studio-community-vs.aspx Visual Studio Community 2015] is available from Microsoft for free (but requires sign-in with a Microsoft account).

	Here's how to make it work:		Here's how to make it work:

Balrog: missed a word

2016-06-02T13:24:45Z

missed a word

← Older revision		Revision as of 15:24, 2 June 2016
Line 3:		Line 3:
	Alternatively, you can configure MAME to build using Visual Studio. Once you have done that, you can debug problems in MAME using the Visual Studio debugger, which is a huge step up from gdb.		Alternatively, you can configure MAME to build using Visual Studio. Once you have done that, you can debug problems in MAME using the Visual Studio debugger, which is a huge step up from gdb.

	Since MAME uses modern C++ features, Visual Studio 2015 is required, and [https://www.visualstudio.com/en-us/news/vs2015-update2-vs.aspx Update 2] is preferred as it fixes various compiler bugs. If you don't have a paid license, [https://www.visualstudio.com/en-us/products/visual-studio-community-vs.aspx Visual Community 2015] is available from Microsoft for free (but requires sign-in with a Microsoft account).		Since MAME uses modern C++ features, Visual Studio 2015 is required, and [https://www.visualstudio.com/en-us/news/vs2015-update2-vs.aspx Update 2] is preferred as it fixes various compiler bugs. If you don't have a paid license, [https://www.visualstudio.com/en-us/products/visual-studio-community-vs.aspx Visual Studio Community 2015] is available from Microsoft for free (but requires sign-in with a Microsoft account).

	Here's how to make it work:		Here's how to make it work:

Balrog: Add info about VS Community and remove VS2013 as it is no longer supported.

2016-06-02T13:24:22Z

Add info about VS Community and remove VS2013 as it is no longer supported.

← Older revision		Revision as of 15:24, 2 June 2016
Line 1:		Line 1:
	By default, MAME is configured via the makefile to build using the MinGW gcc compiler. Although this is a nice cross-platform solution, debugging binaries built this way leaves a lot to be desired.		By default, MAME is configured via the makefile to build using the MinGW gcc compiler. Although this is a nice cross-platform solution, debugging binaries built this way leaves a lot to be desired.

	~~If you own a copy of Visual Studio~~, you can configure MAME to build using ~~those tools instead~~. Once you have done that, you can debug problems in MAME using the Visual Studio debugger, which is a huge step up from gdb.		Alternatively, you can configure MAME to build using Visual Studio. Once you have done that, you can debug problems in MAME using the Visual Studio debugger, which is a huge step up from gdb.

			Since MAME uses modern C++ features, Visual Studio 2015 is required, and [https://www.visualstudio.com/en-us/news/vs2015-update2-vs.aspx Update 2] is preferred as it fixes various compiler bugs. If you don't have a paid license, [https://www.visualstudio.com/en-us/products/visual-studio-community-vs.aspx Visual Community 2015] is available from Microsoft for free (but requires sign-in with a Microsoft account).

	Here's how to make it work:		Here's how to make it work:
Line 9:		Line 11:
	# Once you've done that, simply run: <code>make vs2015 PYTHON_EXECUTABLE=c:/msys64/mingw64/bin/python.exe</code> and wait for it to create projects		# Once you've done that, simply run: <code>make vs2015 PYTHON_EXECUTABLE=c:/msys64/mingw64/bin/python.exe</code> and wait for it to create projects
	# In order not to specify PYTHON_EXECUTABLE all the time, just place it in system variables		# In order not to specify PYTHON_EXECUTABLE all the time, just place it in system variables
	~~# For Visual Studio 2013 use: <code>make vs2013 </code>~~		# If you are building with XP compatibility enabled run <code>make vs2015_xp</code>
	# If you are building with XP compatibility enabled run <code>make vs2015_xp~~</code> or <code>make vs2013_xp~~</code>
	# Browse to folder containing solution file and open it with Visual Studio		# Browse to folder containing solution file and open it with Visual Studio
	# Inside Visual Studio you can change to Debug/Release x86 or x64 builds		# Inside Visual Studio you can change to Debug/Release x86 or x64 builds

Balrog: updated path to python executable

2016-05-28T22:39:07Z

updated path to python executable

← Older revision		Revision as of 00:39, 29 May 2016
Line 7:		Line 7:
	# You must already have an environment that can build MAME using the MinGW tools. Although you won't be using gcc to compile, you will be using several of the other tools included in the standard MAME [http://mamedev.org/tools/ MinGW Development Environment]		# You must already have an environment that can build MAME using the MinGW tools. Although you won't be using gcc to compile, you will be using several of the other tools included in the standard MAME [http://mamedev.org/tools/ MinGW Development Environment]
	# Switch to the directory where the root MAME makefile lives.		# Switch to the directory where the root MAME makefile lives.
	# Once you've done that, simply run: <code>make vs2015 PYTHON_EXECUTABLE=c:/~~buildtools~~/~~usr~~/bin/python.exe</code> and wait for it to create projects		# Once you've done that, simply run: <code>make vs2015 PYTHON_EXECUTABLE=c:/msys64/mingw64/bin/python.exe</code> and wait for it to create projects
	# In order not to specify PYTHON_EXECUTABLE all the time, just ~~placed~~ it in system variables		# In order not to specify PYTHON_EXECUTABLE all the time, just place it in system variables
	# For Visual Studio 2013 use: <code>make vs2013 </code>		# For Visual Studio 2013 use: <code>make vs2013 </code>
	# If you are building with XP compatibility enabled run <code>make vs2015_xp</code> or <code>make vs2013_xp</code>		# If you are building with XP compatibility enabled run <code>make vs2015_xp</code> or <code>make vs2013_xp</code>

Micko at 16:08, 29 March 2016

2016-03-29T16:08:14Z

← Older revision		Revision as of 18:08, 29 March 2016
Line 6:		Line 6:

	# You must already have an environment that can build MAME using the MinGW tools. Although you won't be using gcc to compile, you will be using several of the other tools included in the standard MAME [http://mamedev.org/tools/ MinGW Development Environment]		# You must already have an environment that can build MAME using the MinGW tools. Although you won't be using gcc to compile, you will be using several of the other tools included in the standard MAME [http://mamedev.org/tools/ MinGW Development Environment]
	~~# From the command prompt, you need to run the batch file that was installed with Visual Studio which configures the executable, include, and library paths.~~
	#* For example, on Visual Studio 2005, the command is: <code>"\Program Files\Microsoft Visual Studio 8\VC\vcvarsall.bat" x86</code> (To build a 64-bit version, change the <code>x86</code> to <code>amd64</code>)
	# Switch to the directory where the root MAME makefile lives.		# Switch to the directory where the root MAME makefile lives.
	# Once you've done that, simply run: <code>make ~~MSVC_BUILD~~=~~1 DEBUG=1 SYMBOLS=1~~</code> and wait for it to ~~complete (I suggest building with DEBUG=1 as that also disables optimizations and makes debugging much easier).~~		# Once you've done that, simply run: <code>make vs2015 PYTHON_EXECUTABLE=c:/buildtools/usr/bin/python.exe</code> and wait for it to create projects
			# In order not to specify PYTHON_EXECUTABLE all the time, just placed it in system variables
	~~At this point~~, ~~you should now have a mamed.exe that was built using Visual Studio tools. To debug~~ it ~~is very easy.~~		# For Visual Studio 2013 use: <code>make vs2013 </code>
			# If you are building with XP compatibility enabled run <code>make vs2015_xp</code> or <code>make vs2013_xp</code>
	# ~~Open up~~ Visual Studio.		# Browse to folder containing solution file and open it with Visual Studio
	# ~~From the File menu choose "Open Project..."~~		# Inside Visual Studio you can change to Debug/Release x86 or x64 builds
	# ~~Select vmamed.exe (you may need~~ to ~~adjust the~~ file ~~filters to show .exe files).~~		# While doing development please note that you need to update LUA files in scripts folders in order to add new sources and regenerate projects
	# ~~To configure command line parameters, right click on the vmamed.exe item in the Solution Explorer window and choose "Properties". In that window~~ you can ~~specify the "Command Arguments" which would be the command line parameters you want.~~		# Note that all parameters for partial compilation works so you can do <code>make SUBTARGET=tiny vs2015</code> or <code>make vs2015 SUBTARGET=drivername SOURCES=src\mame\drivers\drivername.cpp</code>
	# ~~Set some breakpoints if~~ you ~~want,~~ and ~~hit "Go" (F5), or else single step into main by hitting "Step Into" (F11).~~
	# ~~When you're done, Visual Studio will ask if you want to save a solution file (.sln); I usually say "yes", because then it will remember your last session~~ parameters for ~~the next time~~ you ~~want to debug MAME, and the solution will show up in the recent projects list~~.

	Back to [[How MAME Works]]		Back to [[How MAME Works]]

Aaron at 18:23, 12 September 2012

2012-09-12T18:23:31Z

← Older revision		Revision as of 20:23, 12 September 2012
Line 7:		Line 7:
	# You must already have an environment that can build MAME using the MinGW tools. Although you won't be using gcc to compile, you will be using several of the other tools included in the standard MAME [http://mamedev.org/tools/ MinGW Development Environment]		# You must already have an environment that can build MAME using the MinGW tools. Although you won't be using gcc to compile, you will be using several of the other tools included in the standard MAME [http://mamedev.org/tools/ MinGW Development Environment]
	# From the command prompt, you need to run the batch file that was installed with Visual Studio which configures the executable, include, and library paths.		# From the command prompt, you need to run the batch file that was installed with Visual Studio which configures the executable, include, and library paths.
	#* For example, on Visual Studio 2005, the command is: <code>"\Program Files\Microsoft Visual Studio 8\VC\vcvarsall.bat" x86</code>		#* For example, on Visual Studio 2005, the command is: <code>"\Program Files\Microsoft Visual Studio 8\VC\vcvarsall.bat" x86</code> (To build a 64-bit version, change the <code>x86</code> to <code>amd64</code>)
	#** (To build a 64-bit version, change the <code>x86</code> to <code>amd64</code>)
	# Switch to the directory where the root MAME makefile lives.		# Switch to the directory where the root MAME makefile lives.
	# Once you've done that, simply run: <code>make MSVC_BUILD=1 DEBUG=1 SYMBOLS=1</code> and wait for it to complete (I suggest building with DEBUG=1 as that also disables optimizations and makes debugging much easier).		# Once you've done that, simply run: <code>make MSVC_BUILD=1 DEBUG=1 SYMBOLS=1</code> and wait for it to complete (I suggest building with DEBUG=1 as that also disables optimizations and makes debugging much easier).

Aaron at 18:22, 12 September 2012

2012-09-12T18:22:57Z

← Older revision		Revision as of 20:22, 12 September 2012
Line 1:		Line 1:
	By default, MAME is configured via the makefile to build using the MinGW gcc compiler. Although this is a nice cross-platform solution, debugging binaries built this way leaves a lot to be desired.		By default, MAME is configured via the makefile to build using the MinGW gcc compiler. Although this is a nice cross-platform solution, debugging binaries built this way leaves a lot to be desired.

	If you own a copy of Visual Studio ~~.NET 2003 or Visual Studio 2005~~, you can configure MAME to build using those tools instead. Once you have done that, you can debug problems in MAME using the Visual Studio debugger, which is a huge step up from gdb.		If you own a copy of Visual Studio, you can configure MAME to build using those tools instead. Once you have done that, you can debug problems in MAME using the Visual Studio debugger, which is a huge step up from gdb.

	Here's how to make it work:		Here's how to make it work:
Line 7:		Line 7:
	# You must already have an environment that can build MAME using the MinGW tools. Although you won't be using gcc to compile, you will be using several of the other tools included in the standard MAME [http://mamedev.org/tools/ MinGW Development Environment]		# You must already have an environment that can build MAME using the MinGW tools. Although you won't be using gcc to compile, you will be using several of the other tools included in the standard MAME [http://mamedev.org/tools/ MinGW Development Environment]
	# From the command prompt, you need to run the batch file that was installed with Visual Studio which configures the executable, include, and library paths.		# From the command prompt, you need to run the batch file that was installed with Visual Studio which configures the executable, include, and library paths.
	#* For ~~Visual Studio .NET 2003~~, ~~the command is: (can't remember)~~		#* For example, on Visual Studio 2005, the command is: <code>"\Program Files\Microsoft Visual Studio 8\VC\vcvarsall.bat" x86</code>
	~~#* For~~ Visual Studio 2005, the command is: <code>"\Program Files\Microsoft Visual Studio 8\VC\vcvarsall.bat" x86</code>
	#** (To build a 64-bit version, change the <code>x86</code> to <code>amd64</code>)		#** (To build a 64-bit version, change the <code>x86</code> to <code>amd64</code>)
	# Switch to the directory where the root MAME makefile lives.		# Switch to the directory where the root MAME makefile lives.
	~~# Delete any object files from previous builds using gcc: <code>rd /s obj</code>~~		# Once you've done that, simply run: <code>make MSVC_BUILD=1 DEBUG=1 SYMBOLS=1</code> and wait for it to complete (I suggest building with DEBUG=1 as that also disables optimizations and makes debugging much easier).
	# Once you've done that, simply run: <code>~~mingw32-~~make MSVC_BUILD=1 DEBUG=1 SYMBOLS=1</code> and wait for it to complete (I suggest building with DEBUG=1 as that also disables optimizations and makes debugging much easier).
	~~#* (To build a 64-bit version, add <code>PTR64=1</code> to the end of your command line.)~~

	At this point, you should now have a mamed.exe that was built using Visual Studio tools. To debug it is very easy.		At this point, you should now have a mamed.exe that was built using Visual Studio tools. To debug it is very easy.
Line 19:		Line 16:
	# Open up Visual Studio.		# Open up Visual Studio.
	# From the File menu choose "Open Project..."		# From the File menu choose "Open Project..."
	# Select ~~mamed~~.exe (you may need to adjust the file filters to show .exe files).		# Select vmamed.exe (you may need to adjust the file filters to show .exe files).
	# To configure command line parameters, right click on the ~~mamed~~.exe item in the Solution Explorer window and choose "Properties". In that window you can specify the "Command Arguments" which would be the command line parameters you want.		# To configure command line parameters, right click on the vmamed.exe item in the Solution Explorer window and choose "Properties". In that window you can specify the "Command Arguments" which would be the command line parameters you want.
	# Set some breakpoints if you want, and hit "Go" (F5), or else single step into main by hitting "Step Into" (F11).		# Set some breakpoints if you want, and hit "Go" (F5), or else single step into main by hitting "Step Into" (F11).
	# When you're done, Visual Studio will ask if you want to save a solution file (.sln); I usually say "yes", because then it will remember your last session parameters for the next time you want to debug MAME, and the solution will show up in the recent projects list.		# When you're done, Visual Studio will ask if you want to save a solution file (.sln); I usually say "yes", because then it will remember your last session parameters for the next time you want to debug MAME, and the solution will show up in the recent projects list.

	Back to [[How MAME Works]]		Back to [[How MAME Works]]

Georg: fix link markup

2008-07-09T13:37:32Z

fix link markup

← Older revision		Revision as of 15:37, 9 July 2008
Line 5:		Line 5:
	Here's how to make it work:		Here's how to make it work:

	# You must already have an environment that can build MAME using the MinGW tools. Although you won't be using gcc to compile, you will be using several of the other tools included in the standard MAME [[http://mamedev.org/tools/ MinGW Development Environment]]		# You must already have an environment that can build MAME using the MinGW tools. Although you won't be using gcc to compile, you will be using several of the other tools included in the standard MAME [http://mamedev.org/tools/ MinGW Development Environment]
	# From the command prompt, you need to run the batch file that was installed with Visual Studio which configures the executable, include, and library paths.		# From the command prompt, you need to run the batch file that was installed with Visual Studio which configures the executable, include, and library paths.
	#* For Visual Studio .NET 2003, the command is: (can't remember)		#* For Visual Studio .NET 2003, the command is: (can't remember)

Aaron at 06:13, 14 April 2007

2007-04-14T06:13:07Z

← Older revision		Revision as of 08:13, 14 April 2007
Line 13:		Line 13:
	# Delete any object files from previous builds using gcc: <code>rd /s obj</code>		# Delete any object files from previous builds using gcc: <code>rd /s obj</code>
	# Once you've done that, simply run: <code>mingw32-make MSVC_BUILD=1 DEBUG=1 SYMBOLS=1</code> and wait for it to complete (I suggest building with DEBUG=1 as that also disables optimizations and makes debugging much easier).		# Once you've done that, simply run: <code>mingw32-make MSVC_BUILD=1 DEBUG=1 SYMBOLS=1</code> and wait for it to complete (I suggest building with DEBUG=1 as that also disables optimizations and makes debugging much easier).
			#* (To build a 64-bit version, add <code>PTR64=1</code> to the end of your command line.)

	At this point, you should now have a mamed.exe that was built using Visual Studio tools. To debug it is very easy.		At this point, you should now have a mamed.exe that was built using Visual Studio tools. To debug it is very easy.

← Older revision		Revision as of 22:31, 2 December 2018
Line 3:		Line 3:
	Alternatively, you can configure MAME to build using Visual Studio. Once you have done that, you can debug problems in MAME using the Visual Studio debugger, which is a huge step up from gdb.		Alternatively, you can configure MAME to build using Visual Studio. Once you have done that, you can debug problems in MAME using the Visual Studio debugger, which is a huge step up from gdb.

	Since MAME uses modern C++ features, Visual Studio ~~2015 with Update 3~~ is required ~~(Update 3 adds minimal support for variable templates~~ used ~~by MAME)~~. If you don't have a paid license, [https://www.visualstudio.com/en-us/products/visual-studio-community-vs.aspx Visual Studio Community ~~2015~~] is available from Microsoft for free (but requires sign-in with a Microsoft account).		Since MAME uses modern C++ features, Visual Studio 2017 is required. MAME previously used Visual Studio 2015, but it has updated to the newer version as of August 2018. If you don't have a paid license, [https://www.visualstudio.com/en-us/products/visual-studio-community-vs.aspx Visual Studio Community 2017] is available from Microsoft for free (but requires sign-in with a Microsoft account).

			'''Additional Note on VS 2017 Versions''' - There is an issue compiling with certain versions of Visual Studio 2017. Currently it is advised to use Visual Studio 2017 version 15.7.6. Later versions will not compile successfully and Microsoft has said that this will not be fixed until version 16.X.X.

	Here's how to make it work:		Here's how to make it work:
Line 9:		Line 11:
	# You must already have an environment that can build MAME using the MinGW tools. Although you won't be using gcc to compile, you will be using several of the other tools included in the standard MAME [http://mamedev.org/tools/ MinGW Development Environment]		# You must already have an environment that can build MAME using the MinGW tools. Although you won't be using gcc to compile, you will be using several of the other tools included in the standard MAME [http://mamedev.org/tools/ MinGW Development Environment]
	# Switch to the directory where the root MAME makefile lives.		# Switch to the directory where the root MAME makefile lives.
	# Once you've done that, simply run: <code>make ~~vs2015~~ PYTHON_EXECUTABLE=c:/msys64/mingw64/bin/python.exe</code> and wait for it to create projects		# Once you've done that, simply run: <code>make vs2017 PYTHON_EXECUTABLE=c:/msys64/mingw64/bin/python.exe</code> and wait for it to create projects
	# In order not to specify PYTHON_EXECUTABLE all the time, just place it in system variables		# In order not to specify PYTHON_EXECUTABLE all the time, just place it in system variables
	# If you are building with XP compatibility enabled run <code>make ~~vs2015_xp~~</code>		# If you are building with XP compatibility enabled run <code>make vs2017_xp</code>
	# Browse to folder containing solution file and open it with Visual Studio		# Browse to folder containing solution file and open it with Visual Studio
	# Inside Visual Studio you can change to Debug/Release x86 or x64 builds		# Inside Visual Studio you can change to Debug/Release x86 or x64 builds
	# While doing development please note that you need to update LUA files in scripts folders in order to add new sources and regenerate projects		# While doing development please note that you need to update LUA files in scripts folders in order to add new sources and regenerate projects
	# Note that all parameters for partial compilation works so you can do <code>make SUBTARGET=tiny ~~vs2015~~</code> or <code>make ~~vs2015~~ SUBTARGET=drivername SOURCES=src\mame\drivers\drivername.cpp</code>		# Note that all parameters for partial compilation works so you can do <code>make SUBTARGET=tiny vs2017</code> or <code>make vs2017 SUBTARGET=drivername SOURCES=src\mame\drivers\drivername.cpp</code>
	Back to [[How MAME Works]]		Back to [[How MAME Works]]