快速开始

在 5 分钟内开始使用 VPetLLM。

安装

首先，安装 VPetLLM 包：

npm install vpetllm
# 或使用 pnpm
pnpm add vpetllm
# 或使用 yarn
yarn add vpetllm

基本使用

创建你的第一个虚拟宠物：

import { VPetLLM } from 'vpetllm';

// 创建一个新的虚拟宠物
const pet = new VPetLLM({
  name: 'Fluffy',
  type: 'cat',
  personality: 'friendly'
});

// 让宠物说话
pet.speak('Hello! I am Fluffy!');

// 执行动作
pet.action('jump');

配置选项

基本配置

const pet = new VPetLLM({
  // 宠物的名字
  name: 'My Pet',
  
  // 宠物的类型 (cat, dog, rabbit, etc.)
  type: 'cat',
  
  // 宠物的颜色
  color: 'orange',
  
  // 宠物的性格
  personality: 'friendly'
});

高级配置

const pet = new VPetLLM({
  // ... 基本配置
  
  // LLM 配置
  llm: {
    provider: 'openai',
    model: 'gpt-3.5-turbo',
    apiKey: 'your-api-key'
  },
  
  // 动画配置
  animation: {
    speed: 1.0,
    quality: 'high'
  },
  
  // 语言设置
  language: 'zh-CN'
});

事件处理

监听宠物的事件：

// 宠物说话时触发
pet.on('speak', (message) => {
  console.log(`Pet said: ${message}`);
});

// 宠物执行动作时触发
pet.on('action', (action) => {
  console.log(`Pet performed: ${action}`);
});

// 宠物状态改变时触发
pet.on('stateChange', (state) => {
  console.log(`Pet state: ${state}`);
});

下一步

现在你已经了解了基础知识，可以：

• 查看基础功能了解更多功能
• 探索高级功能进行高级定制
• 查看示例获取更多灵感

常见问题

Q: 如何更改宠物的外观？

A: 使用配置选项中的 color 和 type 参数。

Q: 如何集成自己的 LLM？

A: 在 llm 配置中指定你的 LLM 提供商和 API 密钥。

Q: VPetLLM 支持哪些语言？

A: VPetLLM 支持多种语言，包括英文、中文、日文等。在 language 配置中指定。

获取帮助

如果你遇到任何问题，请：

1. 查看文档
2. 在 GitHub Issues 上搜索
3. 创建一个新的 issue 描述你的问题