Skip to content

README.md

Latest commit

 

History

History
75 lines (62 loc) · 3.11 KB

README.md

File metadata and controls

75 lines (62 loc) · 3.11 KB
Raw

🍃 AgentPets Village

A standalone, Animal Crossing-inspired life sim starring the AgentPets creature roster. It runs entirely in your browser — no build step, no network, no dependency on the AgentPets overlay app. The whole village fits in this directory.

Genre

Play

./Game/play.sh          # serves on localhost and opens your browser
# — or just open Game/index.html directly in any modern browser

Your save lives in the browser's localStorage and persists across sessions. The village runs on your real clock and calendar: day and night, the four seasons, and daily resets all follow real time, just like the game that inspired it.

What you do

  • 🦊 You arrive in a procedurally generated village (yours is unique to your save seed) as the fox, with three tools and a 5,800-bell loan.
  • 🎣 Fish the river and ocean — 18 species that vary by location, season, and time of day. Rare fish bite fast.
  • 🦋 Catch bugs with the net — 13 species around flowers, trees and grass. Fireflies only glow on summer nights.
  • 🌳 Shake fruit trees (fruit regrows every 3 days), dig fossils at the daily ✕-spots, whack rocks for bells, pull weeds, comb the beach for shells.
  • 🐗 Sell everything to Boaris at the shop, and buy furniture, flower seeds, and replacement tools from his rotating daily stock.
  • 🤖 Pay off your loan to B-4NK to upgrade your home three times — each upgrade gives you a bigger interior to decorate with furniture.
  • 🐺 Befriend the villagers — Howell, Fawna, Clover, Bruno, Glop, Pip, Morel, Iris, and the night-only Frostine. Friendship grows when you chat daily; they hand out fetch quests and gifts.
  • 📔 Fill the journal — fish, bug, and fossil collections, friend hearts, and lifetime stats.

Controls

Key Action
WASD / arrows Move (hold Shift to run)
Space / E Interact (context shown at the bottom of the screen)
Q Cycle tool: hands → rod → net → shovel
I / Tab Pockets
J Journal
M Mute
Esc Close panel / cancel

Tech notes

  • Plain HTML5 canvas + vanilla JS. Classic <script> files (no modules, no bundler) so the game works straight off file://.
  • The creature art is the same CC0 sprite set the AgentPets overlay app uses (Game/assets/pets/, copied from Sources/AgentPets/Resources/Pets/ — see CREDITS.md at the repo root). Everything else — terrain, buildings, trees, furniture — is drawn procedurally.
  • Pure game logic (js/village.*.js) is platform-independent and unit tested under Node; the browser layer (js/engine.*.js, js/ui.js, js/main.js) is covered by a headless boot smoke test with a stubbed DOM/canvas.
node --test "Game/tests/*.test.mjs"   # 40 tests: logic suite + headless boot smoke
  • World generation is deterministic from the save seed: only dynamic state (inventory, fruit, dig spots, friendships, …) is stored in the save. Saves are versioned and forward-merged, so old saves keep working as fields are added.