Read Me

libdmftest v0.0 (2007-12-06)


**********
 Overview
**********

libdmftest is a library for playing back DMF modules.  The DMF format was
created by D-Lusion in the mid-1990s to save songs written in X-Tracker.
It was one of the less popular PC tracker formats, but it did gain some
following in Germany for a year or two.

If you don't know what the preceding paragraph means, libdmftest probably
isn't for you. :)

This isn't really a readme, but more of a quick guide to the different
subprojects within libdmftest.  Here's what's available:
 * foo_input_dmftest = A libdmftest plugin for foobar2000.
 * libdmftest = The library itself.  See docs/readme.txt for information
     on how to use libdmftest in your application.
 * test_app = A very simple application demonstrating how to use libdmftest.
     Can be used for playing back DMF files if you're in a pinch.

Also, there is a top-level Visual Studio solution for building test_app.
If you're having trouble working libdmftest into your own solution, you can
use this as a reference.


**************
 Requirements
**************

Visual Studio 2005 or newer is required to open the projects and solution.
If you're on a Windows platform, you can obtain a free version of Visual
Studio (called "Visual Studio Express") from microsoft.com.  You will be
required to get a Passport account and register it if you would like to use
it for more than 30 days, but it should be serviceable in the meantime.

Currently, there is no official support for non-Windows platforms.  There
is no makefile available and there are no plugins for non-Windows media
players.  That said, libdmftest itself is written entirely in C++ and has
only a few standard library includes, so it should be possible to compile
it on most any platform.  If you'd like to use libdmftest on a different
platform and you don't feel like waiting for an official makefile to be
provided, just compile and link all of the .cpp files in the libdmftest
directory.  Take a look at libdmftest/src/config.h while you're at it.


*******
 Links
*******

http://libdmftest.sourceforge.net
 - Official project page

http://d-lusion.com
 - Web site for D-Lusion, the creators of X-Tracker and the DMF format.
   They have a brief writeup on X-Tracker there.

http://rr.rockz.org
 - Archive for Radical Rhythms, the highest-profile demoscene group to
   use the DMF format extensively.  You can find a number of DMFs here
   if you browse through the earlier years.  As a disclaimer, I am not
   responsible for this site or any of its content (and I know you'll
   probably find something offensive there if you look hard enough).

ftp://ftp.modland.com/pub
 - The most extensive module archive I have ever come accross.  If you
   browse into modules/X-Tracker, you'll find most of the DMFs from the
   Radical Rhythms archive and a lot more.  The same content disclaimer
   applies to this site.


*******
 Legal
*******

All libdmftest-related code is provided under a BSD-style license.
See license.txt for details.