Compiling MTASA - Revision history

Qaisjp: 2022 -> 2026

2026-01-03T23:17:49Z

2022 -> 2026

← Older revision		Revision as of 23:17, 3 January 2026
Line 13:		Line 13:
	Make sure you have the following software and SDKs installed:		Make sure you have the following software and SDKs installed:

	== Visual Studio ~~2022~~ ==		== Visual Studio 2026 ==
	[[File:Visual_Studio_Community.PNG\|right\|150px\|link=https://www.visualstudio.com/vs/]]		[[File:Visual_Studio_Community.PNG\|right\|150px\|link=https://www.visualstudio.com/vs/]]
	# Download and install '''[https://visualstudio.microsoft.com/vs/ Microsoft Visual Studio ~~2022~~]''' - make sure you get the Community Edition, that one is free.		# Download and install '''[https://visualstudio.microsoft.com/vs/ Microsoft Visual Studio 2026]''' - make sure you get the Community Edition, that one is free.
	# On the installation checklist, [[:File:VsFoundationClasses.png\|make sure you tick these 2 items]]:		# On the installation checklist, [[:File:VsFoundationClasses.png\|make sure you tick these 2 items]]:
	## ''Desktop development with C++''		## ''Desktop development with C++''
	## Optional component ''C++ MFC for latest ~~v143~~ build tools (x86 & x64)''		## Optional component ''C++ MFC for latest v145 build tools (x86 & x64)''

	If you've made a mistake, you can run the ''Visual Studio Installer'' app to modify your current installation. There is no need to uninstall and reinstall.		If you've made a mistake, you can run the ''Visual Studio Installer'' app to modify your current installation. There is no need to uninstall and reinstall.

Fernando187 at 13:51, 5 January 2025

2025-01-05T13:51:10Z

← Older revision		Revision as of 13:51, 5 January 2025
Line 5:		Line 5:
	= [[File:Dialog-warning.svg\|32px]] Prerequisites =		= [[File:Dialog-warning.svg\|32px]] Prerequisites =

	Compiling the Multi Theft Auto client is ~~only~~ supported on Windows 10. ~~Everything~~ also ~~works~~ on ~~Windows 11~~.		Compiling the Multi Theft Auto client & server is supported on Windows 10 and 11. On Linux, you can also compile the Multi Theft Auto server ([[Building MTASA Server on GNU Linux\|check this article]]).

	[[File:Emblem-important.svg\|24px]] '''Skipping any prerequisite steps will lead to unexpected build failures. Read the sections below carefully to understand the entire developer workflow.'''		[[File:Emblem-important.svg\|24px]] '''Skipping any prerequisite steps will lead to unexpected build failures. Read the sections below carefully to understand the entire developer workflow.'''

Fernando187: /* left|32px|link=https://git-scm.com/ Git Client */

2024-11-06T11:07:44Z

left|32px|link=https://git-scm.com/ Git Client

← Older revision		Revision as of 11:07, 6 November 2024
Line 34:		Line 34:
	==[[File:Git_logo.png\|left\|32px\|link=https://git-scm.com/]] Git Client==		==[[File:Git_logo.png\|left\|32px\|link=https://git-scm.com/]] Git Client==

	If you would like to contribute to MTA, you should use Git. This will allow you to collaborate with us by creating branches and pushing changes to GitHub.		If you would like to contribute to MTA, you should use Git. This will allow you to collaborate with us by creating branches and pushing changes to [https://github.com/multitheftauto/ GitHub].

	[[https://learn.microsoft.com/en-us/visualstudio/version-control/git-with-visual-studio '''Visual Studio''' comes with a Git client]] that you can use to manage your local repository. You should fork the mtasa-blue repository and clone on your machine.		[https://learn.microsoft.com/en-us/visualstudio/version-control/git-with-visual-studio '''Visual Studio''' comes with a Git client] that you can use to manage your local repository. You should fork the [https://github.com/multitheftauto/mtasa-blue mtasa-blue repository] and clone on your machine.

	If you only want to compile the source code and are not interested in contributing to MTA, you can download the source directly (see below).		If you only want to compile the source code and are not interested in contributing to MTA, you can download the source directly (see below).

Fernando187: /* left|32px|link=https://git-scm.com/ Git Client */

2024-11-06T11:06:35Z

left|32px|link=https://git-scm.com/ Git Client

← Older revision		Revision as of 11:06, 6 November 2024
Line 34:		Line 34:
	==[[File:Git_logo.png\|left\|32px\|link=https://git-scm.com/]] Git Client==		==[[File:Git_logo.png\|left\|32px\|link=https://git-scm.com/]] Git Client==

	If you would like to contribute to MTA, you should ~~install~~ Git. This will allow you to collaborate with us by creating branches and pushing to ~~your own fork~~. ~~If you are not comfortable with the command line, we recommend you to download and install~~ [https://~~desktop~~.~~github~~.com/ ~~GitHub Desktop~~].		If you would like to contribute to MTA, you should use Git. This will allow you to collaborate with us by creating branches and pushing changes to GitHub.

			[[https://learn.microsoft.com/en-us/visualstudio/version-control/git-with-visual-studio '''Visual Studio''' comes with a Git client]] that you can use to manage your local repository. You should fork the mtasa-blue repository and clone on your machine.

	If you only want to compile the source code and are not interested in contributing to MTA, you can download the source directly (see below).		If you only want to compile the source code and are not interested in contributing to MTA, you can download the source directly (see below).

Fernando187 at 08:59, 6 November 2024

2024-11-06T08:59:46Z

← Older revision		Revision as of 08:59, 6 November 2024
Line 109:		Line 109:

	==Cannot open include file 'afxres.h'==		==Cannot open include file 'afxres.h'==
	This error is caused by your Visual Studio ~~set up~~. Use the Visual Studio Installer to enable Optional component ''C++ MFC for latest v143 build tools (x86 & x64)''.		This error is caused by your incomplete Visual Studio configuration. Use the Visual Studio Installer to enable Optional component ''C++ MFC for latest v143 build tools (x86 & x64)''.

	==Cant find d3dx9.h==		==Cant find d3dx9.h==

Fernando187 at 15:07, 5 November 2024

2024-11-05T15:07:16Z

← Older revision		Revision as of 15:07, 5 November 2024
Line 19:		Line 19:
	## ''Desktop development with C++''		## ''Desktop development with C++''
	## Optional component ''C++ MFC for latest v143 build tools (x86 & x64)''		## Optional component ''C++ MFC for latest v143 build tools (x86 & x64)''

	~~If you don't enable MFC, you will get the following error: <code>cannot open include file 'afxres.h'</code>.~~

	If you've made a mistake, you can run the ''Visual Studio Installer'' app to modify your current installation. There is no need to uninstall and reinstall.		If you've made a mistake, you can run the ''Visual Studio Installer'' app to modify your current installation. There is no need to uninstall and reinstall.
Line 109:		Line 107:

	= Error Troubleshooting =		= Error Troubleshooting =

			==Cannot open include file 'afxres.h'==
			This error is caused by your Visual Studio set up. Use the Visual Studio Installer to enable Optional component ''C++ MFC for latest v143 build tools (x86 & x64)''.

	==Cant find d3dx9.h==		==Cant find d3dx9.h==
	Add the '''$(DXSDK_DIR)Include;''' to the VC++ Directories in DirectX9GuiRenderer, GUI and Client Core projects.		Add the '''$(DXSDK_DIR)Include;''' to the VC++ Directories in DirectX9GuiRenderer, GUI and Client Core projects.

Fernando187 at 15:05, 5 November 2024

2024-11-05T15:05:25Z

← Older revision		Revision as of 15:05, 5 November 2024
Line 15:		Line 15:
	== Visual Studio 2022 ==		== Visual Studio 2022 ==
	[[File:Visual_Studio_Community.PNG\|right\|150px\|link=https://www.visualstudio.com/vs/]]		[[File:Visual_Studio_Community.PNG\|right\|150px\|link=https://www.visualstudio.com/vs/]]
	# '''[https://visualstudio.microsoft.com/vs/ ~~Download~~ Microsoft Visual Studio 2022]''' - make sure you get the Community Edition, that one is free.		# Download and install '''[https://visualstudio.microsoft.com/vs/ Microsoft Visual Studio 2022]''' - make sure you get the Community Edition, that one is free.
	# On the installation checklist, [[:File:VsFoundationClasses.png\|make sure you tick these 2 items]]:		# On the installation checklist, [[:File:VsFoundationClasses.png\|make sure you tick these 2 items]]:
	## ''Desktop development with C++''		## ''Desktop development with C++''

Fernando187 at 15:04, 5 November 2024

2024-11-05T15:04:48Z

← Older revision		Revision as of 15:04, 5 November 2024
Line 27:		Line 27:
	[[File:DirectX_SDK.jpg\|right\|150px\|link=http://web.archive.org/web/20200804044856/https://www.microsoft.com/en-us/download/details.aspx?id=23549]]		[[File:DirectX_SDK.jpg\|right\|150px\|link=http://web.archive.org/web/20200804044856/https://www.microsoft.com/en-us/download/details.aspx?id=23549]]
	'''Download and install Microsoft DirectX SDK (August 2009) (DXSDK_Aug09.exe):'''		'''Download and install Microsoft DirectX SDK (August 2009) (DXSDK_Aug09.exe):'''
	* [https://archive.org/download/dxsdk_aug09/DXSDK_Aug09.exe Mirror 1]		* [https://archive.org/download/dxsdk_aug09/DXSDK_Aug09.exe Mirror 1 (archive.org)]
	* [https://mega.nz/file/pQJCiAJY#jBcYT6ZP4DMBpnm12BLRto9EQ-RjjpP3BWkSPanpvLI Mirror 2]		* [https://mega.nz/file/pQJCiAJY#jBcYT6ZP4DMBpnm12BLRto9EQ-RjjpP3BWkSPanpvLI Mirror 2 (mega.nz)]

	Restart your computer after installing ''Microsoft DirectX SDK'', because otherwise the environment variable '''DXSDK_DIR''' won't be available yet. After restarting it re-run '''create-projects.bat'''		Restart your computer after installing ''Microsoft DirectX SDK'', because otherwise the environment variable '''DXSDK_DIR''' won't be available yet. After restarting it re-run '''create-projects.bat'''

Fernando187 at 15:02, 5 November 2024

2024-11-05T15:02:42Z

← Older revision		Revision as of 15:02, 5 November 2024
Line 81:		Line 81:
	You can also run the debug build ''MTA Server_d.exe'' with the Visual Studio Debugger (as of writing, you can do that by right-clicking on the Server's Launcher project and selecting ''Start a local instance'' in the ''Debugger'' menu), but you can also attach to a running debug build MTA server (see more in the section Debugging below).		You can also run the debug build ''MTA Server_d.exe'' with the Visual Studio Debugger (as of writing, you can do that by right-clicking on the Server's Launcher project and selecting ''Start a local instance'' in the ''Debugger'' menu), but you can also attach to a running debug build MTA server (see more in the section Debugging below).

	= Debugging =		= [[File:Preferences-system.svg\|32px]] Debugging =
	If you already compiled the code in the '''Debug''' configuration then continue reading, if not, then go up to ''Compiling the code'' and follow the steps for a ''Debug'' build.<br>		If you already compiled the code in the '''Debug''' configuration then continue reading, if not, then go up to ''Compiling the code'' and follow the steps for a ''Debug'' build.<br>
	To compile in '''Release''', click on the '''Debug''' list and switch to '''Release'''.<br>		To compile in '''Release''', click on the '''Debug''' list and switch to '''Release'''.<br>
Line 102:		Line 102:
	[[File:ReAttach_to_GTASA.PNG]]		[[File:ReAttach_to_GTASA.PNG]]

	= Getting involved =		= [[File:System-users.svg\|32px]] Getting involved =
	Please see our [[Coding guidelines]] for information on the coding practice.		Please see our [[Coding guidelines]] for information on the coding practice.

	= Additional information =		= [[File:Mail-reply-all.svg\|32px]] Additional information =
	If you need more information, try our [https://github.com/multitheftauto/mtasa-blue/issues bug tracker] or [https://discord.com/invite/mtasa Discord].		If you need more information, try our [https://github.com/multitheftauto/mtasa-blue/issues bug tracker] or [https://discord.com/invite/mtasa Discord].

Fernando187: fix links

2024-11-05T15:00:40Z

fix links

← Older revision		Revision as of 15:00, 5 November 2024
Line 3:		Line 3:
	Please read the instructions carefully and do not skip parts of it, if you have no experience.		Please read the instructions carefully and do not skip parts of it, if you have no experience.

	== [[File:Dialog-warning.svg\|32px]] Prerequisites ==		= [[File:Dialog-warning.svg\|32px]] Prerequisites =

	Compiling the Multi Theft Auto client is only supported on Windows 10. Everything also works on Windows 11.		Compiling the Multi Theft Auto client is only supported on Windows 10. Everything also works on Windows 11.
Line 13:		Line 13:
	Make sure you have the following software and SDKs installed:		Make sure you have the following software and SDKs installed:

	=== Visual Studio 2022 ===		== Visual Studio 2022 ==
	[[File:Visual_Studio_Community.PNG\|right\|150px\|link=https://www.visualstudio.com/vs/]]		[[File:Visual_Studio_Community.PNG\|right\|150px\|link=https://www.visualstudio.com/vs/]]
	# '''[https://visualstudio.microsoft.com/vs/ Download Microsoft Visual Studio 2022]''' - make sure you get the Community Edition, that one is free.		# '''[https://visualstudio.microsoft.com/vs/ Download Microsoft Visual Studio 2022]''' - make sure you get the Community Edition, that one is free.
Line 24:		Line 24:
	If you've made a mistake, you can run the ''Visual Studio Installer'' app to modify your current installation. There is no need to uninstall and reinstall.		If you've made a mistake, you can run the ''Visual Studio Installer'' app to modify your current installation. There is no need to uninstall and reinstall.

	=== Microsoft DirectX SDK ===		== Microsoft DirectX SDK ==
	[[File:DirectX_SDK.jpg\|right\|150px\|link=http://web.archive.org/web/20200804044856/https://www.microsoft.com/en-us/download/details.aspx?id=23549]]		[[File:DirectX_SDK.jpg\|right\|150px\|link=http://web.archive.org/web/20200804044856/https://www.microsoft.com/en-us/download/details.aspx?id=23549]]
	'''Download and install Microsoft DirectX SDK (August 2009) (DXSDK_Aug09.exe):'''		'''Download and install Microsoft DirectX SDK (August 2009) (DXSDK_Aug09.exe):'''
Line 34:		Line 34:
	See [[Compiling_MTASA/DXSDK_Aug09_Hashes\|DXSDK Aug09 Hashes]] for file hashes of the installer.		See [[Compiling_MTASA/DXSDK_Aug09_Hashes\|DXSDK Aug09 Hashes]] for file hashes of the installer.

	=== [[File:Git_logo.png\|left\|32px\|link=https://git-scm.com/]] Git Client ===		==[[File:Git_logo.png\|left\|32px\|link=https://git-scm.com/]] Git Client==

	If you would like to contribute to MTA, you should install Git. This will allow you to collaborate with us by creating branches and pushing to your own fork. If you are not comfortable with the command line, we recommend you to download and install [https://desktop.github.com/ GitHub Desktop].		If you would like to contribute to MTA, you should install Git. This will allow you to collaborate with us by creating branches and pushing to your own fork. If you are not comfortable with the command line, we recommend you to download and install [https://desktop.github.com/ GitHub Desktop].
Line 40:		Line 40:
	If you only want to compile the source code and are not interested in contributing to MTA, you can download the source directly (see below).		If you only want to compile the source code and are not interested in contributing to MTA, you can download the source directly (see below).

	== Getting the latest source code ==		=[[File:Document-save.svg\|32px]] Getting the latest source code=

	To get the latest code, you will have to download the latest copy of our Git repository.<br>		To get the latest code, you will have to download the latest copy of our Git repository.<br>
Line 49:		Line 49:
	* '''.tar.gz:''' [https://github.com/multitheftauto/mtasa-blue/archive/master.tar.gz master.tar.gz]		* '''.tar.gz:''' [https://github.com/multitheftauto/mtasa-blue/archive/master.tar.gz master.tar.gz]

	== [[File:Media-floppy.svg\|32px]] Compiling the code ==		=[[File:Media-floppy.svg\|32px]] Compiling the code=

	Follow these steps to successfully build the '''mtasa-blue''' project.		Follow these steps to successfully build the '''mtasa-blue''' project.
Line 59:		Line 59:
	# Finally, execute the script '''win-install-data.bat'''. This copies important files to the Bin directory that are required for MTA to function. It gives you the option to '''Install the official resources''', which you can read about in the [[#Running the dedicated server]] section below.		# Finally, execute the script '''win-install-data.bat'''. This copies important files to the Bin directory that are required for MTA to function. It gives you the option to '''Install the official resources''', which you can read about in the [[#Running the dedicated server]] section below.

	= [[File:Input-gaming.svg\|40px]] Running the software =		=[[File:Input-gaming.svg\|40px]] Running the software=

	This section contains information on how to run the Multi Theft Auto client and server separately.		This section contains information on how to run the Multi Theft Auto client and server separately.
Line 81:		Line 81:
	You can also run the debug build ''MTA Server_d.exe'' with the Visual Studio Debugger (as of writing, you can do that by right-clicking on the Server's Launcher project and selecting ''Start a local instance'' in the ''Debugger'' menu), but you can also attach to a running debug build MTA server (see more in the section Debugging below).		You can also run the debug build ''MTA Server_d.exe'' with the Visual Studio Debugger (as of writing, you can do that by right-clicking on the Server's Launcher project and selecting ''Start a local instance'' in the ''Debugger'' menu), but you can also attach to a running debug build MTA server (see more in the section Debugging below).

	== Debugging ==		= Debugging =
	If you already compiled the code in the '''Debug''' configuration then continue reading, if not, then go up to ''Compiling the code'' and follow the steps for a ''Debug'' build.<br>		If you already compiled the code in the '''Debug''' configuration then continue reading, if not, then go up to ''Compiling the code'' and follow the steps for a ''Debug'' build.<br>
	To compile in '''Release''', click on the '''Debug''' list and switch to '''Release'''.<br>		To compile in '''Release''', click on the '''Debug''' list and switch to '''Release'''.<br>
Line 87:		Line 87:
	[[File:Local_Windows_Debugger.PNG]]		[[File:Local_Windows_Debugger.PNG]]

	=== How to enable breakpoints ===		== How to enable breakpoints ==
	If you choose to run MTA with Visual Studio then you should also attach the debugger to the executable '''gta_sa.exe''' (press ''CTRL + ALT + P'' in Visual Studio) - otherwise, your		If you choose to run MTA with Visual Studio then you should also attach the debugger to the executable '''gta_sa.exe''' (press ''CTRL + ALT + P'' in Visual Studio) - otherwise, your
	breakpoints will not work for anything besides the MTA Launcher project.<br>		breakpoints will not work for anything besides the MTA Launcher project.<br>
	[[File:Attach_to_Process.png\|600px]]		[[File:Attach_to_Process.png\|600px]]

	=== Extending timeout duration ===		== Extending timeout duration ==
	When you use breakpoints during debugging, you may get kicked by the server due to timeout, because the client is frozen. To prevent this, create the '''timeout.longtime''' file in your ''Bin/server/'' directory.		When you use breakpoints during debugging, you may get kicked by the server due to timeout, because the client is frozen. To prevent this, create the '''timeout.longtime''' file in your ''Bin/server/'' directory.
	The content of the file is the new timeout duration in seconds<!--		The content of the file is the new timeout duration in seconds<!--
Line 98:		Line 98:
	-->, so make sure you type a huge number in there. If you keep the file empty, the timeout will be set to 120 seconds.		-->, so make sure you type a huge number in there. If you keep the file empty, the timeout will be set to 120 seconds.

	=== ReAttach for Visual Studio ===		== ReAttach for Visual Studio ==
	You can use [https://marketplace.visualstudio.com/items?itemName=ErlandR.ReAttach ReAttach] to re-attach the debugger to the '''gta_sa.exe''' executable whenever you start your local debugger in Visual Studio.<br>		You can use [https://marketplace.visualstudio.com/items?itemName=ErlandR.ReAttach ReAttach] to re-attach the debugger to the '''gta_sa.exe''' executable whenever you start your local debugger in Visual Studio.<br>
	[[File:ReAttach_to_GTASA.PNG]]		[[File:ReAttach_to_GTASA.PNG]]