🎹 NodMOD

NodMOD is a Python library for manipulating MOD / XM files produced with the music trackers of yore.

The library simplifies core operations, abstracting away from the intricacies of the MOD format.

• Load and save MOD / XM files
• Create, edit, duplicate, and delete patterns
• Load WAV samples with automatic bitrate conversion
• Full editing, down to the individual notes and effects
• Render the song as WAV

You can find thousands of open-source songs at The Mod Archive or Amiga Music Preservation, among others.

Suggested players are XMPlay (Windows), Qmmp (Linux), MilkyTracker (MacOS).

Installation

git clone https://github.com/erodola/nodmod.git
cd nodmod
uv venv
uv pip install -e .

Verify with:

source .venv/bin/activate  # macOS/Linux
# OR
.venv\Scripts\activate     # Windows

python -c "import nodmod; print('nodmod installed successfully!')"

Quick Start

from nodmod import MODSong

song = MODSong()
song.load("music/spice_it_up.mod")

# MOD channels are 0-based (0-3)
song.mute_channel(2)
song.mute_channel(3)

song.save("music/ch1_2.mod")

from nodmod import XMSong
from nodmod.types import XMSample

song = XMSong()
song.n_channels = 4
song.add_pattern(64)

inst = song.new_instrument("Lead")
smp = XMSample()
import array

smp.waveform = array.array('b', [0, 10, -10, 0])
song.add_sample(inst, smp)
song.set_sample_map_all(inst, 1)

song.set_note(0, 0, 0, inst, "C-4", "")
song.set_sample_panning(inst, 1, 192)

song.save("music/lead.xm")

Requirements

• Python 3.11+
• Pydub 0.25.1+
• (optional) ffmpeg with the --enable-libopenmpt configuration is required to render MOD files as WAV.

How you can help

We seek to expand the library in several ways:

• Add support for other formats: IT, S3M, MED, etc.
• More advanced functions for composing music
• Build a script language
• Improve usability

Contributions are welcome through dm or pull requests.

License

MIT License - see LICENSE file for details.