> For the complete documentation index, see [llms.txt](https://bizachi-dev.gitbook.io/farm-village-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/farm-village-template/farm-village-template.md).

# Farm Village Template

Farm Village is a Unity template for social farming games: crops, animals, crafting, fishing, orders, friends, a player market and co-ops, with an authoritative multiplayer server and a full offline m

Farm Village is a complete farming game template for Unity 6.6 and URP, built around the systems a live social farming game needs. Players plant and harvest crops, raise animals in their pens, craft goods in bakeries and dairies, fish in the lake, fill orders, expand their land and decorate their farm, then visit friends, help them out, trade on the player market and team up in co-ops.

It comes with its own **authoritative multiplayer server** with full source code, and the same game also runs **100% offline** with a local save. You switch between the two with one setting.

<figure><img src="https://871056888-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FqEyB7UmQAz6tOGTXuiDs%2Fuploads%2Fgit-blob-e6801c4912f495ef69d834cc9ae3ed800691c1e7%2Ffv-game-farm-hud.jpg?alt=media" alt="The farm of the template" width="640"><figcaption><p>The farm: fields, pens, production buildings and the HUD.</p></figcaption></figure>

#### What is included

* **Farming**: till, plant, water, fertilize and harvest on a grid farm, with growth timers decided by the server clock. Watering cuts the growing time and raises the yield; fertilizer and sprinklers speed crops up even more. Seasons and weather change growth, and the land expands in eight steps.
* **Build mode**: a placement grid with a floating ghost. The **Edit** button (or holding an object) moves any field, building or pen, or removes it for part of its cost back.
* **Animals, pens and orchard**: chickens, cows, sheep and pigs in their own pens with slots, fed to produce eggs, milk, wool and truffles; one tap on a pen collects everything ready or feeds every hungry animal. An orchard with apple, cherry and mango trees, pets and wildlife.
* **Crafting**: a bakery, a dairy, a loom and a juice press with 16 recipes, production queues, upgrades and hired workers.
* **Fishing** in the lake, with energy, a wait and a fish drawn on the server by rarity and level.
* **Goals**: daily orders, quests in chapters, XP and levels, a 7-day daily reward, specializations, timed research and live events, and a 15-step guided tutorial with a pointing hand and a spotlight.
* **Friends and visits**: friend requests, online presence, player search, blocks and reports, gifts, mail and farm privacy. Visit a friend's farm to water their crops, feed their animals and deliver the orders they asked help with.
* **Player market and co-ops**: listings held in escrow, atomic purchases, fees, a price band and expiry; co-ops with leaders, donations and a weekly goal.
* **Accounts**: play at once as a guest with a random name, rename the farm, link an email later; login, password reset, email verification, and sessions kept in the Android KeyStore and the iOS Keychain.
* **Real-money gem packs** for Google Play and the App Store: the server verifies every receipt, grants it once and applies verified refunds.
* **Authoritative server**: Node.js 24, TypeScript, Express 5 and [Colyseus](https://colyseus.io) 0.18, with MariaDB. 63 command types; every result is saved in a database transaction, and a retried command never pays twice. The rules exist in C# (offline) and TypeScript (server), kept identical by parity tests.
* **GM console**: a web page for players, compensations, bans and reports, game data versions, live events, metrics and an audit log.
* **Cozy 3D world**: a Cozy Toon URP shader with tinted shadows, rim light, wind sway and a selection glow; low-poly farm models and 20 animated animals, with tap reactions, ready bubbles, flying rewards and effects. Scenery baking, GPU instancing for crops and UI sprite atlases for phones.
* **Everything is data**: every crop, item, animal, building, recipe, order, quest, shop offer and balance value is a ScriptableObject, exported to the server in one click.
* **Languages**: English, Portuguese, Chinese, Japanese and Korean.
* **Ready to deploy**: a step-by-step guide to put the server on an Ubuntu VPS with HTTPS.

<figure><img src="https://871056888-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FqEyB7UmQAz6tOGTXuiDs%2Fuploads%2Fgit-blob-e779dc73ec8de0877826aa0eb7491f24415e0242%2Ffv-game-production-bakery.jpg?alt=media" alt="The bakery production screen" width="640"><figcaption><p>Production: recipes, the queue and workers.</p></figcaption></figure>

#### Demo content

6 crops, 21 items, 4 farm animals with their pens, 3 fruit trees, 4 production buildings with 16 recipes, 3 fish, 14 orders, 14 quests, 15 decorations, 6 shop offers and 2 gem packs. Use them as examples: the [Adding New Content](/farm-village-template/game-data/adding-new-content.md) page builds a crop, an animal and a building step by step.

#### Requirements

* **Unity 6.6** (6000.6.7f1 or newer) with the **Universal Render Pipeline** and the **Input System**.
* Platforms: Android, iOS, WebGL and Windows.
* For the online backend: **Node.js 24** or newer and **MariaDB 11.4 LTS** (10.5 or newer).

#### Where to start

1. [Quick Start Overview](/farm-village-template/getting-started/quick-start-overview.md): open the project, press Play, and choose between the two backends.
2. [Offline Backend](/farm-village-template/getting-started/offline-backend.md): play without a server.
3. [Online Backend](/farm-village-template/getting-started/online-backend.md): run the server on your computer and play online.
4. [Game Instance](/farm-village-template/scenes-and-managers/game-instance.md): the list of every piece of game data you can edit.
5. [Deploying the Server on Ubuntu](/farm-village-template/getting-started/deploying-the-server-on-ubuntu.md): put your game online.

#### Support

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