Log inGet started
World

Thriving Town: City Builder and Idle Town Kit

README.md

Thriving Town: City Builder and Idle Town Kit

Grow Willowmere from an empty plot in a forest clearing into a capital city, alone or with friends. Place house plots and settlers move in when the town is a nice place to live; give their street a well, a clinic, a tavern, a school, a temple, parks, fountains and statues and their huts grow into cottages, townhouses and manors. Happy towns pay more taxes, farms and bakeries feed the town, markets sell for coins, and the town climbs from Hamlet to Village, Town, City and Capital, unlocking buildings at every rank. Come back tomorrow and a welcome-back screen tells you what your town earned while you were away.

Play: press Play. B build · O coverage overlay · =/− taxes. Gamepad: left stick walks and moves the build cursor, Y build, RT place, B close, d-pad left/right taxes, d-pad up upgrades the home you stand by, View overlay. Touch: the Build button and the buttons on the town banner.

Make your own (about five minutes)

  1. Install townKit from ZeroMind (ZeroMind panel → "townKit" → Install). It brings about thirty kits, so the first install takes a few minutes.
  2. Make an empty scene: zero scene create --startup main empty (or New Scene → Empty).
  3. Replace its build.luau with:
function content()
    require("townKit.town").scene("forestClearing", { status = "banner", mood = "faces", rules = "classic" })
end
  1. Press Play, press B, and place a House Plot a few steps from the well (inside its ring, O shows it) with a Flower Bed beside it. Settlers move in within seconds.

This quick start was followed word for word in a brand-new world, from install to the first settlers.

Guides inside the package: How to make a city builder or idle town game and Example: add a new building and a new upgrade tier.

Swap with one setting: 4 starter towns (forestClearing, riversideMarket, hilltopTerraces, scifiColony), 3 town ladders (medieval, scifi, cozyHamlet), 4 happiness rule sets (relaxed, classic, strict, idle), 6 status displays (banner, card, ledger, minimal, pixel, hologram), 6 home moods (faces, hearts, thumbs, roofColour, pixelEmotes, scifiSymbols), 15 services and decorations, and rangeKit's 8 overlay looks.

Kits it installs (one copy of each)

KitVersionFromUsed for
townKit1.1.7this worldthe city builder itself: homes, happiness, taxes, tiers, the town ladder, the welcome-back screen
rangeKit1.0.1Within Reach (built for this kit, its own world)services cover homes within range; area preview while placing; coverage overlays
productionKit1.4.0Mill to Marketfarms, bakeries, mills, markets, bread, offline catch-up, big idle numbers
buildPlaceKit1.0.34Raise the Roofbuild mode with a ghost preview, prices, refunds, saved pieces, locked pieces shown locked (1.0.27 to 1.0.33 add the draw, spec, allow and redraw hooks, the touch fixes, the locked look and gamepad building townKit needed)
gridKit1.0.13Cell by Cellgrid snapping under buildPlaceKit
economyKit1.2.11Market Squarecoins, wallets, the bank that runs the town
saveKit1.3.10Save Pointeach player's last visit for their welcome-back screen
unlockLadder1.0.0Crumple Zoneruns the town's ranks and their unlocks, kept in the shared town record
barsKit1.4.6Gaugeworkshappiness meters
scoreKit1.4.8Hall of Fameleaderboard bonus on every rank-up
clearedForest1.0.0Summit Sprintthe forest around the clearing, kept clear where the town grows
forestKit0.3.1Beechwood Brooktrees, forest atmosphere and footsteps
worldClockKit1.6.8Skyclockthe shared day and night clock
styleKit1.8.3Style Cookbookthe stackable art-style look
toonBlocks1.4.5Style Cookbookthe warm, cozy look (soft wrap light, warm fill, pencil line, vignette, grain)

Other kits arrive as dependencies of those: inventoryKit 1.0.24, juiceKit 1.2.10, menusKit 1.3.13, navUiKit 1.3.7, controlsKit 1.3.1, MatchFlow 1.4.0, Lifeline 1.0.4, SecondWind 1.4.7, pickupsKit 2.3.11, soundstage 2.1.3, lookbookKit 1.0.55, starterBlocks 1.0.52, materialLibraryKit 1.4.3, and material collections (forestMaterials 2.0.5, forestProps 0.1.7, groundMaterials 1.0.8, stoneMaterials 1.2.1, masonryMaterials 2.0.0, woodsMaterials 1.0.2, organicMaterials 1.0.8, toonMaterials 1.0.11, scifiMaterials 1.0.3, animatedMaterials 1.0.16).

Tests

  • townKit.package/townKitTests (15 tests): the town's rules, every swappable choice, and the multiplayer works (shared town, late joiner, host hand-over, restart catch-up).
  • tests/thrivingTown (7 tests): every kit above installed once at its version, the docs naming and rating each, the showcase scene's settings, and rangeKit's real coverage driving a home's happiness.

Run either with tools.use("tests", "run", { suite = "thrivingTown" }) (or "townKitTests").

reuse-review.md rates how each kit worked for this build; NOTES.md is the build diary.