🌸 Anime Companion for VS Code

Language: English · Tiếng Việt · 日本語

A cute Live2D companion that lives in your VS Code panel and reacts to your coding flow — errors, saves, commits, builds, debug sessions, Pomodoro… and now chats with you through GitHub Copilot or your own API key (Anthropic / OpenAI / Gemini / xAI / DeepSeek / OpenRouter / Ollama).

⚠️ Experimental — v0.5.x. This is an early-access build. APIs, settings, and behavior may shift between minor versions before v1.0. Bugs or feedback are very welcome via GitHub Issues.

Current version: v0.6.1

🆕 What's new in v0.6.1:

• 🚶 The right character, with several windows open — run two or three VS Code windows on different models and the companion standing in your editor could be the wrong one, because the wander asked plain settings for the model while a window with a folder open can pin its own. Fixed, and frames cached before the fix are recaptured once.
• 💾 The frame cache no longer grows without limit — trying characters out used to leave a set of frames on disk for every model you had ever previewed, about a megabyte each. Three are now kept, least recently used first out, and the one in use is never removed.
• 🚶 The wander, smoothed out — she now shrinks into the floor as she leaves her panel instead of just fading, so you can see where she went. And standing in the editor she no longer twitches: every frame is cropped to one shared box, and the cuts between poses are now cross-fades. Frames cached by v0.6.0 are recaptured once on upgrade.

🆕 New in v0.6.0:

• 🚶 She wanders into your code — leave her alone for a few minutes and she fades out of her panel and turns up standing at the bottom-left of the editor for ten seconds, then goes home. Typing or moving the cursor brings her back at once, and she keeps her corner while you scroll. Off with animeCompanion.wander.enabled: false.

🆕 New in v0.5.9:

• 🌱 She does things on her own — between interactions she yawns, stretches, looks around, tilts her head or glances over at you, every 40 to 90 seconds. Sleepy beats crowd in after 22:00; nothing plays while a panel or the chat is open, and touching her pushes the next one back. animeCompanion.idleLife.enabled: false to turn it off.
• 🫳 Pull her, and she springs back — drag and the character stretches after your cursor, leaning into it so her hair and skirt trail behind. Stop while still holding the button and she stays right where you are holding her; let go and she springs home with a couple of swings. Prefer the old behaviour where a drag moved the whole panel? animeCompanion.dragMode: "panel". Driven through the model's own physics rig. animeCompanion.dragMomentum.enabled: false to turn it off.

🆕 New in v0.5.8:

• 👉 Hints for the hold gestures — leave the companion alone for a minute and a small pill with an arrow points at the body ("hold here a moment and I'll change outfits") or the head ("hold here a moment to see my expressions & motions"). Click the pill to open that panel. A hint rests for the session once you have used the gesture; animeCompanion.hints.enabled: false turns them off for good.
• 🖐️ The character answers where you point — rest the cursor on a part and that part reacts: shy at the head, flustered at the chest or skirt, a wave from a hand. A caption tells you in her own voice what that part invites ("hold here a moment and I will change outfits for you~"), the part is briefly outlined, and the cursor itself changes with the part — a comb over her hair, a dress over her body, a barred heart or bow where she'd rather you didn't, an open hand over hers — all in the same pink-arrow family as the heart cursor. Only a pause counts, and each part then rests a few seconds; animeCompanion.hoverReactions.enabled: false turns it off.
• 🤭 Tickle, pet, shake hands — scrub the cursor back and forth across her waist and she laughs (secret achievement); stroke her head slowly and repeatedly to pet her hair, which counts toward the new Head Pat Chain (25 / 100 / 500); rest on a hand and then move a little to take it. Captions now sit beside the character, so they are readable over any outfit.
• 🏆 Achievements as side columns — Achievements open in the same two columns as Outfit / Expression / Motion: achievements and secrets on the left, quests and memories on the right, the character in view between them. ☆ Showcase toggles in place; the panel stays until you press ×.

🆕 New in v0.5.7:

• ⚙️ Settings, the companion's way — right-click › Settings (or Anime Companion: Open Settings) now opens a themed settings page: every option grouped into Model, Sound, Messages, Pomodoro, Cursor Chibi, AI Chat and Desktop, with a search box, proper toggles / sliders / pickers, a ↺ per setting, and one-click links to the Background panel, VS Code's Settings UI and settings.json.
• 🎡 Radial right-click menu — right-click and the menu fans out on a ring around the cursor: icons on the circle, the hovered name in the centre; a category swaps the ring for its entries with a ↩ in the middle. Right-click again, click outside, or Esc closes it. Prefer the old list? animeCompanion.menuStyle: "list".
• Side columns, refined — Change Model now uses the same two side columns as Outfit / Expression / Motion; the close × sits at the bottom of the right column and stays put while the list scrolls; titles show in full. A clicked motion row lights up and pulses, so you can see the click landed.
• Know your model — switching models shows a one-time bubble with how many outfits, expressions and motions the model ships, and the panel header now reads Anime Companion: .

🆕 New in v0.5.6:

• ↔️ Side columns instead of a popup — Outfit, Expression and Motion now open as two slim columns at the sides of the character, so you see the change on the model as you pick. The columns stay open while you compare; close with × or Esc.

🆕 New in v0.5.5:

• 👗 Outfits from the model's own files — the companion reads every .exp3.json a Live2D model declares and, when a file switches clothes rather than faces, lists it under right-click › Appearance › Outfit. Pick one and it stays on; Default goes back to the model's own look. Nothing to configure.
• 😊 Model expressions — the faces the character was actually drawn with show up under Appearance › Expression, previewable with one click. A new animeCompanion.expressionMap setting lets the companion's moods (happy, shy, angry…) use those drawn faces instead of the built-in parameter presets.
• 🎬 Motions from any model — motion groups are now read from the model itself, so models whose groups aren't called Idle / TapBody / TapHead (e.g. 待机, 摸头, 打哈欠) finally animate: their own idle loops, headpats and pokes map onto matching groups, and Appearance › Motion lists every group by its real name.
• ☝️ Press and hold — hold the model past the headpat: on the body the Outfit popup opens, on the head the model's own Expression & Motion panel. No right-click needed.

Builds on v0.5.4's 🔄 Alt + drag rotate and 👀 auto look-at, v0.5.3's 🔗 background image from a URL, v0.5.1's 🌸 Markdown WYSIWYG editor, v0.5.0's 🖼️ Background Image control panel, and v0.4.0's Agent Accounts + 💬 Pet Quick Chat.

📦 Install

VS Code (Microsoft Marketplace)

code --install-extension shiroenguyen.anime-companion-vscode

Cursor / VSCodium / Theia / Gitpod (Open VSX Registry)

code --install-extension shiroenguyen.anime-companion-vscode

Or download the .vsix from the Open VSX page → code --install-extension <file>.

Manual install (any VS Code-based editor)

1. Grab the latest .vsix from GitHub Releases.
2. In the editor: Ctrl+Shift+P → Extensions: Install from VSIX... → pick the downloaded file.

✨ Features

🌸 Markdown editor (WYSIWYG) — in its own window

• Edit .md files visually, like a rich-text editor (à la CKEditor) — no split preview, no wrestling with raw syntax. Click the 🌸 flower on the editor title bar (or the pulsing 🌸 status-bar item) to open the current Markdown file in a full-size tab of its own (not a split).
• Writes straight back to the file on Save (Ctrl/Cmd+S works too), kept in sync with any normal editor tab. Safe by design: it only writes when you actually edit, so just previewing never touches the file — with a one-time heads-up that saving normalizes Markdown formatting.
• 🌗 Dark / Light toggle in the header, remembered across files and windows.
• 🎨 Custom theme colour — a colour swatch in the header recolours the whole accent (header, buttons, borders, links, scrollbar) to any colour, with a ↺ reset to the default sakura pink; remembered across files and windows. The page background keeps following Dark / Light mode.
• Slim scrollbar — a thin, accent-coloured bar (auto-hiding where the platform supports it) instead of the chunky default.
• Anime Companion look — sakura-pink header with a bobbing 🌸, a candy Save button, themed toolbar, and cute fonts.

Quick start: open any .md file → click the 🌸 button (top-right of the editor) or run Open in Anime Markdown Editor from the Command Palette.

⚠️ Editing through a WYSIWYG editor normalizes Markdown formatting on save (list markers, emphasis, spacing, raw HTML). That's exactly why the editor never writes unless you actually make a change.

🖼️ Background Image (workbench) — with a real control panel

• Put your own image behind VS Code — the editor, sidebar, and panel — or one Fullscreen image across the whole window. Like the popular "Background" extension (it patches VS Code's workbench, since there's no public API for this), but the whole point here is a visual control panel instead of fiddly JSON.
• Per-region or whole-window:
  • 🪟 Fullscreen — one image over the entire window (editor + sidebar + panel + activity/status bars).
  • 📝 Editor / 📁 Sidebar / 🖥️ Panel — a separate image behind the text of each region, each independently toggled.
• Friendly controls for every region: image picker with thumbnail, opacity / blur / sizing (cover / contain / repeat / stretch) / position (3×3 grid), and an in-panel live preview.
• Honest, guided lifecycle — the pain points the JSON-only extensions hide are surfaced inline:
  • Apply (reloads window) to see changes; Disable & Restore to cleanly revert.
  • Auto re-applies after a VS Code update; cleans itself up on uninstall (vscode:uninstall hook).
  • Opt-in "silence the installation-corrupt warning" toggle (patches product.json checksums).
  • Clear notes about reload / re-apply-after-update / Administrator-if-in-Program-Files.
• Localized — the panel follows your message language (vi / en / ja) and updates live when you change it.

Quick start: Command Palette → Background Image: Open Control Panel (or the companion right-click menu → Appearance › 🖼️ Background Image) → pick an image → Apply.

⚠️ Background changes need a window reload, must be re-applied after VS Code updates, and on a Program Files install may need running VS Code as Administrator once. The panel explains all of this. v1 targets desktop VS Code stable (works on Cursor too).

💬 AI Chat Companion

• Chat directly with the companion through a slide-in panel next to the Live2D character. Ask about the code you're writing, brainstorm ideas, learn a new framework — the companion stays in its anime persona while answering.
• 8 LLM providers, one default needs no key:
  • 🟢 GitHub Copilot (default, no API key) — uses your existing Copilot subscription via vscode.lm. Supports every model Copilot exposes: gpt-4o, claude-3.5/3.7-sonnet, gemini-1.5-pro, o1-mini, …
  • 🤖 Anthropic Claude (BYOK) — claude-opus-4-7, claude-sonnet-4-6, claude-haiku-4-5.
  • 🤖 OpenAI GPT (BYOK) — gpt-4o, gpt-4o-mini, o1-mini.
  • 🤖 Google Gemini (BYOK, free tier) — gemini-2.5-flash/pro/flash-lite, gemini-2.0-flash.
  • 🆕 xAI Grok (BYOK) — grok-2-latest, grok-3, grok-beta.
  • 🆕 DeepSeek (BYOK) — deepseek-chat, deepseek-reasoner (chain-of-thought hidden).
  • 🆕 OpenRouter (BYOK) — gateway to 100+ models including :free tier (Claude, GPT, Llama, Gemini, DeepSeek, …) through a single key.
  • 🆕 Ollama (local, no key) — talks to a local Ollama server (default http://localhost:11434). Fully offline. Pull any model with ollama pull llama3.2.

• Secure BYOK: API keys are stored in VS Code SecretStorage (OS keychain encrypted). The webview never sees the key.
• Streaming token-by-token with a sparkle caret ✨ and 3-dot pink thinking animation while waiting.
• Multi-conversation: history persists across restarts. List / rename / delete in the sidebar. Active conversation pinned per-workspace.
• Context awareness:
  • 📌 Toggle to attach editor selection.
  • 📄 Toggle to attach the whole active file.
  • #filename autocomplete picker scoped to the workspace.
  • Right-click code → "Ask Companion About Selection" → stages selection + opens chat.

• Sentiment reactions: the companion visibly reacts to its own reply — happy answer → TapBody + happy mood; thinking → TapHead + idle; sad/error → sleepy.
• Copy reply with one click: every finalised assistant bubble shows a small clipboard icon at the bottom-right (hidden during streaming). Click swaps to a checkmark with a pop animation and the bubble flashes green. Copies the raw markdown source — code-block "Copy" buttons inside the reply don't leak into the clipboard.
• Persona: 4 presets (cute / professional / tsundere / energetic) or a fully custom system prompt.
• Avatar + name come from the current Live2D model — assistant bubble shows "Hiyori" or "Miara" instead of a generic "Companion".

Quick start:

1. Open the Anime Companion panel (bottom panel or Ctrl+Shift+P → Anime Companion: Show).
2. Click the 💬 button in the bottom-right to open the chat panel.
3. The default provider is GitHub Copilot — if you're already signed in to Copilot in VS Code, just type and Send.
4. Want to use BYOK or Ollama? Click ⚙ → pick a provider → click 🔑 → paste the key (or set the endpoint for Ollama).

🎭 Live2D Companion

• 4 Live2D Sample models under Free Material License: Hiyori, Haru, Mao, Miara. Hiyori is bundled in the .vsix; the other three lazy-download the first time you pick them.
• Rendered via pixi-live2d-display + Cubism Core through a local HTTP server (to bypass VS Code's CSP).
• Live panel resize: drag the VS Code panel taller/shorter/wider and the character refits in real time. Works both in default flex layout and after you've dragged the companion to a custom spot — feet never clip thanks to a small bottom breathing margin for animation sway.
• Falls back to a static image if Live2D fails to load.
• Smooth expression blending through PIXI ticker — mood transitions don't jitter.
• Hands-on interaction: Alt + left-drag turns the head/body toward the cursor (bounded ~±30° — Live2D is 2.5D, not a true 360° spin), and an Auto look-at cursor toggle (right-click → Appearance) makes the gaze follow your mouse hands-free. Wiggle the cursor back and forth too fast and the companion gets dizzy and asks you to slow down. Click/double-click still poke, long-press still headpats.
• Outfits & expressions from the model itself: every .exp3.json the model declares is read on load and sorted by what it drives — garment switches land in Appearance › Outfit, drawn faces in Appearance › Expression. An outfit persists until changed; a face can be shown directly or wired to the companion's moods via animeCompanion.expressionMap (see Outfits & Expressions).
• Motions discovered per model: the idle loop and the poke / headpat reactions resolve onto the model's real motion groups whatever they're called (Idle or 待机, TapHead or 摸头…), and Appearance › Motion lists them all by name. Groups whose names suggest affection-gated content are only ever played from that popup, never by a reaction.
• Add your own local models via animeCompanion.customModelRoots or animeCompanion.customModels (see MODEL_LICENSE_AUDIT.md).
• When you have a workspace open, the model is remembered per-workspace; there's a command to reset back to your global model.

🐥 Cursor Chibi

• Toggle a chibi sprite that follows the editor cursor via Anime Companion: Toggle Cursor Chibi or the animeCompanion.cursorChase.enabled setting.
• Anime Companion: Tune Cursor Chibi Position lets you nudge it live with Up/Down/Left/Right + resize, then saves to global settings.
• Capture a chibi directly from the rendered Live2D model via Anime Companion: Capture Chibi from Model. The extension auto-crops the transparent background, scales it down, and uses it as the sprite for the active model.
• Anime Companion: Reset Captured Chibi clears the captured PNG and falls back to the bundled icon.
• The chibi only follows real editors (file, untitled, vscode-userdata) to avoid leaking into Output / Debug Console.

🪪 Agent Accounts (Claude / Codex credential swap)

• Save multiple agent-CLI logins and swap between them without re-authenticating. The companion snapshots the credential files of each logged-in CLI tool, then atomically restores them when you switch — same mechanic as a hand-rolled PowerShell account-swap script, ported to cross-platform Node fs and tied into the pet's right-click menu.
• Tool-agnostic backend registry — adding a new CLI is a single backend file (AccountBackend interface) + one registerBackend(...) line. The whole UI (popups, panel, status bar, command palette) discovers tools through that registry.
• Backends shipped:
  • 🤖 Claude Code — snapshots ~/.claude/.credentials.json + adjacent settings; identity shown as sub=team · org=09eb97ad · exp=… so you can tell two accounts apart at a glance.
  • ⚡ Codex — snapshots ~/.codex/auth.json; identity shown as mode=chatgpt · user@example.com · plan=plus (email + plan decoded from the OAuth id_token payload, never the token itself).
• Per-tool active detection — instead of trusting the last in-extension switch, the extension reads the live credential of each backend and matches it against your saved snapshots. So an external swap (e.g. running your own PowerShell script) is reflected correctly in the status bar and panel. Several tools can be "active" simultaneously — Claude account A and Codex account B at the same time.
• In-webview popups at the pet — right-click the pet → Agent ›:
  • 🔁 Đổi nhanh / Quick Switch — list profiles grouped by tool (🤖 Claude (2) / ⚡ Codex (1)), click a row to swap.
  • 💾 Save Current as… — inline tool picker (auto-selected if only one CLI is logged in) + name input, all attached to the pet — no VS Code QuickPick interruption.
  • 👀 Manage Profiles… — standalone webview panel with Use / Rename / Delete + per-tool sections.
• Status bar item — shows the active profile (or "N accounts" with a per-tool tooltip when multiple tools are active). Click → Quick Switch.
• Atomic, safe restore — every restore writes each file via <final>.tmp + fs.rename. Rolling 3-backup retention per tool before each restore. Snapshot directory missing? Refuses to clobber your live credentials.
• Restart hint — after every swap the extension reminds you to restart any running CLI session so it reloads the new token. It does not detect or kill CLI processes.

Quick start:

1. Log in to claude (or codex) in any terminal so the credential file exists.
2. Right-click the pet → Agent → 💾 Save Current as… → name the profile (e.g. work).
3. Log out, log in to the second account, repeat with a different name (e.g. personal).
4. Right-click the pet → Agent → 🔁 Quick Switch → pick → the credential file is swapped instantly. Restart your CLI to use the new account.

🪟 Desktop Companion (Windows v1)

• Run the companion as a floating desktop window instead of just inside the VS Code panel.
• Enable with animeCompanion.desktopCompanion.enabled, then reload the window.
• When Desktop Companion is on, the VS Code panel auto-hides so you don't have two Live2D instances at once.
• The desktop pet binary is lazy-downloaded from GitHub Releases on first launch. Override with animeCompanion.desktopCompanion.devBinaryPath for local testing.
• Supports alwaysOnTop, clickThrough, size, position, opacity.
• v1 is Windows-only. Mac/Linux binaries are planned for a later release.

💫 Interactions

• Single Click — gentle touch (Surprised).
• Double / Triple Click — happy (Happy).
• Long Press > 0.8s — Headpat → Shy → Love with heart effects.
• Keep holding ≈ 1.6s — two slim columns open at the sides of the character: hold on the body for the Outfit list, on the head for the model's own Expressions (left) and Motions (right). They stay open while you try things out — close with × or Esc. The release itself never picks a row.
• Spam Click — angry response ("Stop poking me!").

🔊 Audio + Lip-sync in 3 languages

• Japanese (ja) — VoiceVox Shikoku Metan, anime-style JP voice.
• Vietnamese (vi) — bundled lines + extended voice assets lazy-downloaded when needed.
• English (en) — bundled lines + extended voice assets lazy-downloaded when needed.
• Bubble text and voice are independent: voice can be ja while text is vi / en / ja.
• Automatic lip-sync via model.speak(), falls back to HTML5 Audio if the PIXI Audio plugin hiccups.
• Disable extended voice assets with animeCompanion.voiceAssets.enableExtended if you only want the bundled audio.

🎧 Background Ambient

• 3 built-in presets: Lofi, Rain, Cafe.
• Ambient loops independently from the companion's voice, so you hear reaction lines AND background music at the same time.
• Turn off entirely with the off preset, or adjust volume via animeCompanion.ambientVolume.
• Add custom local ambient tracks via animeCompanion.customAmbientTracks.

🤖 Reactive Engine — reacts to your coding environment

Every channel can be toggled independently in settings.

🏆 Achievements

• Built-in 23-achievement set: 6 progression chains for save, bug fixes, commits, coding time, AI chat, and Pomodoro, plus 4 secret achievements.
• Achievements now render in an inline evolution tree view, with rarity (Common → Mythic), tiered progression lanes, rarity-based unlock toast effects, and a separate secret lane with hints until unlocked.
• The same panel now includes daily / weekly quests and a lightweight companion memory feed that recalls unlocked achievements and cleared quests.
• Local-first reward economy is now tied to that progression loop: achievements and quests grant gems, tickets, cosmetics, and voice packs that stay on this machine with no backend sync required.
• Built-in command to view achievements in the tree UI, with a Quick Pick fallback when the panel is unavailable.

📊 Stats

• Tracks save count, commit count, errors fixed, today's coding time, all-time coding time, AI prompt usage, Pomodoro totals, quest progress, and recent shared memories.
• Includes a compact profile surface with level, affinity, inventory, top achievement, and local unlock collections, plus PNG share-card export.
• Built-in command for a quick stats view.

🍅 Pomodoro

• Automatic work/break loop (default 25/5 min, configurable).
• Status bar shows 🔥 23:42 during focus, ☕ 04:12 during break.
• Visual ring overlay on the character.
• Click the status bar to stop quickly.

🖱️ Custom Right-click Menu

Right-click on the companion and the menu fans out on a ring around the cursor: icons on the circle, the hovered name in the centre; a category swaps the ring for its entries, and ↩ in the middle goes back. Set animeCompanion.menuStyle to list for the classic vertical menu. Either way, no Command Palette needed:

• 🚀 Run — restart-or-start debug session
• 🔧 Git — Commit, Pull, Push
• 💬 AI Chat — Quick Chat; in panel mode also Open Chat, New Conversation, Ask About Selection, Configure Provider, Clear All
• 🌸 Appearance — Model, Outfit, Expression, Capture Chibi, Toggle Cursor Chibi, Tune Cursor Chibi, Auto look-at cursor, Background Image, Reset Position, Motion, Poke
• 🔊 Voice & Sound — Voice, Messages, Ambient, Mute / Unmute
• 🍅 Workflow — Start Pomodoro, Stop Pomodoro, Stats, Achievements, Quests, Profile, Share Card
• 🪪 Agent — Manage Profiles…, Quick Switch…, Save Current as…, GitHub Account… (swap Claude · Codex · GitHub accounts; popups attached to the pet)
• 🖥️ Desktop Companion — Switch to Desktop / Switch to Panel, desktop-only Toggle Click-Through, Reset Workspace Model
• ⚙️ All Settings — open Settings UI pre-filtered

🌙 Quiet Hours

Set time ranges that mute every bubble — e.g. during meetings:

"animeCompanion.quietHours": ["09:00-12:00", "22:00-06:00"]

Mood/expression still update — only messages are silenced.

🪄 Custom Phrases & Keywords

Add your own lines:

"animeCompanion.customPhrases.idle": ["Remember to drink water~"],
"animeCompanion.customPhrases.save": ["Beautiful save!"],
"animeCompanion.customPhrases.error": ["Calm down, you got this."]

Or your own keyword reactions:

"animeCompanion.customKeywords": {
  "refactor": ["Clean refactor~"],
  "NOTE": ["New note dropped!"]
}

🎵 Custom Ambient Tracks

Add your own local audio files to the Ambient menu:

"animeCompanion.customAmbientTracks": [
  {
    "label": "My Lofi",
    "path": "D:/Music/lofi.mp3",
    "description": "Personal focus mix"
  }
]

Then right-click → Ambient to pick. Shared volume setting:

"animeCompanion.ambientVolume": 30

📁 Custom Local Models

Point at a root folder that contains your local Live2D model subfolders:

"animeCompanion.customModelRoots": [
  "D:/model"
]

Each direct child folder with a .model3.json shows up in the model picker.

For custom display name / description / specific model file, override via:

"animeCompanion.customModels": {
  "my-model": {
    "name": "My Model",
    "path": "D:/model/MyModel",
    "modelFile": "MyModel.model3.json",
    "description": "Custom local model"
  }
}

👗 Outfits & 😊 Expressions from your model

If a model's model3.json lists expression files (FileReferences.Expressions), the companion loads them all right after the model appears and sorts them automatically by what each file drives:

• Files that mostly move facial parameters (ParamEye*, ParamBrow*, ParamMouth*, ParamCheek*, …) show up under right-click › Appearance › Expression. Pick one to see that face; Default hands control back to the mood system.
• Everything else — garment switches with author-named parameters such as ParamC1 or ParamSkirtTr — shows up under Appearance › Outfit. An outfit stays on until you change it; changing expression or mood never undresses the model. Default returns to whatever the .moc3 itself specifies.

No outfit files? If the model carries its costumes as parameters instead — one switch per outfit such as ParamC0 常服, ParamC1 睡衣, ParamC2 毛衣, common in game-exported models — they are offered as outfits automatically (read from the model's cdi3.json), with common names translated (Pajamas, Sweater, …) and the author's name shown as a tooltip. Switches that differ only by a trailing number are treated as one wardrobe, so picking one turns the others off. Default puts the moc's default look back.

Models with no expression files and no costume switches (e.g. Hiyori) get a short note in the popup instead of an empty list.

To let the companion's moods use the model's own drawn faces instead of the built-in presets, map them by name. Models usually call these exp_01, exp_02… so preview each entry in the Expression popup first. One shared map for every model:

"animeCompanion.expressionMap": {
  "happy": "exp_02",
  "shy": "exp_03",
  "angry": "exp_05"
}

Or a map per model id (a per-model entry replaces the shared map for that model):

"animeCompanion.expressionMap": {
  "mao": { "happy": "exp_02", "surprised": "exp_06" },
  "my-model": { "happy": "smile" }
}

Moods: neutral, happy, shy, angry, surprised, sleepy, love, focus. Only entries classified as faces are accepted (an outfit can never be mapped to a mood); unmapped moods keep the built-in preset.

⚙️ Configuration

Right-click the companion → Settings (or run Anime Companion: Open Settings) for the companion's own grouped, searchable settings page. The native view is one click away from its header, or open Settings (Ctrl+,) and search Anime Companion.

⚠️ API keys are NOT stored in settings.json. Always use the Anime Companion: Configure Chat Provider (API Key / Endpoint) command — keys go into VS Code SecretStorage (encrypted). The same command sets the Ollama endpoint.

🎮 Commands

Open the Command Palette (Ctrl+Shift+P) and type Anime Companion:

🛠️ Development

Requirements: Node.js ≥ 18 and npm.

npm install              # Install deps
npm run compile          # Build TypeScript → out/
npm run watch            # Watch mode
npm run package          # Build a .vsix
npm run package:install  # Build + install over local VS Code
npm test                 # Compile + smoke test

Or the all-in-one script that bumps version + packages + installs:

./build-install.sh

Inside VS Code, hit F5 to open the Extension Development Host with the extension loaded.

Structure

src/
  extension.ts          activate, status bar, command registration
  companion-view.ts     WebviewViewProvider, idle bubble timer
  companion-message-dispatcher.ts  webview ↔ extension message routing
  reactive.ts           ReactiveManager — all event hooks
  pomodoro.ts           PomodoroManager
  stats.ts              StatsStore + achievement unlock
  models.ts             MODEL_MAP + workspace model
  model-downloader.ts   Lazy download/extract model zip
  model-server.ts       Local HTTP server for model assets
  git-ops.ts            pull/push/commit with feedback
  messages.ts           Message bank + i18n + custom phrases
  cursor-chibi.ts       Cursor chibi sprite manager
  log.ts                Output channel logger
  chat/                 AI chat module (v0.3.0+)
    chat-manager.ts        Orchestrator: provider routing + streaming
    secrets.ts             SecretStorage wrapper for API keys
    persona.ts             Preset system prompts
    sentiment.ts           Sentiment heuristic → Live2D mood/motion
    conversation-store.ts  Multi-conversation file store
    context-builder.ts     Pack selection / active file / #mention
    sse-parser.ts          Server-Sent Events parser
    llm-provider.ts        Interface + factory
    providers/
      anthropic.ts · openai-compatible.ts · gemini.ts · copilot.ts · ollama.ts

media/
  webview/              Runtime webview (modular)
    main.js · core.js · interaction.js
    audio.js · expression.js · ui.js
    chat.js · chat.css           Chat panel UI
    cursor-chibi.css             Cursor chibi tuning widget (isolated)
  audio/{ja,vi,en}/     MP3 per language
  messages/             Bubble text i18n
  live2d/               Cubism model assets
  lib/                  pixi-live2d-display + Cubism core

📚 Documentation

• docs/README.vi.md — Vietnamese version of this README.
• docs/README.ja.md — Japanese version of this README.
• FEATURES.md — Full feature list.
• MODELS.md — Bundled models, lazy-download, custom local models.
• CHANGELOG.md — Per-version history.
• PLAN.md — Roadmap (current sprint, short-term, mid-term, vision).
• docs/PLAN_v0.3.1.md — v0.3.1 implementation plan + v0.4.0 deferred work.
• CHECKLIST.md — Per-task progress.
• DECISIONS.md — Architecture and technical decisions.
• MODEL_LICENSE_AUDIT.md — License / redistribution notes for models and audio.

📜 License

MIT License.

Live2D Cubism SDK, the Live2D models, VoiceVox audio, and ElevenLabs-generated extended voice assets have their own licenses. Models without clear redistribution rights are no longer shipped with the extension; bring your own via animeCompanion.customModelRoots or animeCompanion.customModels — see MODEL_LICENSE_AUDIT.md.

💖 Credits

• Live2D Cubism Core SDK — Live2D Inc.
• Bundled / standard models: Hiyori, Haru, Mao, Miara (Live2D Sample).
• User-added local models: the user is responsible for licensing when adding via animeCompanion.customModelRoots or animeCompanion.customModels.
• Audio: VoiceVox (Shikoku Metan) for ja; vi / en use bundled audio plus extended voice assets from ElevenLabs.

Made with 🌸 by xShiroeNguyenx.