Nyx

A Revolt.chat bot built with revolt.js.

Features

• Natural conversation with users
• Command handling with prefix
• Channel-based AI context tracking
• Support for mentions and replies
• Random occasional responses
• Channel blacklisting and whitelisting
• User blacklisting
• Image and audio support with AI analysis
• Configurable logging for diagnostics

Image and Audio Support

Nyx can now analyze images and audio files that are attached to messages. When sending a message with an image or audio attachment, make sure to either:

• Mention the bot (@nyx)
• Include "nyx" in your message
• Reply to a previous bot message

The bot will process the attachment and use AI to analyze:

• Images: Describe what's in the image
• Audio: Transcribe and respond to audio content

How Nyx Responds

Nyx will respond if you:

• Mention her (e.g. @Nyx)
• Reply to one of her messages
• Say 'nyx' anywhere in your message

Setup

1. Clone this repository

   git clone https://github.com/yourusername/nyx.git
   cd nyx
   

2. Install dependencies

   npm install
   

3. Configure environment variables

   • Copy env.example to .env
   • Fill in your Revolt bot token and MongoDB URI

4. Start the bot

   npm start
   

Commands

• !help - Display help information
• !ping - Check bot latency
• !activate - Make the bot respond to all messages in a channel
• !deactivate - Make the bot only respond when mentioned, replied to, or randomly
• !blacklist @user or !blacklist #channel - Prevent a user or channel from using the bot
• !whitelist @user or !whitelist #channel - Allow a blacklisted user or channel to use the bot
• !logging - Toggle detailed console logging
• !wack - Clear the AI message context for the current channel

Development

For development with auto-restart on file changes:

npm run dev

Creating Your Own Commands

Create a new file in the commands directory with this structure:

module.exports = {
  name: 'commandname',
  description: 'Description of what the command does',
  usage: '[arguments]', // Optional
  permissions: ['ManageServer'], // Optional - permissions required
  
  async execute(message, args, client) {
    // Command logic here
    return message.reply('Response message');
  }
};