Difference between revisions of "Compiling MTASA"

From Multi Theft Auto: Wiki
m (Update for VS2017)
Line 13: Line 13:
[https://www.visualstudio.com/vs/ Microsoft Visual Studio 2017] (Community Edition is free).<br>
[https://www.visualstudio.com/vs/ Microsoft Visual Studio 2017] (Community Edition is free).<br>
(Make sure you [[Media:Vs2015_foundationClasses.png|select ''Microsoft Foundation Classes for C++'']] during installation.)<br>
'''Addon: EditorConfig''' ('''WARNING:''' incompatible with VS2017, optional)<br>
'''Addon: EditorConfig''' ('''WARNING:''' incompatible with VS2017, optional)<br>

Revision as of 19:15, 21 May 2017

In order to successfully build Multi Theft Auto from source, it is necessary to perform a number of steps, which we will explain below.

Please read the instructions carefully and do not skip parts of it, if you have no experience.


You should be using Windows 7 or above, before you can compile the Multi Theft Auto client.

Make sure you have the following software and SDKs installed:

Visual Studio 2017

Visual Studio Community.PNG

Microsoft Visual Studio 2017 (Community Edition is free).
(Make sure you select Microsoft Foundation Classes for C++ during installation.)

Addon: EditorConfig (WARNING: incompatible with VS2017, optional)
Download: EditorConfig
(Install this addon to automatically set up your IDE for the correct code formatting)

Addon: ReAttach (optional)
Download: ReAttach
(ReAttach gives you an easy way to re-attach your prior debug targets)

Missing #include "afxres.h"
Make sure you have Microsoft Foundation Classes for C++ installed.
(You can re-run the installer to modify your current installation, no need to uninstall and reinstall)

Microsoft DirectX SDK

DirectX SDK.jpg

Microsoft DirectX SDK (August 2009)

S1023 Error
"S1023" error when you install the DirectX SDK (June 2010)

Git Client

Git logo.png

You have three options here available. You can install ONE of the clients below (for collaboration) or download the entire codebase in a .ZIP file (if you only want to compile the code). You can also use Git on the command line to checkout the respository.

GitHub Desktop

GitHub Desktop.png

GitHub for Windows


Atlassian SourceTree.png



GitKraken Logo.png


Getting the latest source code

To get the latest code, you will have to download the latest copy of our Git repository.
We recommend cloning the repository in your Git client, because you can pull any updates from there easily.

Compiling the code

  1. Execute the script win-create-projects.bat
  2. Open the solution file MTASA.sln in the Build directory
  3. Compile in Visual Studio with Debug configuration (may take some minutes)
  4. Execute the script win-install-data.bat

Running the software

Running the client

You can start your client in the Bin directory. You might find there a Multi Theft Auto.exe and/or Multi Theft Auto_d.exe executable. The _d suffix indicates a debug build of the software.
Furthermore, you can also run your client inside the debugger from Visual Studio if you want to investigate a stack trace or set breakpoints in interesting code regions (read more in the section Debugging below).

Running the dedicated server

If you already have run the step 5 (Install resources) in Compiling the code to install resources then you can goto Starting the server.

Installing the latest resources

If you want to run the Multi Theft Auto dedicated server, you will have to install the required resources. These are required because they implement the most basic functionality (e.g. spawning players) in order to play.

Our official resources repository is hosted on GitHub. You can download the latest resources from there or download a zipped version. Make sure that you have the latest resources package.

Starting the server

To run the server, open the MTA Server.exe executable in the Bin/server directory. The _d suffix indicates a debug build of the software.
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).


If you already compiled the code in the Debug configuration then continue reading, if not, then go up to Compilling the code and follow the steps for a Debug build.
You can either launch MTA yourself and attach any debugger you want to use (also applies to the Visual Studio debugger) or you start a local debugging session in Visual Studio.
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 beside the MTA Launcher project.
Furthermore, it is advisable to create an empty "timeout.longtime" file in your Bin/server/ directory
This will extend the time before players are kicked from your server for unresponsiveness to 120 seconds. This is useful when in Debug mode on the client and the process is halted.

Local Windows Debugger.PNG

Attach to Process.png

ReAttach to GTASA.PNG

You can use ReAttach to re-attach the debugger to the gta_sa.exe executable whenever you start your local debugger in Visual Studio.

Getting involved

Please see our Coding guidelines for information on coding practice.

Additional information

If you need more information, try our bug tracker or IRC channel.