https://github.com/tanema/petli

A little pet in your console.
https://github.com/tanema/petli

command-line game ruby tamagotchi tamagotchi-game

Last synced: 13 days ago
JSON representation

A little pet in your console.

• Host: GitHub
• URL: https://github.com/tanema/petli
• Owner: tanema
• License: mit
• Created: 2021-07-28T15:09:41.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-12-09T15:43:52.000Z (about 3 years ago)
• Last Synced: 2024-04-23T22:55:27.038Z (9 months ago)
• Topics: command-line, game, ruby, tamagotchi, tamagotchi-game
• Language: Ruby
• Homepage: https://rubygems.org/gems/petli
• Size: 80.1 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  
Petli

  
Virtual Pet in your console. You must feed it, clean up after it, and play with it to keep it happy!

  


    

  

  


    

  


---

### Usage

Run `gem install petli` and then run `petli` in your command line. Run `petli --help` for more information.

### Advanced usage

Petli has a command line api that would allow you to do funky things like

- have mutiple pets using `--path`

- make a separate app that graphs happiness using `petli --status | jq '.health`

- setup a cron job to feed your pet hourly with `petli --bread`

- Your idea here!

```

$> petli --help

Usage: petli [options]

    -r, --reset          Reset button to start over again

    -s, --status         Dump pet status

    -b, --bread          Feed your pet bread without viewing

    -c, --candy          Feed your pet candy without viewing

    -m, --medicine       Feed your pet candy without viewing

    -l, --clean          Clean up any 'dirt' without viewing

    -p, --path [PATH]    Path to your pet data (defaults to system config dir)

```

### Development

```bash

$> git clone [email protected]:tanema/petli.git

$> cd petli

$> bundle install

$> rake install:local

$> petli

```