Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

26 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

DevPet โšก

๐Ÿ‡ฌ๐Ÿ‡ง English ย ยทย  ๐Ÿ‡ฉ๐Ÿ‡ช Deutsch

A hand-animated coding buddy that lives on your desktop, watches you code, and writes your dev diary.

MIT License Electron Platform: Windows Two native dependencies Made with love and Claude

DevPet โ€” all five skins side by side, idling on the desktop

DevPet sitting on the desktop

5 hand-animated characters ยท each with up to 8 unique animations ยท 100% local ยท privacy-first ยท no account ยท no telemetry


DevPet is a tiny desktop pet for Windows built with Electron + pure Node. A small hand-animated "coder" character sits on your desktop inside a transparent, always-on-top, click-through window. It watches your coding activity, reacts live, and writes you an automatic developer diary in English or German. It's gamified with XP, levels, coins, and unlockable skins โ€” and it's 100% local: no account, no telemetry, no cloud.

โœจ Features & Highlights

๐ŸชŸ Lives on your desktop A transparent, always-on-top window that's click-through everywhere except over the pet itself โ€” it never steals focus or blocks your clicks.
๐ŸŽฌ Hand-animated 5 characters, 1 free + 4 unlockable, each with up to 8 unique animations, rendered as smooth transparent VP9 WebM with real alpha and crossfaded by a 2-layer video engine.
๐Ÿง  Watches you code Three local activity sources โ€” git commits, file edits/bursts, and AI coding sessions (Claude Code + Codex) โ€” each independently toggleable.
๐Ÿ’ฌ Reacts live On every detected event it plays a reaction, shows a DE/EN speech bubble, and can speak it aloud via free Edge TTS (each skin has its own voice).
๐Ÿ“” Auto dev diary Daily entries generated from your real activity, grouped by project, with stats โ€” works fully offline, optionally enhanced by an AI provider.
๐ŸŽฎ Gamified Earn XP and coins as you code, level up with confetti, and spend coins in the built-in Coin Shop to unlock new skins.
๐Ÿ”’ Privacy-first Everything runs on your machine. The only thing that can ever leave is an optional AI diary summary โ€” with your own API key, only if you turn it on.
๐Ÿชถ Lightweight Still just two native runtime deps โ€” uiohook-napi + nut-js power the macro engine; everything else is pure Node + Electron. (jimp is dev-only tooling.)
โš™๏ธ Automate the boring stuff Record & replay mouse+keyboard macros, and let DevPet spot repetitive actions and suggest turning them into one โ€” always reviewed & approved by you, never auto-run.
๐Ÿ† Real coding companion Achievements, coding streaks, a Pomodoro focus timer, gentle wellness nudges, and an ask-your-pet chat grounded only in your real stats.

๐ŸŽฌ Meet the Squad

5 hand-animated coder characters โ€” one free default, four unlockable in the in-app Coin Shop.

Emoji Name Personality Status
โšก Volt Energetic BVB-yellow spark Free default
๐Ÿ”ฅ Blaze Fiery and effortlessly cool Unlock for 600 ๐Ÿช™
๐Ÿ’ซ Nova Cosmic dreamer with starlight in their eyes Unlock for 1500 ๐Ÿช™
๐Ÿ˜ˆ Hex Dark trickster who codes by candlelight Unlock for 3000 ๐Ÿช™
๐Ÿ‘‘ Root The crowned superuser โ€” root access to everything Unlock for 5000 ๐Ÿช™

All five DevPet skins side by side

Every skin shares a core animation set, and each one has an exclusive personal signature move that plays once when your mouse approaches.

โšก Volt โ€” the energetic spark

Volt animations: Idle, Look, Signature, Cheer, Stand up, Grab

Idle ยท Look ยท Signature (a football/soccer goal celebration โšฝ) ยท Cheer ยท Stand up ยท Grab

๐Ÿ”ฅ Blaze โ€” fiery cool

Blaze animations: Idle, Look, Signature, Cheer, Stand up, Grab

Idle ยท Look ยท Signature (a cool flame snap ๐Ÿ”ฅ) ยท Cheer ยท Stand up ยท Grab

๐Ÿ’ซ Nova โ€” cosmic dreamer

Nova animations: Idle, Look, Signature, Cheer, Sleep, Grab

Idle ยท Look ยท Signature (a starlight call ๐Ÿ’ซ) ยท Cheer ยท Sleep ยท Grab

๐Ÿ˜ˆ Hex โ€” dark trickster

Hex animations: Idle, Look, Signature, Cheer, Sleep, Grab

Idle ยท Look ยท Signature (a dark-power rune circle ๐Ÿ˜ˆ) ยท Cheer ยท Sleep ยท Grab

๐Ÿ‘‘ Root โ€” the crowned superuser

Root animations: Idle, Look, Signature, Cheer, Coding, Sleep, Grab

Idle ยท Look ยท Signature (a royal command ๐Ÿ‘‘) ยท Cheer ยท Coding (an exclusive typing animation during AI/coding sessions) ยท Sleep ยท Grab

The animation set

Animation When it plays
๐Ÿช‘ Idle Sits and works at the keyboard.
๐Ÿ‘€ Look Reacts and notices when your mouse cursor comes near.
โญ Signature An exclusive personal move, unique per skin, plays once when your mouse approaches.
๐ŸŽ‰ Cheer Celebrates on a git commit, on level-up, or when you click/poke it.
๐Ÿ˜ด Sleep Dozes off after 75 seconds of inactivity ๐Ÿ’ค.
๐ŸŒ… Stand up Wakes back up when you return.
โœŠ Grab A "picked-up" reaction while you drag it around.
โŒจ๏ธ Coding Root ๐Ÿ‘‘ only โ€” an extra exclusive typing animation during AI/coding sessions.

๐Ÿง  What it watches

DevPet has three local monitors. They never touch the network โ€” they read activity from your own machine, and each one can be toggled on or off.

Monitor What it does Reward
๐ŸŒฑ Git commits Watches the git history of your watched folders. ๐Ÿ† the biggest reward
๐Ÿ“ File edits / bursts Notices when you're actively editing files in your watched folders. small
๐Ÿค– AI coding sessions Reads Claude Code (~/.claude/projects/**/*.jsonl) and Codex session logs to notice when you're pair-programming with an AI. medium

When something is detected, the pet plays a reaction animation, pops a speech bubble comment (DE/EN), and can speak it aloud. A level-up triggers a celebration with confetti and a spoken cheer. ๐ŸŽŠ

๐Ÿ“” The Dev Diary

A separate window that writes your developer diary for you. Daily entries are generated from your real activity, grouped by project, with stats: commits, files touched, AI sessions, and the time span you worked.

The DevPet Dev Diary window showing stats and an activity feed

๐Ÿ’ก The diary works fully offline with a built-in template writer (English and German). Optionally, it can be enhanced by an AI provider for nicer prose and per-project summaries โ€” DeepSeek (cheapest, preferred), MiniMax, or Claude/Anthropic. API keys are 100% optional and are never required for the core app.

Open the diary by double-clicking the pet or via the tray.

๐ŸŽฎ Leveling & Coin Shop

Your pet levels up as you code. Every event earns XP and coins ๐Ÿช™ โ€” commits are worth the most.

Event XP Coins ๐Ÿช™
๐ŸŒฑ Git commit 25 10
๐Ÿค– AI session 8 3
๐Ÿ“ File burst 3 1
โฌ†๏ธ Level-up bonus โ€” +20

The level curve is a smooth square-root curve:

Level 2 3 4 5 โ€ฆ
Total XP 50 200 450 800 โ€ฆ

Spend your coins in the built-in Coin Shop (inside the diary window) to unlock new skins โ€” Blaze, Nova, Hex, and Root. Your level and coin balance also show in the tray.

The DevPet Coin Shop showing unlockable skins

๐Ÿ•น๏ธ Interactions

Action Result
๐Ÿ–ฑ๏ธ Drag Move the pet anywhere on screen.
๐Ÿ–ฑ๏ธ Mouse-wheel scroll over it Resize the pet.
๐Ÿ–ฑ๏ธ๐Ÿ–ฑ๏ธ Double-click Open the Dev Diary.
๐Ÿ‘‰ Click / poke Makes it cheer and speak.
๐Ÿ–ฑ๏ธ Right-click Opens the context/tray menu.

Tray menu: switch skin ยท open diary ยท reset position to screen ยท toggle autostart ยท quit.

The window is click-through everywhere except over the pet itself, so it never gets in the way of your work.

โš™๏ธ Macro Recording & Replay

DevPet is now a lightweight automation tool too. Press Ctrl+Alt+R to start recording your mouse and keyboard, do the thing once, then press it again to stop. You get a humanized, human-readable summary of exactly what you did โ€” real steps, not a step count โ€” so you can review it, give it a name, and save it. Replay any saved macro with Ctrl+Alt+P (or a โ–ถ click in the diary), and DevPet tracks the time you saved.

๐Ÿ›‘ Safety-first by design. Every replay starts with a 3-second countdown bubble so you can switch to the right window (or bail). Replays only ever run on an explicit action โ€” a hotkey or a โ–ถ click. Nothing is ever recorded, saved, or replayed automatically.

๐Ÿ” Smart Pattern Detection

Coding is full of little repeats. DevPet quietly notices when you do the same short action โ€” or type the same phrase โ€” 3ร— in a row, even across apps (copy in Excel โ†’ switch โ†’ paste in Outlook), and pops up a friendly "noticed that 3ร— nowโ€ฆ" bubble with a suggestion in the diary to turn it into a macro.

  • ๐Ÿ‘€ It only ever suggests โ€” you review and approve, exactly like a manual recording. It never auto-saves or auto-runs.
  • ๐Ÿ”’ Sensitive windows are hard-excluded from typed-text detection โ€” password managers, banking, login/sign-in forms, and .secrets windows are never buffered, not even transiently.
  • ๐ŸŽš๏ธ It's its own explicit, visible toggle (bigger privacy footprint than the rest of the app), off-limits by a single switch.

๐Ÿ† Achievements

13 unlockable trophies, each with a progress bar for the ones you haven't earned yet.

Trophy How to earn it
๐Ÿ“ฆ First Commit Make your first commit
๐Ÿ“ฆ Committed / ๐Ÿ—๏ธ Builder 50 / 250 commits
๐Ÿฆ‰ Night Owl 10 commits after 11pm
๐Ÿค– AI Teamwork 25 AI coding sessions
โš™๏ธ Automator Approve 10 macros
โฑ๏ธ Time Saver Replay macros 50ร—
๐ŸŽฏ Focused / ๐Ÿง˜ Deep Work 10 focus sessions / 10 hours of focus time
๐Ÿ”ฅ Week / Month / ๐Ÿ’Ž Century 7- / 30- / 100-day streaks
โญ Level 10 Reach level 10

๐Ÿ”ฅ Coding Streaks

Keep the fire alive โ€” DevPet tracks a daily coding streak that grows every day you're active. Life happens, so you can spend coins on ๐ŸงŠ freeze tokens that bridge one missed day (just like a streak-freeze) and keep your run going.

๐ŸŽฏ Focus Sessions

A built-in Pomodoro timer (default 25 min) with a live countdown. Finish the full session and it feeds the Focused and Deep Work achievements โ€” stop early and, like a real Pomodoro, you get nothing. Same "finish what you start" incentive.

๐Ÿง˜ Wellness Nudges

During a long, unbroken coding stretch (default after 90 minutes), DevPet gives you a gentle stretch/water reminder โ€” "you've been at it a while, quick stretch, water, rest your eyes?" Purely a heads-up bubble tied to real work signals: no extra capture, no diary log, no XP.

๐Ÿ’ฌ Ask Your Pet

A chat right inside the diary where you can ask questions about your own coding activity โ€” "how many commits this week?", "what did I work on most?" The pet answers grounded only in your real stats (no made-up facts), using the same optional AI key as the diary (DeepSeek / MiniMax / Claude). It keeps session-scoped memory so follow-up questions just work.

๐Ÿ“ฑ Mobile Companion (LAN)

A tiny read-only, token-gated local web page so a phone on the same WiFi can glance at your pet โ€” level, streak, coins, and the focus countdown. It runs on port 4827 and never exposes diary text, prompts, or keystrokes โ€” just the same handful of numbers already in the tray tooltip.

โ˜๏ธ Optional Cloud Relay

Want to check on your pet from anywhere, not just the same WiFi? You can opt in to a cloud relay โ€” a Cloudflare Worker you deploy yourself that receives the same tiny status snapshot.

โš ๏ธ This is the only path where any data ever leaves your machine. It's OPT-IN and OFF by default, and even then it only ever sends the tiny gamification snapshot (level, streak, coins, focus countdown, last reaction line) โ€” never any activity content, diary text, macros, or keystrokes.

๐Ÿ–ผ๏ธ Shareable Recap Card

One click generates a polished PNG "coding week/day" card โ€” commits, files touched, AI sessions, time saved, level, and streak โ€” saved to an exports folder and copied to your clipboard, ready to paste anywhere you want to show off your week. ๐ŸŽ‰

๐Ÿ”’ Privacy & API keys

  • 100% local by default. No account. No telemetry. No cloud sync.
  • ๐Ÿ” Pattern detection watches local keystrokes/clicks in the background to spot repeats โ€” it's toggleable, sensitive windows are excluded, and nothing is ever sent anywhere. Recorded macros are stored locally.
  • ๐Ÿ“ฑ The LAN mobile page is same-WiFi only, token-gated, and read-only โ€” it never accepts writes and never leaves the local network.
  • โ˜๏ธ The cloud relay is the only opt-in path off your device โ€” OFF by default, and it only ever pushes the tiny status snapshot (no activity content).
  • ๐Ÿค– The only thing that leaves via AI is an optional diary summary / ask-your-pet answer โ€” generated with your own API key, only if you choose to enable it.
  • API keys are optional and stored locally in .secrets/ or via environment variables. They are never required โ€” without one, the diary uses the built-in offline template writer.

๐Ÿš€ Getting Started

Requirements: Node 18+ and Windows 11 (the pet window is tuned for Windows).

git clone https://github.com/MauricePutinas/devpet
cd devpet
npm install
npm start

That's it โ€” your pet appears on the desktop. ๐ŸŽ‰

โš™๏ธ About npm install: it now also pulls in the two native modules for the macro engine (uiohook-napi + nut-js). On Windows 11 these ship as prebuilt binaries, so there's usually nothing to compile โ€” install just works.

๐ŸชŸ Windows one-click: instead of the terminal you can just double-click Start DevPet.bat โ€” it installs dependencies on first run and launches the pet (no console window stays open).

Optional โ€” enable AI diary summaries: drop an API key file in .secrets/deepseek.key (or .secrets/minimax.key). Otherwise the diary happily uses the offline template writer.

๐Ÿงฉ Tech & How it's built

  • Electron + pure Node โ€” only two native runtime deps: uiohook-napi (global input capture for recording & pattern detection) and @nut-tree-fork/nut-js (input playback for macro replay). Everything else is pure Node. (jimp is a dev-only asset tool.)
  • Transparent pet window โ€” always-on-top, click-through, focus-safe, tuned for Windows 11.
  • 2-layer video engine โ€” crossfades between transparent VP9 WebM clips with real alpha for buttery-smooth transitions.
  • Asset pipeline โ€” raw hand-drawn animations are run through a pipeline (scripts/normalize-poses.js, scripts/process-chroma.js, โ€ฆ) that chroma-keys, floor-anchors, and exports each pose as a clean transparent WebM.
  • Local monitors โ€” git, file-watch, and AI-session readers, all on-device.
  • Macro engine โ€” a recorder, a humanized-step summarizer, and a countdown-gated player, plus click- and typed-text pattern detectors that only ever suggest.
  • Tiny local HTTP server โ€” Node's built-in http powers the token-gated, same-WiFi mobile page (no extra dependency).
  • Free Edge TTS โ€” gives every skin its own voice with no API cost.

๐Ÿ“ Project Structure

devpet/
โ”œโ”€ src/
โ”‚  โ”œโ”€ main/                # Electron main process
โ”‚  โ”‚  โ”œโ”€ monitors/         # git, file & AI-session watchers
โ”‚  โ”‚  โ”œโ”€ automation/       # macro engine + pattern detection
โ”‚  โ”‚  โ”‚                    #   recorder ยท player ยท macroStore ยท humanize
โ”‚  โ”‚  โ”‚                    #   patternDetector ยท textPatternDetector
โ”‚  โ”‚  โ”‚                    #   keymap ยท sensitiveWindows ยท activeWindow
โ”‚  โ”‚  โ”œโ”€ diary/            # diary store + reporter
โ”‚  โ”‚  โ”œโ”€ streaks.js        # daily coding streak + freeze tokens
โ”‚  โ”‚  โ”œโ”€ lanServer.js      # read-only, token-gated same-WiFi status page
โ”‚  โ”‚  โ”œโ”€ tray.js ยท tts.js  # tray menu + Edge TTS voices
โ”‚  โ”‚  โ””โ”€ progress.js       # XP, levels & coins
โ”‚  โ”œโ”€ preload/             # context-bridge API
โ”‚  โ”œโ”€ renderer/
โ”‚  โ”‚  โ”œโ”€ pet/              # transparent pet window + state machine
โ”‚  โ”‚  โ”œโ”€ diary/            # dev-diary, Coin Shop, macros & ask-your-pet UI
โ”‚  โ”‚  โ””โ”€ recap/            # shareable recap-card renderer (โ†’ PNG)
โ”‚  โ””โ”€ shared/              # creatures list, achievements, shared helpers
โ”œโ”€ scripts/                # asset pipeline (raw anim โ†’ transparent WebM)
โ”œโ”€ cloudflare/             # optional opt-in cloud-relay Worker
โ””โ”€ assets/
   โ””โ”€ creatures/<id>/      # per-skin WebM animations + thumbnails

๐Ÿ“œ License

Released under the MIT License. Built with โค๏ธ and Claude by Maurice.


๐Ÿ“ Changelog

๐Ÿค– This section updates automatically on every push via a GitHub Action, so anyone can see exactly what changed and when.

2026-07-05

  • ๐Ÿ› fix: re-encode all 13 new Volt clips โ€” black-frame alpha bug 9d41e41
  • โœจ feat: 12 new Volt animation variants + variant-rotation system + auto-copy on selection 30c73aa

2026-07-02

  • ๐Ÿ› fix: config resets can no longer happen (three-layer guard) 6b61229

2026-07-01

  • โœจ feat: refreshed icon set (sheet 82) + Volt hacking animation + DeepSeek option ff97e59
  • โœจ feat: pixel-art Volt idle + AltGr text capture + trophy/icon art 88d56ce
  • โœจ feat: automation engine (macro record/replay + pattern detection), achievements, streaks, focus timer, wellness nudges, ask-your-pet chat, LAN companion + cloud relay, shareable recap card; fix German QWERTZ text detection & recap export dialog b42c615

2026-06-30

  • โœจ feat: automatic daily & weekly DeepSeek reports + activity cards show edited files and expand on click 52ad5e6

2026-06-29

  • ๐Ÿ› fix: stop .gitignore from excluding src/diary dirs โ€” add missing diary UI + reporter + store a64749d
  • โœจ feat: crash-proof config (auto-backup + atomic write + recovery) and live-refresh the diary on focus 31c7e55
  • ๐Ÿ› fix(changelog): match the bot's update commits by subject prefix, keep human commits 61e5d6c
  • ๐Ÿ› fix(changelog): exclude the bot's own [skip ci] commits from the changelog 4b1c364
  • โœจ feat: add one-click Start DevPet.bat launcher (Windows) + README note bec4eae
  • ๐Ÿ“ docs: lighter, funnier LinkedIn post (just-for-fun vibe) 14216ba
  • โœจ feat: initial release โ€” DevPet desktop pet with auto dev-diary, 5 animated skins & gamified coin shop 939642a

โšก DevPet โ€” your code has a witness now.

About

A cute desktop pet that watches you code & writes your dev diary ๐Ÿพโšก โ€” Electron, 5 animated skins, gamified coin shop, auto changelog.

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages