> For the complete documentation index, see [llms.txt](https://bizachi-dev.gitbook.io/virtual-pet-game-template/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://bizachi-dev.gitbook.io/virtual-pet-game-template/readme.md).

# Virtual Pet Game Template

Virtual Pet Game Template is a Unity template for pet care games like Pou, Talking Tom and Tamagotchi: 5 pets, 87 clothes, 13 foods, 4 rooms, 11 minigames, rewards, a full shop with in-app purchases a

Virtual Pet Game Template is a Unity template for virtual pet games in the style of Pou, My Talking Tom and Tamagotchi. The player adopts a pet, gives it a name, feeds it, bathes it, dresses it up, puts it to bed and plays minigames with it. The pet's stats go down over time, also while the game is closed, and its face and mood show what it needs.

The template comes with a complete demo game, **Virtual Pet**. Around the pet care loop, it has the systems a game of this genre needs: daily rewards, a lucky wheel, quests and achievements, a season pass, a shop with offers, in-app purchases and rewarded ads. Everything is set up with ScriptableObjects and Inspector fields, and the template runs in the editor without any store or ad account.

<figure><img src="https://1014477811-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fg6WxgzP01isEQjoxBM1R%2Fuploads%2Fgit-blob-4831f7e1f6cf69bb62a0a1b0a8af8ac9eeaef136%2Fgame-living-room.jpg?alt=media" alt="The living room of the demo game with the pet, the stat gauges and the feature buttons"><figcaption><p>The Home screen of the demo game, in the living room.</p></figcaption></figure>

#### What is included

* **5 pets**: Kitty, Egg Buddy, Bunny, Puppy and Fox. Each pet is built from sprites with **procedural animation** (breathing, blinking, squash and stretch, reactions to taps) and a shared face set with **15 expressions** (happy, sad, hungry, tired, sleep, love, surprised and more). A **Pet Builder** window creates a new pet prefab, its icon and its Pet Data from your sprites.
* **Multiple pets and adoption**: the player owns up to 4 pets, adopts new ones in the adoption center and switches between them. Each pet keeps its own name, stats and clothes.
* **Mood and needs**: 6 stats (Hunger, Health, Energy, Hygiene, Fun, Body Fat) that decay in real time, a mood computed from them, and thought bubbles when the pet needs something.
* **87 clothes in 7 slots** (colors, head, eyes, neck, body, feet, back): hats, glasses, scarves, t-shirts, shoes, wings and pet colors. A closet for what the player owns and a boutique to buy more. Every item can be fitted per pet in the Inspector.
* **13 foods** with prices, stat effects and per-pet preferences, a fridge, a food market and drag-to-feed in the kitchen.
* **4 rooms**: Bedroom, Living Room, Kitchen and Bathroom, each with its own actions in the bottom dock and animated light effects.
* **4-step bath**: soap, sponge, shower and towel, with foam, dirt spots and water drops on the pet.
* **11 minigames**: Flappy Pet, Jumping Game, Food Flick, Gem Hunter (match-3), Memory Match, Bug Smash, Pet Says, Pet Dash, Bubble Pop, Tower Stack and Tic-Tac-Toe. They are built at runtime: no scene is needed. A base class lets you write your own.
* **Rewards and engagement**: player level and XP with level-up rewards, 7-day daily rewards, a lucky wheel, daily quests and achievements, a **Pet Pass** (season pass with free and premium tracks), sleep that refills the pet's energy, and local notifications.
* **Monetization**: in-app purchases with **Unity IAP 5**, rewarded, interstitial and banner ads with **LevelPlay** or **Unity Ads**, and a **simulated store and simulated ads** so you can test every purchase and ad in the editor. On top of them: **VIP** subscription, **Remove Ads**, timed **offers**, a **piggy bank**, gem and coin packs.
* **Player Data API**: a public C# API to read the player's progress, grant rewards from your own game or server, and export or import the save.
* **Languages**: English, Portuguese, Chinese, Japanese and Korean, all complete. Every text is a LanguageManager text entry (CSV / JSON / XML import and export) and the content names are translated on their assets. See [Languages and Translations](/virtual-pet-game-template/scene-and-managers/languages-and-translations.md).
* **Setup Wizard**: one window to install the optional packages, create the config assets, fix the render settings, validate the project and test with debug buttons (currencies, XP, time travel).

<figure><img src="https://1014477811-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fg6WxgzP01isEQjoxBM1R%2Fuploads%2Fgit-blob-bc48b902f74cbe0f07e325da7d85d2b40a34edd0%2Fgame-closet.jpg?alt=media" alt="The closet with the clothes slots"><figcaption><p>The closet: the clothes the player owns, one tab per slot.</p></figcaption></figure>

<figure><img src="https://1014477811-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fg6WxgzP01isEQjoxBM1R%2Fuploads%2Fgit-blob-2c51a6dfa67fcb0a3c7531cd29787f5b4c5ddf55%2Fgame-minigames.jpg?alt=media" alt="The minigames list"><figcaption><p>The 11 minigames, unlocked by player level.</p></figcaption></figure>

#### Requirements

* **Unity 6.4** (6000.4.3f1) or newer recommended. Unity 6.0 and newer are supported.
* The **Universal Render Pipeline** with the **2D Renderer**. The template ships its own pipeline asset, `Res/Render/PetCare_URP2D.asset`.
* The **Input System** package (the scene's UI uses it).
* In-App Purchasing, LevelPlay and Mobile Notifications are optional packages: see [Quick Start](/virtual-pet-game-template/getting-started/quick-start.md).
* The template is local: there is no server to run. Progress is saved on the device.

#### Where to start

1. [Quick Start](/virtual-pet-game-template/getting-started/quick-start.md): open the project and play.
2. [Project Structure](/virtual-pet-game-template/getting-started/project-structure.md): where everything is.
3. [Creating a New Pet](/virtual-pet-game-template/pets/creating-a-new-pet.md) and [Creating a New Minigame](/virtual-pet-game-template/minigames/creating-a-new-minigame.md): step-by-step tutorials.
4. [In-App Purchases (Unity IAP)](/virtual-pet-game-template/monetization/in-app-purchases.md): sell your products in the stores.
5. [Player Data API](/virtual-pet-game-template/code-and-integration/player-data-api.md): read and change the player's data from your code.
6. [Building for Android and iOS](/virtual-pet-game-template/getting-started/building-for-mobile.md): the release checklist.

#### Support

Discord: <https://discord.com/invite/EGGj77g3eQ>\
Email: <rafbizachi5@gmail.com>
