Rules, Tools, and Formats
=========================

Mmxcode relies at its core on formats, tools, and rules, each of which are configured with JSON format configuration files int he /conf directory.

  * Formats are file formats, which have a name and an extension.
  * Tools are installed encoders and decoders, which operate on the various Formats
  * Rules are the things that specify how files are moved to the mirror

When using the tool, you must first make sure the tools are configured as you need.  You can run the testformats command to see which tools are set up:

  mmxcode testformats

You only need to have tools configured for the formats you are going to oeprate on in your rules.  If for example all you are doing is transcoding flac to mp3, you'd just need flac and lame.  Edit the tools.json file appropriately for your system.

Once the tools are in place, you can set up your Rules by editing rules.json.  The rules should be self-explanatory, the actions available to you are COPY or TRANSCODE.

By configuring the rules.json file, you can create any kind of mirroring/transcoding behavior you'd like.
 

Running the Tool
================

Let's say you have the directory /Users/will/music/all, and you want to create a directory /Users/will/music/mirrored full of copied or transcoded files.

Run the tool like this:
 
  mmxcode.sh /Users/will/music/all /Users/will/music/mirrored

You can run the tool with no arguments to get help.


Configuration Details
=====================

  * platform names are "win" and "osx"
  

Other Common Tasks
==================

TBD operating on single dirs