Alustrat / tamaowlchi

Just like the classic Tamagotchi but with owls and inside your terminal

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Tamaowlchi

Your new little (owl) tamagotchi companion.

Summary

I took inspiration from the repository https://github.com/DuncanMcArdle/tamagotchi-cli/tree/master.

The Tamagotchi CLI application is a command-line driven version of the classic Tamagotchi game. Players will attempt to grow an alien Tamagotchi from birth to death, whilst feeding, resting, healing and cleaning up after it along the way.

Installation

Automatic installation is not available yet so you need to manually install it:

Find and download the latest binary for your os from the release page. Extract the executable from the archive and move the executable to a folder that is included in your $PATH. This will let you call the tamaowlchi command from everywhere (you may need to re-open your terminal first).

Edit your .zshrc, .bashrc or .profile to include the following line:

tamaowlchi status

This will give you news about your tamaowlchi every time you open a new terminal and prevent you for forgetting him.

Usage

Start by creating a new tamaowlchi using tamaowlchi new, then you can run tamaowlchi status to see how it goes. If your tamaowlchi die, you can create another one with the same tamaowlchi new command.

Available commands to take care of your tamaowlchi are:

~$ tamaowlchi --help

Usage: tamaowlchi <COMMAND>

Commands:
  new     Create a new tamaowlchi. Only if you don't have any tamaowlchi alive
  clean   Remove all your tamaowlchi poops
  feed    Restore the food of your tamaowlchi to 50
  heal    Restore the heal of your tamaowlchi to 50
  sleep   Put your tamaowlchi to bed
  wake    Wake up your tamaowlchi
  status  Get your tamaowlchi status
  help    Print this message or the help of the given subcommand(s)

Options:
  -h, --help     Print help
  -V, --version  Print version

About

Just like the classic Tamagotchi but with owls and inside your terminal

License:MIT License


Languages

Language:Rust 100.0%