A terminal-based Tamagotchi simulation written in Go, featuring a beautiful TUI interface.
- ๐ฎ Interactive TUI: Beautiful terminal user interface with keyboard navigation
- ๐พ Digital Pet Care: Feed, play, and put your tamagotchi to sleep
- ๐ Real-time Stats: Monitor hunger, happiness, health, and energy levels
- ๐ Life Stages: Watch your tamagotchi evolve from egg to adult
- ๐ Event History: Track all interactions and milestones
- ๐พ Auto-save: Progress is automatically saved to your config directory
- โฐ Time-based Mechanics: Stats change over time, requiring regular care
- ๐ Restart Feature: Reset to a new tamagotchi with confirmation modal
brew tap ezeoleaf/tap
brew install termagotchi
- Go to Releases and download the binary for your OS.
- Unpack and move it to a directory in your
$PATH
(e.g.,/usr/local/bin
).
- Go 1.24.0 or later
git clone <repository-url>
cd termagotchi
go mod tidy
go build -o termagotchi cmd/termagotchi/main.go
./termagotchi
- Ctrl+S: Status - View tamagotchi stats
- Ctrl+F: Feed - Give food to tamagotchi
- Ctrl+P: Play - Play games with tamagotchi
- Ctrl+L: Sleep - Put tamagotchi to sleep
- Ctrl+E: Events - View game history
- Ctrl+H: Help - Show help page
- Ctrl+R: Restart - Reset tamagotchi to new egg
- Ctrl+C: Quit - Exit the game
- Use arrow keys to navigate lists
- Press Enter to select items
- Use Ctrl+key shortcuts for quick access
- Hunger: 0 = Full, 100 = Starving
- Happiness: 0 = Very Sad, 100 = Very Happy
- Health: 0 = Sick, 100 = Healthy
- Energy: 0 = Tired, 100 = Energetic
- Egg (0-1 days)
- Baby (1-3 days)
- Child (3-7 days)
- Teen (7-14 days)
- Adult (14+ days)
- ๐ Apple: Good nutrition, low weight gain
- ๐ Pizza: High nutrition and happiness
- ๐ฅ Salad: Healthy option
- ๐ Burger: High nutrition but heavy
- ๐ฆ Ice Cream: High happiness boost
- ๐ฅ Carrot: Balanced nutrition
- ๐ซ Chocolate: Happiness boost
- ๐ฅฉ Steak: Maximum nutrition
- ๐พ Play Ball: Classic fun
- ๐โโ๏ธ Run Around: Good exercise
- ๐ต Sing Songs: Low energy, high happiness
- ๐จ Draw Pictures: Creative fun
- ๐งฉ Solve Puzzle: Mental stimulation
- ๐ญ Dance Party: High energy fun
- ๐ Read Books: Educational
- ๐ช Play Hide & Seek: Interactive fun
- ๐ด Short Nap (30 min): Quick energy boost
- ๐ช Medium Sleep (2 hours): Balanced rest
- ๐ด Long Sleep (6 hours): Good recovery
- ๐ด Full Night (8 hours): Complete restoration
- Feed Regularly: Keep hunger below 80 to maintain happiness
- Play Often: Increase happiness and health through games
- Rest When Needed: Put to sleep when energy is low
- Monitor Health: Low health can lead to death
- Balance Stats: Keep all stats in good ranges
- Restart When Needed: Use Ctrl+R to start fresh if your tamagotchi dies
The game automatically saves your progress to:
- macOS:
~/Library/Application Support/termagotchi/config.yml
- Linux:
~/.config/termagotchi/config.yml
- Windows:
%APPDATA%\termagotchi\config.yml
termagotchi/
โโโ cmd/
โ โโโ termagotchi/
โ โโโ main.go
โโโ internal/
โ โโโ app/
โ โ โโโ app.go
โ โ โโโ structs.go
โ โ โโโ pages.go
โ โ โโโ status.go
โ โ โโโ feed.go
โ โ โโโ play.go
โ โ โโโ sleep.go
โ โ โโโ events.go
โ โ โโโ help.go
โ โโโ config/
โ โโโ config.go
โโโ go.mod
โโโ go.sum
โโโ README.md
github.com/gdamore/tcell/v2
: Terminal UI frameworkgithub.com/rivo/tview
: TUI componentsgopkg.in/yaml.v3
: Configuration file handling
This project is licensed under the MIT License - see the LICENSE file for details.
Contributions are welcome! Please feel free to submit a Pull Request.
- Inspired by the classic Tamagotchi digital pet
- Built with the amazing
tview
TUI framework - Thanks to the Go community for excellent libraries