Initial commit of Unity SDK for GumYum NPC client

This commit is contained in:
Russell Ballestrini 2025-09-15 09:59:21 -04:00
commit db46a7bf9d
29 changed files with 3073 additions and 0 deletions

47
CHANGELOG.md Normal file
View file

@ -0,0 +1,47 @@
# Changelog
All notable changes to the GumYum NPC SDK for Unity will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [1.0.0] - 2024-01-15
### Added
- Initial release of GumYum NPC SDK for Unity
- API key authentication support
- Deterministic NPC spawning with universe and seed parameters
- Filtered NPC spawning based on profession, location, personality type, and sex
- OpenAI-compatible chat completions API
- Real-time streaming chat responses
- Dynamic mood system with transitions
- Stress level tracking
- Conversation history management
- Unity coroutine integration
- Async/await support for modern C# workflows
- GumYumUnityClient singleton for easy scene integration
- Custom Editor window for API settings
- Example scenes demonstrating basic and advanced features
- Comprehensive documentation
### Dependencies
- Unity 2021.3 or higher
- Newtonsoft JSON Unity Package (com.unity.nuget.newtonsoft-json) 3.2.1
## [0.9.0-beta] - 2024-01-01
### Added
- Beta release for testing
- Core API functionality
- Basic NPC spawning and chat
### Known Issues
- Streaming responses may have occasional connection drops
- Mood transitions require fine-tuning
## [0.1.0-alpha] - 2023-12-15
### Added
- Alpha release
- Initial API integration
- Basic spawning functionality