devrant-bot

1.0.8 • Public • Published

DevRant Bot

An NPM package to create DevRant bots,
Super easy to implement,
Never care about implementation again, just focus on functionality.

image

How To Use

This package can be used to create bots which will act when someone mentions it.
It can then Reply to that mention with some text or image.

var Bot = require('devrant-bot');
 
(async function() {
var bot = new Bot();
await bot.login("username","password");
var mentions = await bot.get();
console.log(mentions);
})();

Which produces,

[
  {
    "rid": 2821893, //rant ID
    "cid": 3308364,  //comment ID
    "is_bot": false, //User who has called is a bot or not
    "text": "some message", //Message
    "user": "theabbie",  //Username of user who called
    "time": 1603281044  //Timestamp of comment
    "rto": [{
       "id": 3307103,
       "text": "text",
       "time": 1603264598,
     },
     ...]
  },
  ...
]

To reply,

(async function() {
var bot = new Bot();
await bot.login("username","password");
var mentions = await bot.get();
for (msg of mentions) {
  await bot.reply(msg.user,msg.rid,"reply"[,image_url]);
}
})();

This makes bot development really easy and you can safely focus only on the functionality rather than the implementation of the DevRant bot.

Contributing

Thank you for your interest in contributing, If you feel like there's something missing or any new feature can be added, just create a PR and I will see the rest.

Help

You can contact me on social media, Everything about me can be found here

Installation

Requirements

  • Node.Js installed

Dev Dependencies

  • Axios
  • RantScript

Credits

  • RantScript For Creating an excellent Wrapper For the DevRant API.

Contact

Contact me anywhere, just visit my portfolio

License

This project is licensed under MIT License, See LICENSE for more information

Readme

Keywords

Package Sidebar

Install

npm i devrant-bot

Weekly Downloads

1

Version

1.0.8

License

ISC

Unpacked Size

6.57 kB

Total Files

7

Last publish

Collaborators

  • theabbie