sp_character_plugin 1.0.0-beta.1

A Flutter plugin for displaying digital characters using SPAvatarKit SDK with real-time rendering, audio-driven animations, and network connectivity (Device only).

SPAvatarKit Flutter Plugin (Development Version)

A development version of the SPAvatarKit Flutter plugin with simulator support for testing and debugging.

Features

• Display digital characters with real-time rendering
• Load characters with specific IDs
• Connect to network services for character interaction
• Play audio files to drive character animations
• Real-time state monitoring and control
• Support for iOS simulator and physical devices

Requirements

• iOS 18.0+ / Android API 21+
• Flutter 3.3.0+
• Dart SDK ^3.8.1
• SPAvatarKit SDK license

Note: This is a development version that supports iOS simulator for testing and debugging. For production use, please use the main sp_character_plugin package.

Installation

Add this dependency to your pubspec.yaml:

dependencies:
  sp_character_plugin_dev: ^0.0.3-dev

Usage

import 'package:sp_character_plugin_dev/character_widget.dart';

// Create a character widget
CharacterWidget.createWithController(
  sessionToken: "your_session_token",
  setUpStateChanged: (state) {
    // Handle setup state changes
  },
  loadStateChanged: (state, progress) {
    // Handle load state changes
  },
  connectionStateChanged: (state) {
    // Handle connection state changes
  },
  // ... other callbacks
)

Example App

The plugin includes a comprehensive example app in the example/ directory that demonstrates:

• Character loading and display
• Network connection management
• Audio playback for character animation
• Real-time state monitoring

To run the example (iOS simulator or device):

cd example
flutter pub get
flutter run

Platform Support

• iOS: Full support for simulator and physical devices (iOS 18.0+)
• Android: Coming soon
• Web: Coming soon

Development vs Production

This development version (sp_character_plugin_dev) is designed for:

• Testing and debugging on iOS simulator
• Development workflows
• Quick iteration and testing

For production applications, use the main package:

dependencies:
  sp_character_plugin: ^0.0.1

License

This plugin is licensed under the MIT License. See the LICENSE file for details.