First Steps

This page will guide you trough the Developer API for Olympus and help you create your own addons from scratch.

Keep in mind our API will be updated over time incorrect or missing syntaxes are possible to happen. If you notice or need help please open a ticket on our Discord Server

Creating addons and Publishing is requiring for you to own a valid license of the bot

Creating a File (Creating an Addon)

1. First you should have a fully working local instance of the bot, if you don't please refer to Installation Instructions before continuing

2. Navigate to folder called addons folder and create a file with .js type (ex. myFirstAddon.js)

Copy our Addon Template

// These are default imports, do not remove them
const { SlashCommandBuilder } = require("discord.js");
const Utility = require("../utils/modules/Utility");

module.exports = {
    commands: [
    // You will learn more about this in our CommandHandler
    ],
    events: [
    // You will learn more about this in our EventHandler
    ],
    function: {
    // You are free to change name, but leaving it as 'setAddon' will prioritize the loading
        name: 'setAddon',
        execute(client) {
        // You need to remove this line if you don't have any commands, this will just print commands (if there are any) into console on addon load
            Utility.addonConsole(module.exports.commands);
        }
    }
}

Handlers

Next step is reading trough our in-depth guide, first on the list are Handlers

Examples

After you've read everything here as well as the Handler and Utility you can visit some of our Examples