It renders cat.gif / cat.GIF in the terminal, loops the animation, and plays
music.mp3 when available.
Users do not need to install Python if they download the standalone binaries from GitHub Releases:
[https://github.com/Einswen/SalaryCat/releases/]
- Download one file from the latest release:
- Apple Silicon Macs:
tban-cat-macos-arm64 - Intel Macs:
tban-cat-macos-intel
- Apple Silicon Macs:
- Open Terminal in the download folder.
- Rename it or run it directly. Example for Apple Silicon:
chmod +x ./tban-cat-macos-arm64
./tban-cat-macos-arm64If macOS Gatekeeper blocks it, run:
xattr -d com.apple.quarantine ./tban-cat-macos-arm64
./tban-cat-macos-arm64- Download
tban-cat-windows.exefrom the latest release. - Open Windows Terminal or PowerShell in the download folder.
- Run:
.\tban-cat-windows.exeIf Windows SmartScreen warns about an unknown app, choose "More info" and then "Run anyway".
The standalone binaries include the bundled cat.GIF and music.mp3. You can
still place your own cat.gif and music.mp3 in the same folder to override
them.
- Python 3.10+
- A modern terminal with ANSI TrueColor support:
- macOS Terminal
- iTerm2
- Windows Terminal
- modern Linux terminals
Python dependency:
- Pillow
Audio playback uses system tools:
- macOS:
afplay - Windows: PowerShell MediaPlayer
- Linux: one of
ffplay,mpv,mpg123,cvlc, orplay
If no supported audio player is found, the animation still runs.
From this project directory:
python3 -m pip install .Recommended for command-line tools:
python3 -m pip install pipx
pipx install .After installation, run:
tban-catRun tban-cat in a directory containing:
cat.gif
music.mp3
The GIF name is case-tolerant for common variants such as cat.GIF.
The music file is optional.
This repository also includes a cute Maltese puppy character animation:
maltese.gif
tban-cat
tban-cat --gif maltese.gif
tban-cat --fps
tban-cat --scale 0.8
tban-cat --margin-rows 1
tban-cat --no-music
tban-cat --music music.mp3Sharper pixel-art rendering is the default. For smoother scaling:
tban-cat --smoothTo use half-block rendering:
tban-cat --half-blockSome terminals render half-block characters with visible horizontal seams. The default solid-block mode avoids that.
Run directly without installing:
python3 -m pip install -r requirements.txt
python3 main.pyRecord a short video of the project source code being typed into the terminal:
python3 code_typewriter.pyUseful recording options:
python3 code_typewriter.py main.py gif_loader.py --speed 120
python3 code_typewriter.py --max-lines 120 --hold 5
python3 code_typewriter.py --plain --no-line-numbersBuild a standalone binary locally:
python3 -m pip install ".[build]"
python3 -m PyInstaller --onefile --name tban-cat --add-data "cat.GIF:." --add-data "maltese.gif:." --add-data "music.mp3:." main.pyOn Windows, use semicolons in --add-data:
py -m pip install ".[build]"
py -m PyInstaller --onefile --name tban-cat --add-data "cat.GIF;." --add-data "maltese.gif;." --add-data "music.mp3;." main.pyCheck syntax:
python3 -m py_compile audio_player.py gif_loader.py renderer.py main.py code_typewriter.pyApache License 2.0. See LICENSE.