novelai-bot  by koishijs

Image generation bot for NovelAI

created 2 years ago
2,529 stars

Top 18.9% on sourcepulse

GitHubView on GitHub
Project Summary

This project provides a Koishi plugin for generating images using NovelAI, targeting users of the Koishi chatbot framework who want to integrate AI image generation into their chat platforms. It offers a user-friendly interface for controlling various NovelAI parameters and leverages Koishi's extensibility for multi-platform support and advanced features.

How It Works

The plugin acts as an interface to the NovelAI API, allowing users to trigger image generation directly from chat commands. It supports core NovelAI functionalities like model selection, sampler choice, image dimensions, advanced request syntax, custom negative prompts, and automatic translation of Chinese keywords. Its modular design, built upon the Koishi plugin system, enables seamless integration with other plugins for features like rate limiting, context management, and multi-language support.

Quick Start & Requirements

  • Install: npm install koishi-plugin-novelai (within a Koishi project)
  • Prerequisites: Koishi framework, NovelAI API access.
  • Setup: Refer to the setup tutorial for detailed instructions.

Highlighted Details

  • Supports image generation, model/sampler/size changes, advanced request syntax, and custom negative prompts.
  • Includes automatic Chinese keyword translation and an auto-delete feature for generated images.
  • Offers img2img functionality and integration with SD-WebUI and Stable Horde.
  • Extensible via Koishi's plugin architecture for multi-platform support (QQ, Discord, Telegram) and features like rate limiting and context management.

Maintenance & Community

The project is released under the MIT license. Further community and development information can be found by exploring the Koishi ecosystem.

Licensing & Compatibility

  • License: MIT License.
  • Compatibility: Permissive license allows for commercial use and integration into closed-source projects.

Limitations & Caveats

The plugin relies on external NovelAI API access, and its functionality is dependent on the availability and terms of service of the NovelAI service.

Health Check
Last commit

5 months ago

Responsiveness

Inactive

Pull Requests (30d)
0
Issues (30d)
1
Star History
23 stars in the last 90 days

Explore Similar Projects

Feedback? Help us improve.