revolt-bot-base

Tool to simplify the creation of basic Revolt bots.

Links:
GitHub | NPM | Documentation

Install

npm install @astronomyoverdrive/revolt-bot-base

(will also install ws)

Example bot

const bot = require("@astronomyoverdrive/revolt-bot-base");

bot.ConfigureBot({
    botToken: "YOUR_BOT_TOKEN", // Found in: Settings -> My Bots
    botUserId: "YOUR_BOT_USER_ID", // Found in: Settings -> My Bots
    serverId: "YOUR_SERVER_ID", // Right-click server -> Copy server ID
    APILogs: false, // Don't show events/responses in terminal
    chatLogs: "", // Don't keep a log of users messages
    modLogs: "", // Don't keep kick/ban logs
    prefix: "!", // Use "!" as command prefix
    removeCaller: true, // Remove the message that triggered the command
    badWords: [/\bemacs\b/, "vscode"], // Remove messages with these words
    blockEmbeds: true, // Remove messages using []()
    blockAttachments: true, // Remove messages using attachments
    badWordLevel: 3, // Ban users using bad words
    embedLevel: 1, // Warn users using embed
    attachmentLevel: 1 // Warn users using attachment
});

// Get Role IDs with: Server settings -> Roles -> ROLE ID
// Get Channel IDs with: Right-click channel -> Copy channel ID
// Get User IDs with: Right-click user -> Copy user ID

// !live
bot.RegisterCommand({
    usePrefix: true,
    command: "live",
    action: "Send",
    allowedRoles: ["STAFF_ROLE_ID"],
    allowedChannels: ["STAFF_BOT_CHANNEL_ID"],
    targetChannel: "LIVE_CHANNEL_ID",
    contents: "<@USER_ID> is now live at [TEXT](URL)"
});

// !announce [what to announce]
bot.RegisterCommand({
    usePrefix: true,
    command: "announce",
    action: "Send",
    allowedRoles: ["STAFF_ROLE_ID"],
    allowedChannels: ["STAFF_BOT_CHANNEL_ID"],
    targetChannel: "SERVER_ANNOUNCEMENTS_CHANNEL_ID",
    contents: ""
});

// !poll [what to vote on]
bot.RegisterCommand({
    usePrefix: true,
    command: "poll",
    action: "Poll",
    allowedRoles: [],
    allowedChannels: [],
    targetChannel: "",
    contents: ""
});

// !remove [message-link]
bot.RegisterCommand({
    usePrefix: true,
    command: "remove",
    action: "Remove",
    allowedRoles: ["STAFF_ROLE_ID"],
    allowedChannels: ["STAFF_BOT_CHANNEL_ID"]
});

// !kick <@userid> [reason]
bot.RegisterCommand({
    usePrefix: true,
    command: "kick",
    action: "Kick",
    allowedRoles: ["STAFF_ROLE_ID"],
    allowedChannels: ["STAFF_BOT_CHANNEL_ID"]
});

// !ban <@userid> [reason]
bot.RegisterCommand({
    usePrefix: true,
    command: "ban",
    action: "Ban",
    allowedRoles: ["STAFF_ROLE_ID"],
    allowedChannels: ["STAFF_BOT_CHANNEL_ID"]
});

// Accept
bot.RegisterCommand({
    usePrefix: false,
    command: "Accept",
    action: "AddRole",
    allowedRoles: [],
    allowedChannels: ["WELCOME_CHANNEL_ID"],
    contents: "MEMBER_ROLE_ID"
});

// !quote [text to quote]
bot.RegisterCommand({
    usePrefix: true,
    command: "quote",
    action: "Custom",
    allowedRoles: [],
    allowedChannels: [],
    contents: `
       const my_SendTo = UserChannel;
       const my_Year = new Date().getFullYear();
       const my_SendText = '"'+UserText+'" - <@'+UserId+'>, '+my_Year;
       makeRequest("Send", [my_SendTo, my_SendText]);
    `
});

// !add 10 5
bot.RegisterCommand({
    usePrefix: true,
    command: "add",
    action: "Custom",
    allowedRoles: [],
    allowedChannels: [],
    contents: `
       const my_SendTo = UserChannel;
       const my_Numbers = UserText.split(" ");
       const my_SendText = Number(my_Numbers[0]) + Number(my_Numbers[1]);
       makeRequest("Send", [my_SendTo, String(my_SendText)]);
    `
});

// Friday message
bot.RegisterRecurring({
    Day: [5],
    Hour: [0],
    Minute: [0],
    Channel: "GENERAL_CHANNEL_ID",
    Message: "It's finally friday!"
});

// Twelve reminder
bot.RegisterRecurring({
    Day: [0, 1, 2, 3, 4, 5, 6],
    Hour: [0, 12],
    Minute: [0],
    Channel: "GENERAL_CHANNEL_ID",
    Message: "The clock is now twelve!"
});

bot.startBot();