Skip to content

terpinedream/tuxagotchi

Repository files navigation

Tuxagotchi (Textual Edition)

Tuxagotchi is a terminal-based companion that thrives on your GitHub activity.
This version is a full refactor using Textual, providing a responsive and animated terminal UI featuring a commit-based mood system, interactive TODO list, and a real-time audio visualizer powered by Cava.

Screenshot Screenshot Screenshot


Features

  • ASCII-rendered Tux avatar that reacts to your GitHub commit history and displays animated emotional states
  • Mood-based animation system using 6 ASCII frames (2 per mood: happy, neutral, sad)
  • Countdown timer indicating when Tux will become hungry again
  • Interactive TODO list with vim motions
  • Real-time audio visualizer integration using Cava
  • Customizable and modular architecture using Textual's widget system
  • Keybind hint bar at the bottom for user guidance

Installation

Arch Linux Users: Install with yay

yay -S tuxagotchi

Other | please note: non-linux users should clone from the 'no-cava' branch to avoid conflicts

  1. Clone the repository:

    git clone https://github.com/terpinedream/tuxagotchi.git
    cd tuxagotchi
  2. Install Python dependencies:

    pip install -r requirements.txt
  3. Install external dependencies:

    • Cava is required for the audio visualizer:
      • Arch Linux:
        sudo pacman -S cava
      • Debian/Ubuntu:
        sudo apt install cava
      • Or build from source
  4. Create a config.toml file in the root directory with the following structure:

    [github]
    username = "your-github-username"
    repo = "your-repo-name"
    token = "your-repo-token"

Running the Application

AUR Package

tuxagotchi

From Source

python3 -m textual_app.app

WORKING ON INTEGRATION WITH SPOTIFY CAR THING

Author

Maintained by @terpinedream

About

CLI application that encourages you to keep up with your projects. "Feed" tux in your terminal by pushing your code to github.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages