[OMPT-svn-commit] SF.net SVN: modplug:[866] trunk/OpenMPT

[<sag...@us...>]

Revision: 866
          http://modplug.svn.sourceforge.net/modplug/?rev=866&view=rev
Author:   saga-games
Date:     2011-05-08 19:43:27 +0000 (Sun, 08 May 2011)

Log Message:
-----------
Added helpful documents to repo

Added Paths:
-----------
    trunk/OpenMPT/README
    trunk/OpenMPT/TODO

Added: trunk/OpenMPT/README
===================================================================
--- trunk/OpenMPT/README	                        (rev 0)
+++ trunk/OpenMPT/README	2011-05-08 19:43:27 UTC (rev 866)
@@ -0,0 +1,42 @@
+How to compile the code:
+
+- Visual Studio 2003/2005/2008/2010 is required. Express versions won't work as
+  they don't include MFC.
+- The VST 2.4 and ASIO SDKs are needed for compiling with VST and ASIO support.
+  If you don't want this, uncomment #define NO_VST and #define NO_ASIO in the
+  file StdAfx.h. If you need further help with the VST and ASIO SDKs, get in
+  touch with the main developers.
+- You need the DirectX SDK to enable DirectSound output. If you don't want this,
+  uncomment #define NO_DSOUND in the file StdAfx.h.
+
+
+
+Coding conventions (see below for an example):
+
+* Functions / methods are "underlined".
+* Place curly braces at the beginning of the line, not at the end
+* Generally make use of the custom index types like SAMPLEINDEX or ORDERINDEX
+  when referring to samples, orders, etc.
+* When changing playback behaviour, make sure that you use the function
+* CSoundFile::IsCompatibleMode() so that modules made with previous versions of
+  MPT still sound correct (if the change is extremely small, this might be
+  unnecessary)
+* When checking the module type, use something like
+    if(GetType() & MOD_TYPE_XXX)
+  instead of
+    if(GetType() == MOD_TYPE_XXX)
+  as it could be theoretically possible that two mod types are set (currently
+  this doesn't happen, but in the future this might actually be used as a code
+  feature :)
+
+Code example:
+
+void foo::bar(int foobar)
+//-----------------------
+{
+    while(true)
+    {
+        // some code
+    }
+}
+

Added: trunk/OpenMPT/TODO
===================================================================
--- trunk/OpenMPT/TODO	                        (rev 0)
+++ trunk/OpenMPT/TODO	2011-05-08 19:43:27 UTC (rev 866)
@@ -0,0 +1,17 @@
+Of course there is still something that can be improved in OpenMPT, but there
+are some things which definitely should be done at some point. Those include:
+
+* Getting rid of the buggy MFC code. Instead use something like Qt.
+* While we're at it, make OpenMPT cross-platform. :)
+* Developement of a proper MPTM format. Currently, it's just based on the
+  Impulse Tracker format and new features are hacked on at the end of the file.
+  Not very nice!
+* Better VST support. Currently, many great VST 2.4 features like busses are not
+  supported.
+
+
+Some things that could also be implemented:
+
+* Resizable channels with multiple effect columns. This might not be trivial at
+  all, especially when dealing with effects which could interfer with each other
+  (f.e. porta up in one column, porta down in another).
\ No newline at end of file


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.