Getting Started with the code

Getting Started with the code

Getting the code

The OpenMPT project is hosted on Sourceforge. The source code repository has recently been migrated from CVS to Subversion. Here's how to get the very latest source code:

• Download and install TortoiseSVN. TortoiseSVN integrates tightly into the explorer shell; the installation process will therefore requite a reboot.
• Create the directory in which you'd like to have the OpenMPT code, right click it, and select 'SVN Checkout...':
  

• Set the Repository URL to:

  https://modplug.svn.sourceforge.net/svnroot/modplug/trunk/OpenMPT

  then make sure revision is set to HEAD and click ok:
  

• You can login with anonymous access (TODO: screenshot of anonymous access)
• A bunch of files will start downloading. Within a few minutes, you'll have a your own copy of the code.

Compiling the code

• Pre-requisites:
• Visual Studio .NET 2003/2005/2008
• To build:
• Open mptrack/MPTRACK.sln Visual Studio, select the debug build, and build.
• Depending on the Visual Studio version and code version, code may not compile "out of the box". Possible problems and how to solve them:
• File dsound.h not found -> You may need Microsoft DirectX SDK
• On some code versions, Microsoft Platform SDK might be needed.
• Once installed, ensure the Platform SDK Lib and Include paths are at the top of the Lib and Include directory lists in Tools/Options/Projects/VC++ Directories (the Platform SDK installer might do this for you):

Submitting patches

If you have implemented something cool, use TortoiseSVN to 'Create Patch...' from your SVN checkout folder where your code is, and send the patch file to robin at soal dot org

Tips

Add anything useful about working with the code here.

• Subscribe to the Commit Mailing List to be notified of codebase changes
• Subscribe to the Development Mailing List to discuss development issues
• The VS project has 'edit & continue' enabled on the debug build. So you can set a breakpoint, hit it, change some code and continue - and your change will be taken into account, if possible. This is very useful for debugging and for exploring the code.
• A debug build will be noticeably slower than a release build. Use the debug build for initial testing, but if you get inspired and start composing something cool, it might be worth switching to a release build.
• At any point in time, right click a file or directory from your checked-out project in explorer and do 'SVN Update' to get the latest version from the server, or 'TortoiseSVN/diff...' to compare your version against the server version. You can also view the file history and lots of other cool stuff.
  
• Visual C++ 2005/2008 express edition doesn't include all the needed components to build OMPT; at least standard version of Visual Studio is needed.