ai_licia Integrations

This monorepo contains libraries for integrating with ai_licia AI Co-Host API.

Packages

This repository contains ai_licia-client, the core client library for interacting with the ai_licia API.

Installation

npm install ai_licia-client

Environment Setup

Create a .env file with your ai_licia API credentials:

AI_LICIA_API_KEY=your_api_key_here
AI_LICIA_CHANNEL_NAME=your_twitch_channel_name

Usage

Core Client

import { AiliciaClient, GenerationMode } from 'ai_licia-client';

// Create a client
const client = AiliciaClient.getInstance({
  apiKey: 'your_api_key_here', 
  channelName: 'your_twitch_channel_name'
});

// Send an event to ai_licia
await client.sendEvent('The player just entered a new dungeon area');

// Trigger a generation
const response = await client.triggerGeneration('The player just defeated the boss');
console.log(response.content);

// Use fast model execution for brief, time-sensitive reactions.
await client.triggerGeneration('Tyre puncture. Tell the driver to pit safely.', {
  mode: GenerationMode.FAST,
  tts: true,
  ttl: 8
});

API Reference

AiliciaClient (ai_licia-client)

getInstance(config: AiliciaConfig): AiliciaClient

Creates or returns the singleton instance of the client.

• config.apiKey: Your ai_licia API key
• config.channelName: Your Twitch channel name
• config.baseUrl (optional): Override the base URL for API requests

sendEvent(content: string, ttl?: number): Promise<void>

Sends contextual data to ai_licia.

• content: The data for ai_licia to process (max 1,000 characters)
• ttl: Optional Time-to-Live in seconds

triggerGeneration(content: string, options?: GenerationOptions): Promise<GenerationResponse>

Triggers a reaction from ai_licia.

• content: The data for ai_licia to react to (max 300 characters)
• options.mode: Optional GenerationMode.STANDARD or GenerationMode.FAST. Fast mode changes model execution only.
• options.tts: Optional text-to-speech delivery flag. Defaults to true.
• Returns a response with the ai_licia generation content

Example Use Cases

• Game integration: Send game state events to ai_licia so she can comment on gameplay
• Stream integration: Trigger ai_licia to react to stream events (follows, subs, etc.)
• Chat moderation: Send filtered chat messages for ai_licia to respond to
• Interactive storytelling: Use ai_licia as a dynamic NPC that responds to player actions

Development

Setup

git clone https://github.com/YOUR_USERNAME/ai_licia-monorepo.git
cd ai_licia-monorepo
npm install

Building

Build all packages:

npm run build

Or build specific packages:

npm run build:client

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Please make sure to update tests as appropriate and follow the existing code style.

Code of Conduct

Please read our Code of Conduct to keep our community approachable and respectable.

Issue Reporting

If you find a bug or have a feature request, please open an issue using the GitHub issue tracker.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

• Thanks to the ai_licia team for providing the API
• All the streamers and content creators building with ai_licia
• Contributors to this project