Documentation
The same guides that ship inside the package (Assets/LocalNPC/Documentation after import), as web pages.
- Documentation overviewLocalNPC Documentation: what LocalNPC is, the table of contents and the pipeline in one line.
- 1. Quick StartSet up a talking NPC in a new projectNew Developers
- 2. Installation & RequirementsHardware requirements, Unity version, and project settingsTechnical Leads & IT
- 3. Personality Writing GuideSystem prompt craft, few-shot examples, and token constraintsWriters & Game Designers
- 4. Choosing a Model PresetCompare the Balanced (1.5B, default) and Fast (0.5B, low-end PCs) tiersProducers & Designers
- 5. API ReferenceComprehensive public C# contracts and code samplesProgrammers
- 6. Performance TuningCPU thread allocation, context windows, and latency budgetsOptimization Engineers
- 7. Lip Sync SetupA jaw that opens with the loudness of the voice, and blendshape mapping with an ARKit preset for viseme weights from your own code or the optional uLipSync bridge (not yet tested on a real character)Technical Artists
- 8. Shipping Your GameBuild pipeline, standalone Windows, and player deploymentBuild Engineers
- 9. Offline & Kiosk DeploymentPre-bundled StreamingAssets, air-gapped systems, and kiosk microphone setup (Push-to-Talk planned for v1.1)Enterprise & Exhibits
- 10. Language SupportMultilingual architecture seam and custom phonemizersLocalization Teams
- 11. TroubleshootingDiagnostic solutions for common audio, model, and DLL issuesAll Developers