Skip to content

README.md

Latest commit

ย 

History

History
108 lines (82 loc) ยท 4.64 KB

README.md

File metadata and controls

108 lines (82 loc) ยท 4.64 KB
 โ–—โ–„โ–„โ––โ–—โ––  โ–—โ––โ–—โ–„โ–„โ–„   โ–—โ–„โ–„โ–– โ–„โ–„โ–„  โ–—โ–žโ–€โ–˜โ–โ–Œ   โ–„ 
โ–โ–Œ   โ–โ–›โ–šโ–žโ–œโ–Œโ–โ–Œ  โ–ˆ โ–โ–Œ   โ–ˆ   โ–ˆ โ–โ–šโ–„โ––โ–โ–Œ   โ–„ 
โ–โ–Œ   โ–โ–Œ  โ–โ–Œโ–โ–Œ  โ–ˆ โ–โ–Œโ–โ–œโ–Œโ–€โ–„โ–„โ–„โ–€     โ–โ–›โ–€โ–šโ––โ–ˆ 
โ–โ–šโ–„โ–„โ––โ–โ–Œ  โ–โ–Œโ–โ–™โ–„โ–„โ–€ โ–โ–šโ–„โ–žโ–˜          โ–โ–Œ โ–โ–Œโ–ˆ

CMDGochi is a lightweight, interactive command-line virtual pet client built entirely with Bash. Manage your digital pets easily from your terminal โ€” create, feed, play with, and monitor your pets' stats in real-time.

๐Ÿพ Overview ๐Ÿพ

CMDGochi brings the nostalgic Tamagotchi experience to your command line interface. Designed for simplicity and fun, CMDGochi lets you interact with multiple virtual pets, track their hunger, happiness, energy, and more โ€” all using intuitive CLI commands.

Whether you're a developer, sysadmin, or terminal enthusiast, CMDGochi offers a playful break from your day without leaving your console.

CMDGochi Screenshot

๐Ÿ‘ค Your Profile & Access

  • ๐Ÿ”‘ Get Your API Key: Sign up and receive your unique API key to connect with your pets.
  • ๐ŸŒ Language support: Ready for multilingual UI (currently Magyar, English, Deutsch, Franรงais, Espaรฑol, Italiano, Nederlands, ฤŒeลกtina, Polski).

๐Ÿ• Meet Your Pets

  • ๐Ÿพ Create New Pets: Give your pets cute names (4โ€“16 characters) and pick their type. You can choose between 8 animals (pet types: cat ๐Ÿฑ, dog ๐Ÿถ, parrot ๐Ÿฆœ, hamster ๐Ÿน, rabbit ๐Ÿฐ, mouse ๐Ÿญ, raccoon ๐Ÿฆ, badger ๐Ÿฆก)
  • ๐Ÿ“‹ See All Your Pets: Check on your furry friendsโ€™ real-time stats whenever you want.
  • ๐Ÿฆ ASCII art: Charming pet visuals right in your terminal.
  • ๐Ÿ—‘๏ธ Say Goodbye: Delete a pet if itโ€™s time to part ways.

๐Ÿ“Š Pet Well beeing

  • โณ Live Pet Stats: Hunger ๐Ÿ—, happiness ๐Ÿ˜Š, energy โšก, and health โค๏ธ update dynamically as time passes.
  • ๐Ÿฉน Watch Their Health: If hunger maxes out, happiness and energy drop, or your pet gets sick ๐Ÿค’ or needs a bath ๐Ÿ›, their health declines.
  • ๐ŸŽ‚ Growing Up: Pets get older and level up every 4 days โ€” unless theyโ€™re feeling really down (health 0), then their growth pauses ๐ŸงŠ.

๐ŸŽฎ Fun & Care Actions

  • ๐ŸŽ Feed Them: Reduce hunger and boost happiness.
  • ๐Ÿงธ Play Together: Lift their mood but watch their energy; too tired means no playtime.
  • ๐Ÿ›Œ Nap Time: Recharge energy but be ready for a bit more hunger.
  • ๐Ÿ› Give a Bath: Keep them clean and healthy. โ€” skipping it hurts their health.
  • ๐Ÿ’Š Give Medicine: Treat sickness and improve wellbeing. Pets can randomly get sick, but you can nurse them back with medicine ๐Ÿคง.

๐Ÿ† Pet Hall of Fame ๐Ÿ†

  • ๐ŸŒŸ Top Pets: See the top 10 oldest pets and get cool stats about levels, age, health, happiness, and types of all pets.

๐Ÿ–ฅ๏ธ SERVER

This API is crafted with Flask and SQLite to offer a fun, simple way to care for your virtual pets and watch them grow.
The API Server run on cmdgochi.mooo.com:5555 domain
For your privacy and security, this server does not store, collect, or retain any sensitive data whatsoever.

๐Ÿ“ฅ Installation

๐Ÿ“‹ Prerequisites

Make sure your system has the following installed:

  • Bash (default on Linux/macOS; on Windows, use Git Bash or Windows Subsystem for Linux (WSL))

  • curl (for sending HTTP requests)

  • A terminal with Unicode support (to properly render ASCII art and special characters)

    ๐Ÿ“ฆ Dependencies

Ubuntu/Debian:

sudo apt-get install jq curl git

Arch Linux /SteamOS:

sudo pacman -S jq curl git

RedHat / CentOS:

sudo yum install jq curl git

Fedora:

sudo dnf install jq curl git

macOS (Homebrew):

brew install jq curl git

๐Ÿ’พ Clone the repository

git clone https://github.com/Pucur/CMDGochi.git
cd CMDGochi
bash cmdgochi.sh

๐Ÿšง Upcoming Features

CMDGochi is actively evolving! Here are some exciting features planned for future releases:

  • ๐Ÿง  Learning New Tricks
    Your pets will be able to learn and perform new tricks over time โ€” if you treat them well!

  • ๐Ÿ’ Marriage System
    Allow your pets to bond and get married, unlocking special interactions and stat bonuses.

  • ๐ŸŽž๏ธ Animated Pets
    Bring your virtual friends to life with ASCII-style animations for actions like walking, playing, or sleeping.