Skip to content

docs: expand Live2D model and character setup guide#29

Open
chiveswang wants to merge 1 commit into
Open-LLM-VTuber:mainfrom
chiveswang:docs/live2d-character-setup-guide
Open

docs: expand Live2D model and character setup guide#29
chiveswang wants to merge 1 commit into
Open-LLM-VTuber:mainfrom
chiveswang:docs/live2d-character-setup-guide

Conversation

@chiveswang
Copy link
Copy Markdown

@chiveswang chiveswang commented Jun 7, 2026

Summary

  • Replace the placeholder Live2D model configuration note with a concrete model3.json checklist.
  • Add guidance for matching model_dict.json with character configs.
  • Add a reusable character/persona config template and troubleshooting table.
  • Keep the English translation in sync with the zh-Hans source page.

Validation

  • npm run build passes for both zh-Hans and en locales.
  • The build still reports existing broken-anchor warnings in /en/docs/faq and /en/docs/quick-start; this PR does not touch those pages.

Summary by CodeRabbit

Documentation

  • Expanded Live2D configuration guide with step-by-step setup checklists and verification procedures
  • Added quick reference guide and configuration templates for character setup
  • Enhanced troubleshooting section with solutions for common setup issues
  • Included detailed examples for character configuration and emotion mapping setup

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Jun 7, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: b1768e07-c0ed-4ea4-be38-0a47ff16f90c

📥 Commits

Reviewing files that changed from the base of the PR and between 622a307 and 36ade31.

📒 Files selected for processing (2)
  • docs/user-guide/live2d.md
  • i18n/en/docusaurus-plugin-content-docs/current/user-guide/live2d.md

📝 Walkthrough

Walkthrough

This PR expands the Live2D integration documentation in both Chinese and English guides. The changes replace generic placeholders with concrete model configuration guidance, adding example model3.json structures, comprehensive pre-configuration checklists, character configuration templates, and expression tag usage instructions for persona prompts.

Changes

Live2D Integration Guide Expansion

Layer / File(s) Summary
Model3.json structure and initial inspection guidance
docs/user-guide/live2d.md, i18n/en/docusaurus-plugin-content-docs/current/user-guide/live2d.md
Replaces placeholder text with actionable initial direction to inspect *.model3.json and identify Expressions, Motions (including idle), and HitAreas for available animations and click regions.
Quick model3.json check with example structure and pre-configuration checklist
docs/user-guide/live2d.md, i18n/en/docusaurus-plugin-content-docs/current/user-guide/live2d.md
Adds example model3.json snippet showing FileReferences and HitAreas location, notes on field-name casing differences (e.g., Motions vs motions), and comprehensive pre-configuration checklist covering Cubism version compatibility, URL targeting, local path conventions, exact name matching across configs, idle motion group existence, expression availability, and motion group existence for click/tap motions.
Character configuration template and persona prompt expression tags
docs/user-guide/live2d.md, i18n/en/docusaurus-plugin-content-docs/current/user-guide/live2d.md
Adds character configuration YAML template with required fields (conf_name, conf_uid, live2d_model_name, character_name, avatar, persona_prompt) and subsection explaining how to use emotion tags in persona_prompt when live2d_expression_prompt is enabled, with guidance on keyword alignment and tag usage. Extends troubleshooting section with common issues (invalid model URL, name mismatches, kScale behavior, expression prompting alignment, idle/click motion mismatches, remote model loading) and ordered diagnostic approach.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Poem

A rabbit hops through documentation green,
Where model3.json templates are seen—
Expressions, motions, hit areas clear,
Configuration guides now appear!
🐰✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The pull request title clearly and concisely summarizes the main change—expanding the Live2D model and character setup guide documentation with concrete guidance.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant