Skip to content

Latest commit

 

History

History
109 lines (86 loc) · 3.26 KB

README.md

File metadata and controls

109 lines (86 loc) · 3.26 KB
Raw

IveBot

The bot that created the iPhone X. It's strictly private. You may run it locally, but it's not a useful bot to others and tailored for a specific need.

Requires Node.js 12.x or higher.

It includes many different and useful commands, from games to tools, utilities, fun commands, moderation and even a /ai command which generates text responses to inputs. It also uses Next.js to provide a web dashboard as part of the bot itself.

Commands

/halp and /help - The most innovative help.

Games.

  • /gunfight
  • /random
  • /randomword
  • /choose
  • /reverse
  • /trivia
  • /8ball
  • /repeat
  • /calculate
  • /distort

Random searches.

  • /urban
  • /cat and /dog
  • /robohash
  • /zalgo /dezalgo
  • /namemc
  • /astronomy-picture-of-the-day or /apod
  • /currency
  • /xkcd
  • /httpcat
  • /google

Utilities.

  • /request
  • /token
  • /weather
  • /say | /type
  • /editLastSay
  • /reminderlist
  • /remindme
  • /leave
  • /ocr
  • /avatar
  • /userinfo
  • /serverinfo
  • /creationtime
  • /about, /ping, /uptime and /version
  • /emojiImage
  • /giverole and /takerole
  • /notify
  • /hastebin
  • /suppressEmbed

Administrative commands.

  • /ban, /unban, /kick, /mute and /unmute
  • /addEmoji, /deleteEmoji and /editEmoji
  • /deleteChannel and /editChannel
  • /warn, /warnings, /clearwarns and /removewarn
  • /changevoiceregion and /listvoiceregions
  • /perms
  • /purge
  • /slowmode

Complete list of commands along with their descriptions available here.

Configuration

Set up a MongoDB instance and note its URL. You can set it to store its data in database within this folder (you must first make the folder before starting MongoDB)

Make a file named config.json5 in the top-level directory. It should be something like this:

{
  "token": "<insert token here>",
  "testPilots": ["array of people who can use test pilot commands via user ID"],
  "NASAtoken": "<to enable /astronomy-picture-of-the-day or /apod>",
  "oxfordAPI": {
    "appKey": "<enables /define, use Oxford Dictionary API>",
    "appId": "<read above>"
  },
  "host": "<your user ID to give you certain privileges like /remoteexec>",
  "weatherAPIkey": "<an http://openweathermap.org API key to enable /weather>",
  "fixerAPIkey": "<an http://fixer.io API key to enable /currency>",
  "jwtSecret": "<optional, leave empty if not using dashboard: JWT secret from dashboard>",
  "cvAPIkey": "<a http://cloud.google.com/vision API key for /ocr and text recognition>",
  "mongoURL": "<the link to your MongoDB database instance>",
  "rootURL": "<the root link to the dashboard with http(s):// and no / at the end>"
}

You can use comments in JSON5. If you're using a deployment service like Now which supports secrets, then you can secure your token and MongoDB database URL by setting the value of both keys to dotenv and then setting the IVEBOT_TOKEN environment variable to your token and the MONGO_URL env variable to the MongoDB instance URL.

Dashboard Configuration

Since 4.0 onwards, the dashboard has been separated and needs to run separately. Refer to the README.md in the dashboard/ folder.