Skip to content

README.md

Latest commit

 

History

History
145 lines (108 loc) · 6.49 KB

README.md

File metadata and controls

145 lines (108 loc) · 6.49 KB
Raw
Code Tamagotchi: Codey, a programmer cat, inside a terminal-inspired Android app

Code Tamagotchi

Raise Codey while you learn to code.

Pomodoro sessions, coding challenges, arcade games and pet-care systems in a local-first Android app.

Download APK View screenshots

APK ready, MIT licensed, Android 7+, Kotlin and Compose UI

English · Español

What It Is

Code Tamagotchi turns programming practice into a pet-care loop. Study with Pomodoro, solve coding challenges, earn XP and Bytes, then use those rewards to keep Codey healthy, rested and evolving.

Study, solve, earn, care and unlock loop

The app is built for Android with Kotlin, Jetpack Compose, Room, DataStore, Koin and WorkManager, with Codey rendered procedurally instead of imported as sprite PNGs.

Screenshots

The project screenshots live in capturas_de_pantalla/ and are shown here in their folder order.

Codey home screen with health, satiety, energy, XP and care actions
01 · Home and care		 Normal programming challenge screen
02 · Coding challenges		 Special algorithm challenge screen
03 · Special challenges
Language badges and progress screen
04 · Language badges		 Focus mode with Pomodoro length selection
05 · Focus mode		 Shop and Codey wardrobe screen
06 · Shop and wardrobe

Matrix Green theme on the Codey home screen
07 · Matrix Green theme

Features

Pet Care: health, satiety, energy, XP, moodlets, care actions and revival Learn By Coding: 117 challenges, 13 languages, algorithms and code review
Focus Rewards: Pomodoro sessions, XP, Bytes and DND-aware focus mode Native Systems: Room, DataStore, WorkManager, Compose Canvas and launcher widget

Project Stats

CodePet stats: version 3.2.0, Android API 24+, 123 total challenges, 13 languages, 12 themes and Room 7

Install

I Just Want To Play

  1. Download the APK from Releases.
  2. Install it on Android 7.0 or newer.
  3. Name Codey and start studying.

I Want To Build It

git clone https://github.com/fguzman-stack/CodePet.git
cd CodePet
./gradlew :app:assembleDebug
adb install -r app/build/outputs/apk/debug/app-debug.apk

On Windows PowerShell, use ./gradlew.bat.

Documentation

The long README content was split into focused docs:

Guide Use it for
Getting Started Build, install and run commands.
Gameplay Pet loop, economy, themes and rewards.
Architecture Stack, package map and app wiring.
Persistence Room, migrations and DataStore.
Rendering Codey, themes and widget rendering.
Testing Unit, Robolectric, lint and screenshot tests.
Localization Spanish/English resources and content.
Roadmap Shipped features and next ideas.

The older Spanish full reference is still available in documentacion.md.

Contribute

The easiest contribution is adding or improving learning content:

  • Add challenges for languages with smaller banks.
  • Improve explanations in Codey's voice.
  • Keep Spanish and English challenge entries synchronized.
  • Report UI bugs with screenshots and device details.
  • Suggest themes, wardrobe items or study rewards.

See CONTRIBUTING.md for the full contributor guide.

License

MIT. Use it, fork it, adapt it and ship it; keep the copyright notice. See LICENSE.

Codey footer illustration

Code Tamagotchi · where bugs become pets and code becomes care.

Made from Chile by fguzman-stack.