Plugin Directory

Changeset 3429455


Ignore:
Timestamp:
12/30/2025 06:50:07 AM (2 months ago)
Author:
ishchai
Message:

Docs: add avatar feature documentation

File:
1 edited

Legend:

Unmodified
Added
Removed
  • bitbloom-chatbot-for-chatkit/trunk/readme.txt

    r3429451 r3429455  
    1515**BitBloom Chatbot for Chatkit** lets you embed a published Agent Builder workflow into WordPress using OpenAI’s ChatKit UI.
    1616Features a floating launcher, optional shortcode, theme controls (light/dark, accent color, radius, density, font), and server-side session creation with REST nonces (no API key in the browser).
     17- Optional avatar support: display a custom image in the chat header and/or the floating launcher button.
     18
    1719
    1820**Highlights**
     
    28302. Your **Domain allowlist** and **Domain Public Key** (Security → Domain allowlist).
    29313. Active billing/credits in your OpenAI account.
     32
     33The plugin also supports an optional **avatar image**, allowing you to personalize the chat experience by displaying a custom image inside the chat header and/or on the floating launcher button.
    3034
    3135== Installation ==
     
    5963   - Font
    6064
    61 6. (Optional) Enable **Auto-inject** to display the floating chat launcher on all pages.
     656. (Optional) Configure avatar settings:
     66  - Upload a custom avatar image
     67  - Show the avatar inside the chat header
     68  - Show the avatar on the floating launcher button
     69  - Use an image-only launcher (no text label)
    6270
    63 7. (Optional) To embed the chat inline inside a single page or post, use the shortcode:
     717. (Optional) Enable **Auto-inject** to display the floating chat launcher on all pages.
     72
     738. (Optional) To embed the chat inline inside a single page or post, use the shortcode:
    6474   
    6575   [bitbloom_chatbot_for_chatkit]
    6676
    67 8. (Optional) Adjust **Rate limit** (per IP / hour). Default is 20/hour.
    68 
     779. (Optional) Adjust **Rate limit** (per IP / hour). Default is 20/hour.
    6978
    7079
     
    7382**Floating Launcher (auto)**
    7483- Once configured, the floating button appears on the front-end. Clicking it opens ChatKit bound to your published workflow.
     84If enabled, a custom avatar image can appear inside the chat header and/or on the launcher button.
    7585
    7686**Shortcode (inline chat)**
     
    109119= Can I customize the look of the chat? =
    110120Yes. You can change the color scheme (light/dark), accent color, radius, density, and font.
     121
     122= Can I add a custom avatar to the chat? =
     123Yes. You can upload an image in the plugin settings and choose whether it appears in the chat header, the floating launcher button, or both.
    111124
    112125= Is there a usage/rate limit in the plugin? =
     
    149162== Changelog ==
    150163= 1.2.2 =
    151 * Improved launcher button rendering rules for avatar + text:
    152   - Default label appears only when both text and avatar are missing
     164* Added optional avatar support:
     165  - Display avatar in the chat header
     166  - Display avatar in the floating launcher
    153167  - Supports image-only launcher (no label)
     168* Improved launcher button rendering logic and defaults.
    154169= 1.2.1 =
    155170* Added an admin setting to configure the per-IP hourly rate limit for session requests (default: 20/hour).
Note: See TracChangeset for help on using the changeset viewer.