Skip to main content

NovelAI shim and image CLI for OpenClaw-friendly usage.

Project description

🎨 NovelAI OpenClaw Adaptor

A seamless shim to connect NovelAI's API to OpenClaw using the OpenAI format.

"Solving the core pain point of integrating NovelAI with OpenClaw by providing a simple, OpenAI-compatible local proxy."

License: MIT Python 3.10+

Quick Start · How It Works · 简体中文 · 日本語

Why NovelAI OpenClaw Adaptor? 🌟

The core pain point for many users is that NovelAI's API cannot be directly integrated into OpenClaw, as OpenClaw expects the standard OpenAI API format.

To solve this, we created a shim (adaptor) that acts as a middleman. It translates OpenAI-formatted requests from OpenClaw into NovelAI-compatible requests, and returns the generated images seamlessly.

Additionally, it supports a simplified generation method: you can just pass your prompt directly to generate images without complex configurations!

Quick Start 🚀

📥 Install:

pip install novelai-openclaw-adaptor

⚙️ Initialize config:

novelai-config init

▶️ Start the shim:

novelai-shim

🖼️ Generate an image:

novelai-image --prompt "1girl, solo, masterpiece, best quality"

Help:

novelai-config --help
novelai-shim --help
novelai-image --help

How It Works ✨

  1. Local Proxy: The adaptor runs locally and provides an OpenAI-compatible endpoint (e.g., http://localhost:xxxx/v1).
  2. Format Translation: When OpenClaw sends an OpenAI-style request, the adaptor translates it into NovelAI's specific parameters.
  3. Simple Prompting: You can simply pass the prompt string to generate images.
  4. Configuration: In OpenClaw, set the base_url to your local adaptor address, for example http://127.0.0.1:11434/v1, and configure the model name as required.

License 📄

This project is released under the MIT license.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

novelai_openclaw_adaptor-0.1.0.tar.gz (17.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

novelai_openclaw_adaptor-0.1.0-py3-none-any.whl (18.8 kB view details)

Uploaded Python 3

File details

Details for the file novelai_openclaw_adaptor-0.1.0.tar.gz.

File metadata

  • Download URL: novelai_openclaw_adaptor-0.1.0.tar.gz
  • Upload date:
  • Size: 17.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.7

File hashes

Hashes for novelai_openclaw_adaptor-0.1.0.tar.gz
Algorithm Hash digest
SHA256 19fe3fb91dc1a508769d1fcb64c5b977c654f1a4cf7d6136e5313558c3499c3d
MD5 2182d3a18d4fb6e67a5c545f02365dd4
BLAKE2b-256 36cc2ef320dbc6d80f5426be2fcdbdd7b7fccad311eb2b6ef7f485ec5d2b528c

See more details on using hashes here.

File details

Details for the file novelai_openclaw_adaptor-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for novelai_openclaw_adaptor-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b89c0cac10bc94567c74392b5cb818292def865f6181b997c597b973bc54cc29
MD5 144c112d83d75e9e8bfa104d9b2e488c
BLAKE2b-256 721cb232cf3ec7ac25e61883ed0006a2b3ca92ac761581e4f02b99e1c5e03cf9

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page