xdccJS is a complete implementation of the XDCC protocol for nodejs.
It can also be used as a command-line downloader !

• Batch downloads : 1-3, 5, 32-35, 101
• Resume file and auto-retry
• Pipes!
• Passive DCC
• Check advanced examples and see what else you can do

• API
  • Import and Require
  • Configuration
  • Download
    • jobs
    • events
    • use pipes
  • (Auto) disconnect from IRC
• CLI
  • Installation
  • Options
  • Download
  • Profiles
  • Important notes

const XDCC = require('xdccjs').default
// or
import XDCC from 'xdccjs'

Minimal configuration :

let opts = {
  host: 'irc.server.net', // will use default port 6667
  path: '/my/download/folder' // absolute and relative paths both work
}

const xdccJS = new XDCC(opts)

Advanced configuration : Except for host every parameter is optional, but you can also define a set of options to your preference :

const opts = {
  host: 'irc.server.net', // IRC hostname                                                   - required
  port: 6660, // IRC port                                                                   - default: 6667
  nickname: 'ItsMeJiPaix', // Nickname                                                          - default: xdccJS + random
  chan: ['#candy', '#fruits'], // Array of channels                                         - default : [ ]
  path: 'downloads', // Download path or 'false'                                            - default: false (which enables piping)
  retry: 2, // Nb of retries before skip                                                    - default: 1
  timeout: 50, // Nb of seconds before a download is considered timed out                   - default: 30
  verbose: true, // Display download progress and jobs status                               - default: false
  randomizeNick: false, // Add random numbers at end of nickname                            - default: true
  passivePort: [5000, 5001, 5002], // Array of port(s) to use with Passive DCC              - default: [5001]
  secure: false, // Allow/Deny files sent by bot with different name than the one requested - default: true
}

xdccJS includes (and extends) @kiwiirc/irc-framework, if you need more advanced (IRC) features check their documentation and some examples on how its used with xdccJS

xdccJS.download( bot : string, packets : string | number | number[] )

xdccJS.on('ready', () => {
  xdccJS.download('XDCC|BLUE', '1-3, 8, 55')
  xdccJS.download('XDCC|YELLOW', 4)
  xdccJS.download('XDCC|RED', [12, 7, 10, 20])
  xdccJS.download('XDCC|PURPLE', ['1', '3', '10', '20'])
})

.download() are stored as jobs

const job1 = xdccJS.download('a-bot', [33, 50, 62, 98])
const job2 = xdccJS.download('XDCC|RED', [1, 3, 10, 20])

• Get job progress status :

  let status = job1.show()
  console.log(status)
  //=> { name: 'a-bot', queue: [98], now: 62, sucess: ['file.txt'], failed: [50] }

• Cancel a Job

  job1.cancel()

• Events (see events documentation)

Jobs are stored by bot nickname : .download() will update matching jobs

xdccJS.on('ready', () => {
  const job1 = xdccJS.download('XDCC|BLUE', '1-3, 8, 55') // job1 is created
  const job2 = xdccJS.download('XDCC|RED', [1, 3, 10, 20]) // job2 is created
  xdccJS.download('XDCC|BLUE', 23) // job1 is updated
  xdccJS.download('XDCC|RED', '150-155') // job2 is updated
})

You can also search jobs with :xdccJS.jobs()

xdccJS.jobs( bot : string | undefined )

// find job by botname
const job = xdccJS.jobs('bot-name')

// retrieve all jobs at once
const arrayOfJobs = xdccJS.jobs()

Most events are accessible both from xdccJS or a Job scope

FYI: those examples are for the sake of showing xdccJS capabilities, if you need download status to be displayed in a nice way just start xdccJS with parameter verbose = true

[xdccJS].on( 'ready' ) : xdccJS is ready to download

• xdccJS.on('ready', ()=> {
    // download() here
  })

[xdccJS | Job].on( 'downloading' ) : Data is being received (a file is downloading)

• xdccJS.on('downloading', (fileInfo, received, percentage) => {
    console.log(fileInfo) //=> { file: 'filename.pdf', filePath: '/path/to/filename.pdf', length: 5844849 }
    console.log(`downloading: '${fileInfo.file}'`) //=> downloading: 'your file.pdf'
  })
  
  job.on('downloading', (fileInfo, received, percentage) => {
    console.log(percentage) //=> 10.55
  })

[xdccJS | Job].on( 'downloaded' ) : A file successfully downloaded

• xdccJS.on('downloaded', (fileInfo) => {
    console.log(fileInfo.filePath) //=> /home/user/xdccJS/downloads/myfile.pdf
  })
  
  job.on('downloaded', (fileInfo) => {
    console.log('Job1 has downloaded:' + fileInfo.filePath)
    //=> Job1 has downloaded: /home/user/xdccJS/downloads/myfile.pdf
    console.log(fileInfo)
    //=> { file: 'filename.pdf', filePath: '/home/user/xdccJS/downloads/myfile.pdf', length: 5844849 }
  })

[xdccJS | Job].on( 'done' ) : A job has no remaining package in queue

• xdccJS.on('done', (job) => {
    console.log(job.show())
      //=> { name: 'a-bot', queue: [98], now: 62, sucess: ['file.txt'], failed: [50] }
  })
  
  job.on('done', (job) => {
    console.log('Job2 is done!')
    console.log(job.show())
      //=> { name: 'a-bot', queue: [98], now: 62, sucess: ['file.txt'], failed: [50] }
  })

[xdccJS | Job].on( 'pipe' ) : A pipe is available (see pipe documentation)

• xdccJS.on('pipe', (stream, fileInfo) => {
    stream.pipe(somewhere)
    console.log(fileInfo)
    //=> { file: 'filename.pdf', filePath: 'pipe', length: 5844849 }
  })
  
  job.on('pipe', (stream, fileInfo) => {
    stream.pipe(somewhere)
    console.log(fileInfo)
    //=> { file: 'filename.pdf', filePath: 'pipe', length: 5844849 }
  })

[xdccJS | Job].on( 'error' ) : something goes wrong

• xdccJS.on('error', (message) => {
    console.log(message)
    //=> timeout: no response from XDCC|BLUE
  })
  
  job.on('error', (message) => {
    //=> timeout: no response from XDCC|BLUE
  })

In order to use pipes xdccJS need to be initialized with path option set to false

// This example will start vlc.exe then play the video while it's downloading.
const opts = {
  host: 'irc.server.net',
  path: false, 
}

const xdccJS = new XDCC(opts)

// Start VLC
const { spawn } = require('child_process')
const vlcPath = path.normalize('C:\\Program Files\\VideoLAN\\VLC\\vlc.exe')
const vlc = spawn(vlcPath, ['-'])

xdccJS.on('ready', () => {
  const Job = xdccJS.download('bot', 155)
})

// send data to VLC that plays the file
Job.on('pipe', stream => {
  stream.pipe(vlc.stdin)
})

// event triggered when all jobs are done.
xdccJS.on('can-quit', () => {
  xdccJS.quit() // this is how you disconnect from IRC
})

npm install xdccjs -g

Options:
  -V, --version              output the version number
  -h, --host <server>        IRC server hostname
  --port <number>            IRC server port
  -b, --bot <botname>        xdcc bot nickname
  -d, --download <packs...>  pack number(s) to download
  -p, --path <path>          download path
  -n, --nickname <nickname>  Your IRC nickname
  -c, --channel [chan...]    channel(s) to join (without #)
  -r, --retry <number>       number of attempts before skipping pack
  -q, --quiet                disable console output
  --passive-port <number>    port used for passive dccs
  --no-randomize             Disable nickname randomization
  -w, --wait [number]        wait time (in seconds) in channel(s) before sending download request (default: 0)
  --no-secure                Allow files sent by bot with different name than the one requested
  --save-profile [string]    save current options as a profile
  --delete-profile [string]  delete profile
  --set-profile [string]     set profile as default
  --list-profile             list all available profiles
  --help                     display help for command

I recommend using double quotes between the bot name and download path as they often both include unescaped characeters or whitespaces

xdccJS --server irc.server.net --bot "XDCC-BOT|BLUE" --download 1-5,100-105 --path "/home/user/downloads"

Alternatively, if you want to pipe the file just ommit the --path option :

xdccJS --server irc.server.net --bot "XDCC-BOT|RED" --download 110 | vlc -

Profiles are presets of options.

You can save options as a profile with --save-profile :

# Any option can be included
xdccJS --save-profile "my_profile" --server "irc.server.net" --port "6669" --path "C:/Users/JiPaix/Desktop"

#1 - standard
xdccJS --bot "XDCC|BOT" --download "1132-1137"

#2 - if your profile includes a bot name
xdccJS --download "1132-1137"

#3 - use a different path than the one provided by current profile
xdccJS --bot "XDCC|BOT" --download "1132-1137" --path "E:/external_disk"

#4 - standard + copy/paste
xdccJS "/msg XDCC|BOT xdcc send 1132-1337" # quotes are important here

set default profile :

xdccJS --set-profile another_profile

List all profiles :

xdccJS --list-profile

Delete a profile :

xdccJS --del-profile my_profile

• hashtags for channels and packs are optional :

  •   --channel "#my-channel" --download "#132"
      # is the same as
      --channel "my-channel" --download "132" 

• given options prevails over the one provided by profiles :
  • except for --server, which results in xdccJS ignoring the current profile
  • example:

        # current profile has --wait 5, but this time you need --wait 50
        xdccJS --bot "mybot" --download "125-130" --wait 50

        # ignores ALL profile options
        xdccJS --server "irc.mywnewserver.org"

• options --bot and --path often contains special characters and/or whitespaces :

  •   # this wont work
      --path /home/user/my folder --bot XDCC|BOT --download 123-125
      # fixed
      --path "/home/user/my folder" --bot "XDCC|BOT" --download 123-125 

Full documentation is available here