/wumpus-store-campaign-report

Get a daily, weekly or monthly report on how your bot's campaign is going on Wumpus.store.

Primary LanguageJavaScript

Important

This thing was never finished lol. I initially wanted to make it an NPM package but I got lazy (that's why there's still an official readme with details of how to use it, even if it's not on NPM).
Got the idea by inspecting the requests Wumpus.store made when the "Insights" tab was clicked on a bot's page and I found this endpoint, feel free to modify

Wumpus Store Campaign Stats

This package provides functions to retrieve campaign statistics for bots on Wumpus Store, including daily, weekly, and monthly reports.

lol

Installation

You can install the package via npm:

npm install wumpus-store-campaign-report

Usage

Importing Functions

const { dailyEmbed, weeklyEmbed, monthlyEmbed } = require('wumpus-store-campaign-report');

Receive a daily report

const cron = require('node-cron');

const webhookUrl = 'YOUR_WEBHOOK_URL';
const botId = 'YOUR_BOT_ID';

cron.schedule('0 0 * * *', () => {
  dailyEmbed(webhookUrl, botId);
});

Receive a weekly report

const cron = require('node-cron');

const webhookUrl = 'YOUR_WEBHOOK_URL';
const botId = 'YOUR_BOT_ID';

cron.schedule('0 0 * * 0', () => {
  weeklyEmbed(webhookUrl, botId);
});

Receive a monthly report

const cron = require('node-cron');

const webhookUrl = 'YOUR_WEBHOOK_URL';
const botId = 'YOUR_BOT_ID';

cron.schedule('0 0 1 * *', () => {
  monthlyEmbed(webhookUrl, botId);
});

Parameters

- webhookUrl (string): The URL of the Discord webhook to which the stats will be posted.
- botId (string): The ID of the bot for which the stats are being retrieved.

License

This project is licensed under the MIT License - see the LICENSE file for details.