Development: Compiling the code

2013-09-18T20:27:58Z

Enkore: portmidi is in VCS since .. git blame: manxorist 2013-09-06

If you want to get involved with OpenMPT development, or just want to compile your own version of the tracker, here are some hints on how to get started.

== Prerequisites ==

* Visual Studio 2008 SP1 or 2010 (at least Standard version is required; Express will not work)
* ''Optional'' [http://tortoisesvn.net/downloads.html TortoiseSVN] or any other SVN client. You will need this to get the latest code revision via the [http://en.wikipedia.org/wiki/Apache_Subversion SVN] system. The description below is written for TortoiseSVN. You can also download a code snapshot if you do not want to install a SVN client (see below).

== Getting the code ==

'''Using TortoiseSVN:''' First, you have to create a directory on your hard drive in which you want to place the source code. Right-click on the directory and choose the context menu entry “SVN Checkout...”. The “Repository URL” to fill in is <code><nowiki>http://svn.code.sf.net/p/modplug/code/trunk/OpenMPT/</nowiki></code>. After clicking the OK button, all files will be downloaded.

'''- or -'''

'''Tarball:''' If you do not want to use a SVN client, simply get the GNU tarball from [https://sourceforge.net/p/modplug/code/ SourceForge] - navigate to the folder <code>trunk/OpenMPT</code>, click the “Download Snapshot” link and extract the tarball somewhere.

Once you have checked out, you can always right-click on the directory and choose “SVN Update...” to get the most recent revision of the code. This will of course not work with the tarball method, you will have to download a new tarball after every commit in that case.

To compile OpenMPT with ASIO and VST support, you will have to get the respective SDKs from the [http://www.steinberg.net/en/company/developer.html Steinberg website]. You will have to register at their site to be able to download the files.

* VST 2.4: Copy the <code>vstsdk2.4</code> folder into the <code>include</code> directory of OpenMPT.
* ASIO: Copy the <code>ASIOSDK2</code> folder into the <code>include</code> directory of OpenMPT.

== Compiling the code ==

To compile the code, you will need Visual Studio .NET 2008 / 2010.

Open the file <code>mptrack/MPTRACK_08.sln</code> (VS2008) or mptrack/MPTRACK_10.sln (VS2010) in Visual Studio and click on the menu item <code>Build</code>→<code>Build solution</code> to compile the code. Note that this process may take quite a while!

Depending on the version of Visual Studio used, the code might not compile out of the box. Some known reasons for that are:

* You forgot to download the VST 2.4 and ASIO SDKs. Read the previous section to find out which files you need. Alternatively, if you do not want to compile OpenMPT with VST and ASIO support, you can define the constants <code>NO_VST</code> and <code>NO_ASIO</code> in the file <code>common/BuildSettings.h</code> (appropriate <code>#define</code> statements are already present but commented out).
* File dsound.h not found: You need the DirectX SDK. Alternatively, you can define the constant <code>NO_DSOUND</code> in the file <code>common/BuildSettings.h</code> (an appropriate <code>#define</code> is already present but commented out). '''Installing this before installing Visual Studio''' could spare you some work with setting up the paths. If that is not possible anymore, go to <code>Tools</code>→<code>Options</code> in Visual Studio and then <code>Projects</code>→<code>VC++ Directories</code> and add the required paths. Apparently, this is already installed with VS2010, depending on what components you install.

== Staying up to date ==

If you want to be notified of new code commits, you can subscribe to the SVN mailing list at https://lists.sourceforge.net/lists/listinfo/modplug-svn-commit.

[[Category:Development|Compiling the code]]

OpenMPT Wiki - User contributions [en]

Development: Compiling the code