Chaturbate

Apps Home | My Uploads | Create an App
Artsy's Tip Menu
Author: artsysalter
Description Source Code Launch App Current Users
There are 3 other versions of this script.
/*
Artsy's Tip Menu
A customizable Chaturbate Apps/Bots tip-menu app.

Emoji update:
- Emoji choices are stored as plain text.
- Emoji are generated with Unicode escape sequences for better compatibility.
- The selected emoji is shown in chat menu headings, submenu entries,
  menu items, and thank-you notices.

Before publishing publicly, verify the current Chaturbate developer requirements
and API names in the developer area, since platform details can change.
*/

var MENU_SLOT_COUNT = 50;

cb.settings_choices = [
  {
    name: "menu_title",
    type: "str",
    minLength: 1,
    maxLength: 60,
    defaultValue: "Artsy's Tip Menu",
    label: "Menu title"
  },
  {
    name: "menu_command",
    type: "str",
    minLength: 1,
    maxLength: 20,
    defaultValue: "!menu",
    label: "Chat command"
  },
  {
    name: "menu_emoji",
    type: "choice",
    choice1: "Sparkle",
    choice2: "Heart",
    choice3: "Strawberry",
    choice4: "Cherries",
    choice5: "Water",
    choice6: "Flower",
    defaultValue: "Heart",
    label: "Menu emoji"
  },
  {
    name: "announce_minutes",
    type: "int",
    minValue: 1,
    maxValue: 60,
    defaultValue: 5,
    label: "Auto-post menu every X minutes"
  },
  {
    name: "exact_match_only",
    type: "choice",
    choice1: "Yes",
    choice2: "No",
    defaultValue: "Yes",
    label: "Only trigger an item on an exact token match?"
  },
  {
    name: "thank_you_template",
    type: "str",
    minLength: 1,
    maxLength: 180,
    defaultValue: "Thank you, {user}! You tipped for {item} {emoji}",
    label: "Thank-you message"
  }
];

function defaultSubmenuName(i) {
  return i === 1 ? "Sub-menu 1" : "—";
}

for (var submenu = 1; submenu <= 5; submenu++) {
  var firstItem = ((submenu - 1) * 10) + 1;
  var lastItem = submenu * 10;

  cb.settings_choices.push({
    name: "submenu_" + submenu + "_name",
    type: "str",
    minLength: 1,
    maxLength: 40,
    defaultValue: defaultSubmenuName(submenu),
    label: submenu === 1
      ? "Sub-menu 1 name"
      : "Sub-menu " + submenu + " name (optional)"
  });

  for (var i = firstItem; i <= lastItem; i++) {
    cb.settings_choices.push(
      {
        name: "item_" + i + "_name",
        type: "str",
        minLength: 0,
        maxLength: 60,
        defaultValue: "—",
        label: "Item " + i + " name"
      },
      {
        name: "item_" + i + "_tokens",
        type: "int",
        minValue: 0,
        maxValue: 99999,
        defaultValue: 0,
        label: "Item " + i + " token price"
      }
    );
  }
}

function getMenuItems() {
  var items = [];

  for (var i = 1; i <= MENU_SLOT_COUNT; i++) {
    var name = (cb.settings["item_" + i + "_name"] || "").trim();
    var tokens = parseInt(cb.settings["item_" + i + "_tokens"], 10);

    if (name && name !== "—" && tokens > 0) {
      items.push({
        name: name,
        tokens: tokens
      });
    }
  }

  return items;
}

function getSelectedEmoji() {
  var choice = cb.settings.menu_emoji || "Heart";

  if (choice === "Sparkle") {
    return "\u2728";
  }

  if (choice === "Strawberry") {
    return "\uD83C\uDF53";
  }

  if (choice === "Cherries") {
    return "\uD83C\uDF52";
  }

  if (choice === "Water") {
    return "\uD83D\uDCA7";
  }

  if (choice === "Flower") {
    return "\uD83C\uDF38";
  }

  return "\uD83D\uDC97";
}

function getSubmenuName(index) {
  var raw = (cb.settings["submenu_" + index + "_name"] || "").trim();

  if (index === 1) {
    return (!raw || raw === "—") ? "Sub-menu 1" : raw;
  }

  return raw === "—" ? "" : raw;
}

function isSubmenuEnabled(index) {
  if (index === 1) {
    return true;
  }

  return getSubmenuName(index) !== "";
}

function getItemsForSubmenu(index) {
  var startSlot = ((index - 1) * 10) + 1;
  var endSlot = index * 10;
  var out = [];

  for (var slot = startSlot; slot <= endSlot; slot++) {
    var name = (cb.settings["item_" + slot + "_name"] || "").trim();
    var tokens = parseInt(cb.settings["item_" + slot + "_tokens"], 10);

    if (name && name !== "—" && tokens > 0) {
      out.push({
        name: name,
        tokens: tokens
      });
    }
  }

  return out;
}

function buildMainMenuText() {
  var title = cb.settings.menu_title || "Artsy's Tip Menu";
  var emoji = getSelectedEmoji();
  var command = cb.settings.menu_command || "!menu";

  var lines = [
    emoji + " " + title + " " + emoji
  ];

  var enabledCount = 0;

  for (var i = 1; i <= 5; i++) {
    if (isSubmenuEnabled(i)) {
      lines.push(
        emoji +
        " " +
        i +
        " — " +
        getSubmenuName(i) +
        "  (" +
        command +
        " " +
        i +
        ")"
      );

      enabledCount++;
    }
  }

  if (enabledCount > 0) {
    lines.push(
      "Type " +
      command +
      " plus a sub-menu number to open it."
    );
  }

  return lines.join("\n");
}

function buildSubmenuText(index) {
  var emoji = getSelectedEmoji();
  var command = cb.settings.menu_command || "!menu";

  if (!isSubmenuEnabled(index)) {
    return "That optional sub-menu is not enabled.";
  }

  var items = getItemsForSubmenu(index);

  var lines = [
    emoji +
    " " +
    getSubmenuName(index) +
    " " +
    emoji
  ];

  if (!items.length) {
    lines.push("No active items in this sub-menu yet.");
  } else {
    for (var i = 0; i < items.length; i++) {
      lines.push(
        emoji +
        " " +
        items[i].tokens +
        " — " +
        items[i].name
      );
    }
  }

  lines.push(
    "Type " +
    command +
    " to go back to all sub-menus."
  );

  return lines.join("\n");
}

function showMenu(username, submenuIndex) {
  var text = submenuIndex
    ? buildSubmenuText(submenuIndex)
    : buildMainMenuText();

  if (username) {
    cb.sendNotice(text, username);
  } else {
    cb.sendNotice(text);
  }
}

function findMatchedItem(amount) {
  var items = getMenuItems();
  var exactOnly =
    cb.settings.exact_match_only === "Yes";

  if (exactOnly) {
    for (var i = 0; i < items.length; i++) {
      if (items[i].tokens === amount) {
        return items[i];
      }
    }

    return null;
  }

  var match = null;

  for (var j = 0; j < items.length; j++) {
    if (
      items[j].tokens <= amount &&
      (!match || items[j].tokens > match.tokens)
    ) {
      match = items[j];
    }
  }

  return match;
}

function fillTemplate(template, username, item, amount) {
  return template
    .replace(/\{user\}/g, username)
    .replace(/\{item\}/g, item ? item.name : "")
    .replace(/\{tokens\}/g, String(amount))
    .replace(/\{emoji\}/g, getSelectedEmoji());
}

cb.onTip(function (tip) {
  var amount =
    parseInt(tip.amount, 10) || 0;

  var username =
    tip.from_user || "someone";

  var item =
    findMatchedItem(amount);

  if (!item) {
    return;
  }

  var template =
    cb.settings.thank_you_template ||
    "Thank you, {user}! You tipped for {item} {emoji}";

  var msg =
    fillTemplate(
      template,
      username,
      item,
      amount
    );

  cb.sendNotice(msg);
});

cb.onMessage(function (msg) {
  var command =
    (cb.settings.menu_command || "!menu")
      .toLowerCase();

  var text =
    (msg.m || "")
      .trim()
      .toLowerCase();

  if (text === command) {
    showMenu(msg.user);

    msg["X-Spam"] = true;

    return msg;
  }

  if (text.indexOf(command + " ") === 0) {
    var arg =
      text
        .substring(command.length + 1)
        .trim();

    var submenuIndex =
      parseInt(arg, 10);

    if (
      submenuIndex >= 1 &&
      submenuIndex <= 5
    ) {
      showMenu(
        msg.user,
        submenuIndex
      );

      msg["X-Spam"] = true;
    }
  }

  return msg;
});

function scheduleMenu() {
  var minutes =
    parseInt(
      cb.settings.announce_minutes,
      10
    ) || 5;

  cb.setTimeout(
    function () {
      showMenu();
      scheduleMenu();
    },
    minutes * 60 * 1000
  );
}

cb.setTimeout(
  function () {
    showMenu();
    scheduleMenu();
  },
  3000
);