This project provides an AI chatbot, named "Ai" (or "藍"), designed to function as a bot on the Misskey social platform. It targets Misskey instance administrators and users who want to integrate an AI assistant into their community, offering features like conversational AI, keyword learning, and server monitoring.

How It Works

The bot leverages large language models, specifically mentioning Gemini Pro and PLaMo, for its AI capabilities. It integrates with the Misskey API to post notes, respond to mentions, and interact with users. Key features include keyword memorization (requiring MeCab for Japanese natural language processing), random note posting, and interactive games like Reversi. The AI is configured to adopt a specific persona, "Misuki Ai," a helpful and slightly clumsy 14-16 year old girl.

Quick Start & Requirements

• Installation: Clone the repository, create a config.json file (copying example.json), run npm install, npm run build, and npm start.
• Docker: Clone the repository, create config.json, run docker-compose build, and docker-compose up.
• Prerequisites: Node.js, npm. MeCab is required for keyword learning and Japanese NLP. Font files (e.g., font.ttf) must be manually placed in the installation directory for certain features.
• API Keys: Gemini Pro API key and potentially PLaMo API key are required for AI functionality.
• Permissions: If using custom emoji checks, the bot requires administrator privileges and the "View Emojis" permission.

Highlighted Details

• Supports multiple AI backends, including Gemini Pro and PLaMo.
• Features a customizable persona and prompt for the AI chatbot.
• Includes optional modules for server monitoring, keyword learning, and games.
• Handles persistence of AI memory via memory.json.

Maintenance & Community

The project is maintained by syuilo. No specific community links (Discord, Slack) or roadmap details are provided in the README.

Licensing & Compatibility

• License: MIT.
• Compatibility: The MIT license generally permits commercial use and integration with closed-source projects.

Limitations & Caveats

The project requires manual installation of font files for certain features. MeCab is a significant dependency for Japanese language processing, and its absence may limit functionality. API keys for AI services may incur costs. The README mentions that list formatting in Markdown is not supported by Misskey's parser.