/steam-workshop-scraper

Gets data about Steam workshop mods/assets

Primary LanguageJavaScriptMIT LicenseMIT

Welcome to steam-workshop-scraper 👋

npm npm bundle size Documentation Maintenance License: MIT GitHub issues

Gets data about Steam workshop mods/assets

Prerequisites

  • npm >=6.14.x ?
  • node >=14.x

Install

npm install steam-workshop-scraper

Useage

const SteamWorkshopScraper = require('steam-workshop-scraper');
var sws = new SteamWorkshopScraper();

sws.GetChangeLog(670764308).then(function (data) {
  console.log('Last entry in changelog:', data.data[0]);
});

sws.GetInfo(670764308).then(function (data) {
  console.log('Info:', data);
});

Or with update event

const SteamWorkshopScraper = require('steam-workshop-scraper');
var sws = new SteamWorkshopScraper();

// Add your steam workshop ids what should be monitored
sws.AddToUpdates([1384657523, 670764308, 589205263]);
// Or remove some if you don't need them anymore
sws.RemoveFromUpdates([670764308, 1384657523]);
// Get the event fired if a workshop item gets updated.
sws.Event.on('update', function(data){
  console.log('data on update:', data);
});
//To trigger the update manually
sws.TriggerUpdate().then(function (){
  console.log(sws.workshopMap);
});

Run tests

npm test

Author

👤 axi92

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page.

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2020 axi92.
This project is MIT licensed.

This README was generated with ❤️ by readme-md-generator