#Filename Format

When downloading songs, lyrics, or cover images, NCMGET uses a filename format template to determine the output filename.

#Default Template

The default filename format is:

{name} - {artist}

This produces filenames like: 情绪缓冲区溢出 - 淘气的Roy.mp3

#Available Placeholders

#Sanitize Rules

Characters that are illegal in filenames are automatically replaced with _:

<>:"/\|?*

For example, a song named 情绪缓冲区溢出: 世界 would become 情绪缓冲区溢出_ 世界 in the filename.

#Custom Format Examples

#Artist first

ncmget song 3374579108 -f "{artist} - {name}"

Output: 淘气的Roy - 情绪缓冲区溢出.mp3

#Include album name

ncmget song 3374579108 -f "{album} - {name}"

Output: 情绪缓冲区溢出 - 情绪缓冲区溢出.mp3

#Organize by album directory

ncmget song 3374579108 -f "{album}/{name}"

Output: 情绪缓冲区溢出/情绪缓冲区溢出.mp3 (creates the 情绪缓冲区溢出 directory if needed)

#Include song ID

ncmget song 3374579108 -f "{id} {name}"

Output: 3374579108 情绪缓冲区溢出.mp3

#Simple name only

ncmget lrc 3374579108 -f "{name}"

Output: 情绪缓冲区溢出.lrc

#Usage with Commands

The -f, --format option is available on all download commands:

• song — Default: {name} - {artist}
• album — Default: {name} - {artist}
• playlist — Default: {name} - {artist}
• lrc — Default: {name} - {artist}
• pic — Default: {name} - {artist}

#Related

• song — Download songs
• album — Download albums
• playlist — Download playlists
• lrc — Download lyrics
• pic — Download cover images