From 446f1b6c87e5e91a8d7ac4429859562af68070fd Mon Sep 17 00:00:00 2001 From: xodapi <4956501+xodapi@users.noreply.github.com> Date: Wed, 1 Jul 2026 13:36:52 +0700 Subject: [PATCH] docs(gui): describe creature behavior roadmap (closes #82) Co-authored-by: factory-droid[bot] <138933559+factory-droid[bot]@users.noreply.github.com> --- README.md | 2 +- README.ru.md | 2 +- ROADMAP.md | 27 +++++++++++++++++++++++++++ 3 files changed, 29 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7fb07bf..124d65d 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,7 @@ private prompts. - **Active endpoint failover**: automatically failover between API routers, displaying an active connection badge (`api`/`r-api`). - **Trend sparklines**: 15-day usage graphs rendered inside GUI quota cards. - **Stealth Mode**: mask sensitive numeric values with `***` in the GUI. -- **Living overlay creature**: a floating, color-shifting quota indicator with compact/full modes, skin switching, pulse animation, and Windows sounds on level changes. +- **Living overlay creature**: a floating, color-shifting quota indicator with compact/full modes, skin switching, pulse animation, Windows sounds on level changes, and calm sleep/recovery behavior instead of punishment mechanics. - **Multiple output modes**: human, JSON (`--json`), compact one-line (`--compact`). - **Live TUI monitor** (`--monitor`): ratatui dashboard with gauges, sparklines, color themes. - **Monitor presets**: `full` (2-column grid), `compact` (single-column), `mini` (one-liner). diff --git a/README.ru.md b/README.ru.md index 714a5a7..ae803a0 100644 --- a/README.ru.md +++ b/README.ru.md @@ -44,7 +44,7 @@ vimit --doctor # диагностика системы - **Отказоустойчивый роутер**: автоматический ретрай и failover между роутерами API с отображением статуса активного подключения (`api`/`r-api`). - **Спарклайны трендов**: визуализация 15-дневной истории использования лимитов прямо внутри GUI. - **Скрытый режим (Stealth Mode)**: скрытие точных числовых значений расходов с заменой на `***` в GUI. -- **Живое overlay-существо**: floating-индикатор лимита с компактным/полным режимом, сменой скина, пульсацией, изменением цвета и Windows-звуками при смене уровня. +- **Живое overlay-существо**: floating-индикатор лимита с компактным/полным режимом, сменой скина, пульсацией, изменением цвета, Windows-звуками при смене уровня и спокойным сном/выдохом вместо механик наказания. - **Несколько режимов вывода**: human, JSON (`--json`), compact одной строкой (`--compact`). - **Live TUI-монитор** (`--monitor`): ratatui-дашборд с индикаторами, sparkline, цветовыми темами. - **Пресеты монитора**: `full` (сетка 2 колонки), `compact` (одна колонка), `mini` (одна строка). diff --git a/ROADMAP.md b/ROADMAP.md index f5e7992..fabf8be 100644 --- a/ROADMAP.md +++ b/ROADMAP.md @@ -20,6 +20,33 @@ https://github.com/xodapi/vimit/discussions - Termux:Widget example that runs `vimit --demo` or `vimit --json`. - Optional Android notification through Termux:API. +## Living Token Creature / Живое существо + +The overlay creature is meant to explain quota state without guilt or +punishment mechanics. It reacts to token/credit spend, but it does not die and +does not punish inactivity. When there is no spend for a while, it sleeps. + +Current implemented behavior: + +- `Sleeping`: no recent credit spend, muted color, slower pulse, no sounds. +- `Awake`: normal spend below warning threshold, calm pulse. +- `Alert`: warning threshold, amber state and faster motion. +- `Critical`: danger threshold, red state and fastest motion. +- `Recovery`: detected window reset, short visual "exhale" state. + +Planned improvements: + +- Low-motion and silent modes for distraction-sensitive users. +- User-selectable behavior presets, sound themes, and creature skins. +- Clear event model for sleep, wake, threshold crossing, and reset events. +- Optional Android-friendly presentation that works as a notification/widget + first, then native overlay only if Android permissions and UX are safe. + +Русский: существо "питается" расходом токенов/кредитов, но не умирает и не +голодает. При простое оно спокойно спит, при приближении к лимиту становится +настороженным, при сбросе окна показывает короткий "выдох". Публичное описание +не использует чужие товарные знаки. + ## abtop / Agent Monitoring - Expand the new `--monitor` dashboard with ports/process panes when safe