osu-map-dl
TypeScript icon, indicating that this package has built-in type declarations

0.1.3 • Public • Published

osu-map-dl

NpmVersion npm NodeVersion GitHub GitHub stars GitHub issues GitHub closed issues

Simple and easy-to-use node package for downloading osu! beatmaps from either osu website or bloodcat.

Installation

npm install osu-map-dl

Usage

const downloadBeatmapset = require('osu-map-dl');
 
// Download beatmap set
downloadBeatmapset({
  beatmapsetID: 16653, // ID number representing the beatmap set to download
  downloadFolder: '.', // (optional) Folder where the .osz file will be saved
  noVideo: false, // (optional) true if video is not desired, false otherwise
  preference: 'osu!website', // (optional) 'osu!website' or 'bloodcat' if one fails the other will be used
  banchoUsername: undefined, // (optional) username if downloading from osu!website
  banchoPassword: undefined // (optional) password if downloading from osu!website
}).then(() => console.log('Beatmap has been successfully downloaded!'))
  .catch(e => console.error(e));

Install

npm i osu-map-dl

DownloadsWeekly Downloads

1

Version

0.1.3

License

MIT

Unpacked Size

16 kB

Total Files

14

Last publish

Collaborators

  • loarca