#Code Reference
#Configuration map
Everything tunable sits in ReplicatedStorage.SharedConfig.
| Key | Holds |
|---|---|
Config.Flags | Master switches for every major feature |
Config.Rarities, RarityById, RarityIncomeMul, RarityBaseWeight, RarityGrowSeconds, RarityPetScale | Rarity ladder and every per-rarity multiplier |
Config.Zones, ZoneById, ZoneLook | Biomes, Speed gates, X ranges, guardian ids, HUD colours |
Config.Guardian, GuardianStats | Chase behaviour and per-biome guardian speeds |
Config.Eggs | Nest counts, pickup rules, carry constants, drop rules |
Config.Bats, BatById, BatByZone, BearTrap | Tool tables |
Config.Treadmills, TreadmillById, Training, Movement | Speed progression |
Config.Trails, TrailById, TrailColors, TrailIcons, TrailProducts | Trail table and visuals |
Config.Mutations, MutationById, MutationColors, MUTATION_ROLL_DENOMINATOR, MUTATION_SHARD_CHANCE | Mutation table and roll rules |
Config.Size, SizeById | Weight buckets and the diminishing-returns curve |
Config.Pets, PetById, PetIncome, PetRarityThresholds, PetsByBiome, PetsByRarity | Pet catalog mirrors used by the index and UI |
Config.Pen | Base pet slots per level |
Config.Fusion | Inputs, upgrade chances, inheritance |
Config.Economy | Tick rates, save interval, Grow All pricing, friend bonus |
Config.Index | Index reward multipliers |
Config.Shop, ExclusiveShop, Monetization | Display catalogs and purchase fulfilment |
Config.Events, SakuraIncubator | Event periods and rewards |
Config.Admin, Security, RNG | Console access, rate limits, deterministic seed |
Config.UISounds, UIAnimation, UIIcons, HudLabels | Interface tuning |
Config.WikiSource | Community wiki provenance (module names and fetch date) |
#Server services
ServerScriptService.Services — loaded in order by ServerScriptService.Bootstrap.
| Service | Responsibility |
|---|---|
Guard | Shared RNG, uid generation, validation, rate limits, suspicion flags |
DataService | Profile store, migrations, autosave, shutdown flush |
PlayerStateService | Per-player runtime state, snapshots and deltas to the client |
PlotService | Base assignment, bounds, local/world coordinate helpers |
BaseVisualsService | Base colour and collision by pen level |
SpeedService | Speed storage, walk-speed curve, zone unlocks, stun |
EconomyService | Cash reads, spends and payouts |
TreadmillService | Belt detection, skins, purchases, Speed per step |
TrailService | Trail ownership, equipping and visuals |
ZoneService | Zone tagging, lookups, pushback, teleport |
MutationService | Size rolls, natural and event mutations, income maths |
EggSpawnService | Nest building, egg spawning, claim/return/consume |
EggCarryService | Pickup, carry weld, delivery, drops and losses |
GuardianService | Guardian models, wake, chase, catch, egg recovery |
GrowthService | Growing models, timers, visual stages, selling, Grow All |
HatchService | Hatch validation, mutation roll, ceremony, delivery |
PetService | Pet models, placement, slots, selling, best-pet equipping |
IncomeService | Income recomputation and the payout tick |
IndexService | Discoveries, pet/zone/bat rewards, catalog payload |
FusionService | Fusion validation, upgrade roll and inheritance |
FriendBonusService | Friend counting and the income bonus |
MonetizationService | Passes, products and receipt processing |
LeaderboardService | leaderstats, physical board and global board |
EventService | Event windows and state exposed to other systems |
RiftService, RiftEventService | Rift sacrafice, banners, overlord encounter |
GreatBloomService, AngelsDemonsService | Bloom crystals and the Angel/Demon rotation |
SpecialEggService | Special egg pools, decorators and announcements |
NightService | Day/night cycle, night wall, growth speed-up |
ToolService | Bats, bear traps, swings, knockback |
ItemService | Egg and pet items, placement validation, tools in the hotbar |
PetRoamService, PetPreviewService | Placed-pet wandering and preview models |
RewardsService | Free gift and badge awards |
PetGrantService | Pet granting used by rewards and events |
BoostService | Timed boosts, boss shop, admin abuse |
ExpansionWorld | Expansion geometry, teleports and point helpers |
LabelService | Holograms, speed signs, base and seller labels |
ModelLibrary | Egg, pet, nest and guardian model building |
WorldInteractionService | Prompts and hologram interaction |
RemoteHandler | Remote dispatch and the action allow-list |
TutorialService | Tutorial state and the red-line guide |
AdminService | Console commands |
FeatureServices, FeatureTests, TestHarness | Feature wiring and the test suites |
#Remotes
ReplicatedStorage.Remotes is created at runtime by ReplicatedStorage.Shared.Net.
| Kind | Names |
|---|---|
| RemoteEvent | Snapshot, Delta, World, Notify, Ready, Announce, Fade |
| RemoteFunction | Request, PetPreview |
Every client request goes through Request and must name an allowed action:
buyTreadmill buyTrail equipTrail unequipTrail buyPetSlot equipBestPets
placePet unplacePet sellPet sellAllPets sellEgg sellAllEggs hatchEgg
growAll dropEgg fusion claimIndex setSetting teleportZone adminCommand
upgradePen shrineFuse luminousReroll claimFreeGift featureState
bossShopBuy riftSacrifice useMutationShard enterRift leaveRift
chargeIncubator incubateEgg openMonsterChest placeItem pickUpPet
#Client
StarterPlayer.StarterPlayerScripts.ClientMain boots the UI: UIKit, UISounds, Windows, State, Hud, TutorialGuide and the panels Shop, Eggs, Admin, Index, TrailShop, Pets.
Supporting client modules cover feel and feedback: ChaseAlert, TrapAlert, RegionBanner, EggPrompt, EggHop, EggPickupGate, Hotbar, ItemPlacement, PetHold, PetSmoother, PetWalkAnimation, GuardianSmoother, TreadmillRunner, NightTimer, NightAudio, Music, Announcements, ScreenFade, SpawnCamera, SpecialRegions and BaseVisuals.
#Server storage
| Instance | Purpose |
|---|---|
EggForge, EggBuild, EggSpecs | Egg model construction and per-pet egg specs |
PetForge, PetBuild | Pet model construction |
NestForge | Nest models |
ExpansionPetSpecs, ExpansionEggSpecs, ExpansionModelBuild | Expansion (angel/demon) content |
SAE_Tools, PetPartsRepairTools, BearTrap, Runtime | Tool models and runtime scratch space |
#Where to change what
| Task | Edit |
|---|---|
| Rebalance rewards | Config.Pets, Config.Rarity*, Config.Size, Config.Mutations |
| Add a biome | append to Config.Zones, add a RAW block in Catalog, add geometry to Workspace.Map, add a guardian to Config.GuardianStats |
| Add a pet | extend the biome list in Catalog.RAW (or RAW_EXTRA / RAW_RIFT) and add its income to Config.PetIncome |
| Retune the chase | Config.Guardian, Config.GuardianStats |
| Retune economy | Config.Economy, Config.Pen, Config.Treadmills, Config.Trails |
| Enable an event | the matching Config.Flags entry plus Config.Events / Features |
| Go live with purchases | fill Config.Monetization ids and align Config.Shop prices |