charleprr / redditube

A video generator from Reddit posts and comments

Redditube

A video generator from Reddit posts and comments.
Watch this video made with Redditube.

Installation

npm install redditube

Got installation errors? Install the following packages and try again.
sudo apt install build-essential libpixman-1-dev libcairo2-dev libpango1.0-dev libjpeg-dev libgif-dev librsvg2-dev

You will need to have FFmpeg installed on your machine.
You will also need Reddit credentials.

• Create a Reddit account, if you don't already have one
• Create a Reddit app
  • Give it a name
  • Set the redirect URI to "http://127.0.0.1/"

We will need the Client ID (random string under the app name) and Client secret later.

Usage

const Redditube = require("redditube");

// Configure access to Reddit
Redditube.config({
    "userAgent": "Redditube",
    "clientId": "",     // Your Client ID
    "clientSecret": "", // Your Client secret
    "username": "",     // Your Reddit username
    "password": ""      // Your Reddit password
});

// Log start, status, errors and end events (optional)
Redditube.on("start", () => console.log("Start event!"));
Redditube.on("status", status => console.log(status));
Redditube.on("error", error => console.error(error));
Redditube.on("end", () => console.log("End event!"));

// Option 1
// Use .then() and .catch()
Redditube.make("f9cufu", 3).then(videoPath => {
    console.log(videoPath);
}).catch(error => {
    console.log(error);
});

// Option 2
// Await a promise (inside an asynchronous function)
const videoPath = await Redditube.make("f9cufu", 3);

The above example makes a video from this post (see f9cufu in the URL) and with 3 comments.

Contributing

Feel free to star the repository, create issues and make pull requests on GitHub.

License

Released under the MIT license.