example.js

return class extends Mod {
    // Metadata
    ID = "example-mod"; // the id of the mod
    NAME = "Example Mod"; // human-readable name
    DESCRIPTION = "A example mod for Sparkle."; // description
    VERSION = "1.0"; // version
    AUTHOR = "Your Name"; // author
    DEPENDS = []; // dependencies (mod ids, useful for libraries)
    DO_MENU = true; // whether to add a menu item
    OPTIONS_FORMAT = [
        "HEADING 1", // Headings
        {
            id: "number",
            name: "A number",
            type: "number",
            default: 3,
            // optional
            min: 1,
        },
        {
            id: "slider",
            name: "A number slider",
            type: "number",
            default: 3,
            // optional, both min and max will make the input into a slider
            min: 1,
            max: 4,
            resolution: 0.1
        },
        null, // spacer
        {
            id: "helloTest",
            name: "Hello String",
            type: "string",
            default: "Hello!",
        },
        {
            id: "dropDown",
            name: "Hi Dropdown",
            type: "string",
            default: "hello",
            menu: {
                "Hello": "hello",
                "Example": "example",
                "Sparkle": "sparkle",
            },
            readOnly: true,
        },
        {
            id: "color",
            name: "A color",
            type: "color",
            default: new Color(255, 0, 128),
        },
        {
            id: "everyHello",
            name: "All Category Hellos",
            type: "string",
            // numbers and strings can have arrays as defaults
            default: ["hi", "hello", "sick", "howdy"],
            // optional, for arrays
            minLength: 1,
            maxLength: 5,
        },
    ]; // format for options

    // Main function - gets ran when the mod is loaded
    main() {
        // allow access to the API in the menu functions and such, shortcut
        let api = this.api;

        // Example adding a menu item - see morphic.js's MenuMorph
        // for more info on menus
        this.menu.addItem("Say hello", () => {
            api.inform(
                "Hello, world! My number is: " + this.options.number,
                "Example Mod",
            );
        });

        // Example of using events
        this.addEventListener("categoryCreating", (e) => {
            if (this.options.everyHello.includes(e.detail.name.toLowerCase())) {
                api.inform("I dont accept your hello.", "Example Mod");

                e.preventDefault();
            }
        });

        // Example of menu hooking
        api.registerMenuHook("projectMenu", (menu) => {
            menu.addLine();
            menu.addItem("Example Mod - Say hello", () => {
                alert(this.options.helloTest);
            });
        });
    }

    // Cleanup function - get ran when the mod is "deleted"
    cleanupFunc() {
        console.log("Goodbye!");
    }
};