Getting Started with TDoge SDK

Welcome to TDoge SDK - your gateway to creating interactive talking doge experiences! This guide will help you get started with integrating our powerful SDK into your web applications.

TDoge SDK is a powerful toolkit that enables you to integrate an interactive talking doge avatar into your web applications. The SDK provides both text-to-speech and chat interaction capabilities, making it perfect for creating engaging user experiences.

Key Features

  • Interactive Avatar: A lifelike talking doge character that responds to user interactions
  • Text-to-Speech (TTS) functionality: Natural-sounding voice synthesis
  • Dual Interaction Modes: Direct TTS and AI Chat capabilities
  • Vue.js Integration: Seamless integration with Vue.js applications
  • Responsive Design: Adapts to any screen size and device
  • Customizable UI: Tailor the appearance to match your application's style

Quick Start

1. Installation

npm install tdoge-sdk

2. Basic Implementation

import { TDoge } from 'tdoge-sdk';

// Create a new instance with options
const tdoge = new TDoge({
    showOnlyAvatar: true, // Show only the avatar without additional UI
    host: "https://tapi.anispark.xyz/tdoge-core" // Required: Specify the host URL
});

// Mount to a DOM element
tdoge.mount("#app");

3. Start Interacting

// Send a message in AI Chat mode
tdoge.ask("Hello, how are you?");

// Direct execution without generating a response by AI chat (Direct TTS mode)
tdoge.say("Hello");

System Requirements

The SDK is compatible with modern browsers that support:

  • WebGL for 3D rendering
  • Web Audio API for sound processing

Next Steps

Last Updated::
Contributors: lqs469