Skip to content

Latest commit

 

History

History
45 lines (36 loc) · 3.06 KB

README.md

File metadata and controls

45 lines (36 loc) · 3.06 KB
Raw

Repogotchi / TamaGit

Winner of Best Overall Project at the 2022 UQCS Hackathon.

Combining Tamagotchis and GitHub to gamify your commits to your repository. A project by Paul Clarke and Miriam Elliott Haynes.

Landing Page

First, you'll need to supply your GitHub Username so we know who you are. Then, get started

Screen Shot 2022-08-29 at 11 12 41 am

Dashboard

The Dashboard is where you see all your Repogotchis. You can view their health, affection, names, and avatars. You can also add and remove Repogotchis from the action bar on the right. Screen Shot 2022-08-29 at 11 13 46 am

Repogotchis

This is your Repogotchi, your new best friend! He's going to help you stay motivated and keep committing to your repository.

  • Each time you commit, your health Repogotchi's health will increase. If health already full, your commits will increase your level experience
  • Come visit yor Repogotchi on our site to increase it's affection. He's your best friend after all, come say hello!
  • At different levels, you can get different accessories. (Such as the crown at level 3!)
  • If your Repogotchi's health or affection starts to drop or reaches 0, his expression will change from a happy face, to a sad face, and eventually a dead one. None-the-less, you can still make a commit and revive your Repogotchi!
  • All Repogotchi avatars are procedurally generated using hand-drawn custom assets.

generic 1

crown accessory

dead repo

Limitations

  • Currently only public GitHub repositories are supported - we would like to change this in future by working with GitHub OAuth
  • Repogotchi level-up accessories are currently limited to just the crown

Known issues

  • When adding a repository thats under a different user/organisation's name, the system is unable to query GitHub for its commits and languages
  • Commits need to be cached. Github rate limits the requests.

Future Plans

  • Redesign of individual Repogotchi page
  • Redesigning the colour scheme

Possible future plans

  • Adding GitHub OAuth integration to allow easier adding of repositories, automatic webhook creation, and support for private repos
  • Auth the requests going to Github to increase the rate limit on requests.
  • Graveyard for dead repogotchis, and a retirement option to pause updates for mature/finished repos
  • Notifications to provide feedback when a repogotchi is fed, or remind users to feed them by committing
  • Additional level-up cosmetics
  • Affection-based cosmetics