Avatar Forge Pipeline
Identify the installed release
When asked about the installed or latest available capability, read the adjacent VERSION file and report that exact value. Do not infer a version from conversation history, README prose, authentication state, or an older standalone Skill. This package is release 2.3.0.
If both this plugin Skill and a legacy standalone ~/.codex/skills/avatar-forge-pipeline are present, stop and explain the name collision. Preserve the legacy directory as a timestamped backup outside the active skills directory, then start a new Codex task before validating capabilities.
Enforce the delivery contract
Return only the final MP4 produced by LycheeAILab zeroshot inference unless the user explicitly requests standalone LycheeTTS audio.
- Never return, present, or call a RunningHub template the final digital-human video.
- Never stop after the internal template task.
- Never use RunningHub for fast clone or zeroshot inference.
- Never expose a RunningHub URL, task ID, payload, or internal template file to the user.
- Never replace the zeroshot result with a secondary packaged render.
- Delete the local internal template after fast clone succeeds.
Choose a capability
-
Person video: authorized person MP4 + finished WAV/MP3, or script + reference voice /
speaker_id→ fast clone → zeroshot MP4. Use--videoinstead of--image; skip RunningHub entirely. -
Complete: portrait + authorized reference voice or existing LycheeTTS
speaker_id+ script → internal template → target speech → fast clone → zeroshot MP4. -
Avatar only: portrait + finished WAV/MP3 → internal template → fast clone → zeroshot MP4.
-
Zeroshot only: ready
asset_id+player_id+ finished WAV/MP3 → zeroshot MP4. -
Clone voice: authorized reference audio → LycheeTTS clone through Lab. Normalize the returned
requestIdasspeakerIdwhen no explicitspeakerIdis present; this is the identifier accepted by LycheeTTS inference. -
Voice only: existing
speaker_id+ script → LycheeTTS MP3 through Lab. Use only when the user explicitly asks for audio. -
Reference-video script: uploaded video or authorized Douyin URL → local video → original transcript → rewritten speaking script. Stop there unless the user asks to continue into voice or avatar generation.
Do not offer template-only or clone-only output as a finished user deliverable.
Run the complete workflow
- Confirm the user is authorized to use the portrait, reference voice, and script.
- Require one portrait image, one UTF-8 script file, and either one WAV/MP3 reference voice or an existing
speaker_id. - Authenticate through LycheeAILab. Never ask for provider credentials.
- Run the command below once. The script stores hidden recovery state beside the output and resumes the exact stage after interruption.
- Verify that the delivered MP4 has video and audio streams and positive duration.
- Return only the zeroshot MP4 path. For failures, report only the failed stage and a sanitized error; never expose internal provider IDs, URLs, payloads, or media.
powershellpython scripts/run_pipeline.py ` --image input/person.png ` --voice input/reference.wav ` --script-file input/script.txt ` --output output/avatar-zeroshot.mp4
Resolve scripts/, assets/, and references/ relative to this SKILL.md. On WorkBuddy, ${CODEBUDDY_SKILL_DIR} points to this directory; on Codex, use the installed Skill directory supplied by the host.
Always use the bundled assets/template-driver.wav for the internal motion template. Do not ask the user for template text or template-driving audio. Never send the user's script, reference voice, finished audio, or LycheeTTS target speech to the template stage.
Before submitting any portrait, show this notice and obtain confirmation:
请确认人物脸部清晰、没有遮挡、完整露出,且人物在画面中的比例适中。模糊、遮脸、面部超出画面或人物过大/过小都会影响数字人效果。
Inspect the image when possible. Reject or request a replacement when facial features are unclear, important facial areas are obscured, the face is cropped, exposure is unusable, or subject scale is unsuitable.
Prepare a script from video
For using the person in a video, do not transcribe it or extract a portrait for RunningHub. Read the person-video instructions below. This section is only for extracting/reworking spoken copy.
Read references/video-recreation.md before downloading, transcribing, or rewriting a reference video.
The Skill includes a cookie-free Douyin engine derived from the user's proven DouK request flow, with yt-dlp as a fallback. If python scripts/doctor.py reports dependencies missing, install requirements.txt automatically before continuing. Never require the user to install a separate downloader, export browser cookies, use Edge/Chrome DPAPI, or install a ChatGPT browser extension.
For an uploaded/local video:
powershellpython scripts/prepare_video_source.py --video input/reference.mp4
For an authorized Douyin link, use the downloader installed with this Skill:
powershellpython scripts/prepare_video_source.py ` --douyin-url "https://v.douyin.com/..." ` --output output/reference.mp4
The command first uses the bundled cookie-free engine and automatically falls back to yt-dlp. Do not add browser-cookie flags or tell the user to download the video manually merely because Edge DPAPI or a browser extension is unavailable. If both engines fail, report their sanitized errors and stop; never ask for, read, print, copy, or save browser cookies.
Prefer a trusted transcription tool already available to the agent. For fully local transcription, install the optional dependency only when needed and run:
powershellpython -m pip install -r requirements-transcription.txt python scripts/transcribe_video.py input/reference.mp4 --output output/transcript-original.txt
Rewrite the transcript as a new spoken script and save it separately as script-rewritten.txt. Preserve the original transcript, factual meaning, names, and numbers; change structure, hook, pacing, transitions, and conclusion rather than only replacing synonyms. Never fabricate claims. Ask for the desired platform, duration, audience, tone, or call to action only when those cannot be reasonably inferred.
The image workflow's internal order is fixed (person-video mode skips step 1 and uses the uploaded MP4 in step 3):
- Use the portrait and bundled fixed short audio to create one internal motion template.
- If only a reference voice is supplied, clone it once through Lab, save the returned
requestIdasspeakerId, then use the protected Lab voice endpoint to generate target speech. Retry transient “voice preparing” responses with bounded backoff. The client must send only the user's Lab bearer token; the LycheeTTS API Key remains encrypted in the Lab database. - Send the internal template to LycheeAILab fast clone (
v2clone) and obtainplayer_id. - Send
player_idand the LycheeTTS target speech to LycheeAILab zeroshot inference.
Submit a reference voice separately when cloning is needed:
powershellpython scripts/run_pipeline.py --clone-voice --voice input/reference.wav
The clone response may contain only requestId. LycheeTTS accepts that identifier as speakerId; continue automatically and never ask the user to retrieve it manually. Do not invent a clone-status endpoint.
5. Download and return only the zeroshot MP4.
RunningHub is allowed only behind step 1. Steps 3 and 4 must use the LycheeAILab digital-human platform.
Use a person video directly
Confirm authorization to use the depicted person's likeness and target voice. Inspect the video: prefer one continuously visible person, a clear unobstructed face, and no scene cuts. Request a replacement if the subject is ambiguous or unsuitable. This fast-clone + zeroshot path does not guarantee exact preservation of the source's movements, duration, or every scene.
Use a readable MP4 (at most 100 MiB, 120 seconds, 1080p (long edge ≤1920 / short edge ≤1080), 25fps, FFprobe required). Do not silently transcode, trim, replace it with a photo, or route through RunningHub. Source video is clone material; its original audio is not automatically the target speech or a voice-cloning reference.
powershellpython scripts/run_pipeline.py --video input/person.mp4 --avatar-only --audio input/speech.mp3 --output output/avatar-zeroshot.mp4
For script-driven speech, replace --avatar-only --audio ... with --script-file input/script.txt --voice input/reference.wav (or --speaker-id ...). The source video is preserved. Reuse saved assetId/playerId with --infer-only for later speech changes. Final speech/video is limited to 300 seconds by Lab; if exceeded, explain the maximum and direct long-video requests to https://lab.lycheeai.com.cn/ customer support. Never truncate silently.
Recovery rules
- Re-run the same command with the same
--output; the hidden.avatar-forge/<output-stem>/state.jsonresumes saved stages. - Do not use
--reset-stateafter a timeout unless the user explicitly authorizes a new paid workflow. - A timeout is not failure. Query the saved template, clone, or inference ID.
- Never resubmit the internal template because fast clone or zeroshot is still processing.
- Never resubmit fast clone after
player_idis stored. - Never resubmit zeroshot after its request ID is stored.
Authenticate safely
Run python scripts/run_pipeline.py --login-only when authentication is needed. The browser uses https://lab.lycheeai.com.cn; a randomized loopback callback returns only the user's revocable Lab API Key. LycheeTTS, RunningHub, and digital-human provider credentials remain server-side.
Load references when needed
- Read references/workflow.md before changing stage order, outputs, or recovery behavior.
- Read references/api-contracts.md before changing Lab requests.
- Read references/verification-gates.md before claiming success.
- Read references/video-recreation.md for video acquisition, transcription, and rewriting.
Verify without spending
- Run
python -m py_compile scripts/run_pipeline.py scripts/prepare_video_source.py scripts/douk_downloader/download.py scripts/douk_downloader/a_bogus.py scripts/transcribe_video.py scripts/test_pipeline_no_spend.py. - Run
python scripts/test_workflow_contract.py,python scripts/test_pipeline_no_spend.py,python scripts/test_video_source_no_network.py,python scripts/test_douyin_downloader_no_network.py, and the secret scan. - Do not submit a real provider task solely to test installation or documentation.


