Skip to content

Latest commit

 

History

History
41 lines (35 loc) · 2.5 KB

README.md

File metadata and controls

41 lines (35 loc) · 2.5 KB

rockstar-newswire

A lightweight Rockstar newswire tracker to bring latest news to your platform.

Currently supports discord webhooks and you can easily change it to return URL for to be used on any other platform.

Install

  • Install the required Node packages via npm i or yarn install

API

    let newswire = require('./newswire');
    let latestNews = new newswire(type, webhookURL);
    // Available Types: rdr2, gtav, latest, music, fanart, fanvideos, creator, tips, rockstar, updates,
    // Webhook URL: https://support.discordapp.com/hc/en-us/articles/228383668-Intro-to-Webhooks
    // News should automatically post and update every 2 hours.

Available types

  • creator (Creator jobs articles featured by Rockstar)
  • fanart (General fans' art articles from any Rockstar game)
  • fanvideos (General fans' showoff videos articles from any Rockstar game)
  • gtav (GTA: V general news)
  • music (Music production articles)
  • latest (Latest news from any type that shows on newswire homepage)
  • rdr2 (Red dead redemption 2 general news)
  • rockstar (Rockstar company updates)
  • tips (General game tips from Rockstar)
  • updates (Any released game updates)

Notes

  • You require discord webhook URL.
  • Feed refreshes every 2 hours to make sure its up-to-date. If you would like to change it then you're required to change this variable using that time converter. It has to be in milliseconds in order to operate properly.
  • It's recommened to take newsdb.json with you if you're porting the project to another host to prevent redundant news posts.
  • It is not guranteed that it can trace multiple new news posts of the same type since it only traces the last post posted. In-order to avoid such error, you can lower the news feed refresh rate as specified previously. If you have a idea on how to improve it then feel free to contribute.
  • This is a small research project and it's not meant to be used as a network harm tool.

Demo

Credits