npm package: @skillfulai/kick-bot
Description: A chatbot framework for Kick.com streams with Skillful AI integration
Author: Skillful AI
Latest version: 1.0.10

# KickBot

A powerful, customizable chatbot for Kick.com streams powered by Skillful AI's dynamic agent system

## Overview

KickBot transforms your Kick.com streams by bringing Skillful AI's versatile agent system directly to your chat. Create custom AI personalities with specialized skills that dynamically respond to your viewers' questions and engage with your community.

## Key Skillful AI Integration Features

- 🧠 **Custom Agent Support**: Seamlessly switch between different AI personalities during your stream
- 🛠️ **Specialized Agent Skills**: Create agents with domain expertise in gaming, education, finance, or any topic
- 🗣️ **Dynamic Response Styles**: Each agent can have its own writing style, tone, and knowledge depth
- 🔄 **Live Agent Switching**: Let viewers vote to change between agents during your stream
- 🏗️ **Web Dashboard**: Accessible dashboard to stream events and check up on your bot & agent

## Quick Start

```bash
npm install @skillfulai/kick-bot
```

```javascript
// Import the library
const { createBot } = require('@skillfulai/kick-bot');

// Create a bot instance
const bot = createBot({
  // Required configuration
  clientId: 'your-kick-client-id',
  clientSecret: 'your-kick-client-secret',
  skillfulApiKey: 'your-skillful-api-key',
  chatroomId: 'your-chatroom-id',
  
  // Set your default Skillful AI agent
  defaultAgent: 'Gaming Expert',
  
  // Optional: additional fun commands to enable
  enabledCommands: ['8ball', 'imagine']
});

// Start the bot
bot.start()
  .then(() => console.log('Bot started!'))
  .catch(error => console.error('Failed to start bot:', error));
```

## Leveraging Skillful AI Agents

KickBot connects directly to your Skillful AI account, giving your viewers access to any custom agents you've created:

### Creating Custom Agents in Skillful AI

1. Create specialized agents in your [Skillful AI dashboard](https://app.skillfulai.io)
2. Configure each agent with different personalities, knowledge domains, and response styles
3. KickBot automatically makes all your agents available in your stream

### Switching Between Agents

Viewers can see available agents and vote to switch between them:

```
Viewer: !agents
Bot: Available agents: Gaming Expert, Educational Tutor, Community Manager, Character Roleplay

Viewer: !changeagent Gaming Expert
Bot: @viewer has started a vote to change to "Gaming Expert"! Type !yes or !no to vote.
```

## Core Commands

- `!ask [question]` - Direct questions to the current AI agent
- `!agents` - List all available Skillful AI agents
- `!changeagent [name]` - Start a vote to change the active agent
- `!help` - Show available commands


## Configuration Options

| Option | Type | Description | Default |
|--------|------|-------------|---------|
| clientId | string | Kick.com OAuth client ID | Required |
| clientSecret | string | Kick.com OAuth client secret | Required | 
| skillfulApiKey | string | Skillful AI API key | Required |
| chatroomId | string | Kick.com chatroom ID | Required |
| defaultAgent | string | Initial Skillful AI agent | 'General Assistant' |
| allowAgentChanges | boolean | Allow viewers to change agents | true |
| maxResponseLength | number | Maximum response length | 500 |
| enabledCommands | Array | Additional commands to enable | [] |
| enableDashboard | boolean | Enable the dashboard | false |
| dashboardPassword | string | Login Credential | Required for Dashboard |

More configurations in the documentation.


## Documentation

For detailed documentation, visit:
- [Installation Guide](https://docs.gaming.skillfulai.io)

## Support

- Discord: [Join Our Community](https://discord.gg/WhAYqkXYkg)