Log inGet started
Package

survivalCraftKit.package

Newest version

This package holds more than this page lists. See all of its files in its world.

README.md

survivalCraftKit

Make a survival game where you wash up on a small island and have to survive the night. For creators asking "make a survival game where you survive the night", "how do I make a crafting survival island game" or "castaway game like a desert island survival". You wake on a beach with nothing, punch a palm for wood, pick up stones, find berries and coconuts, craft a stone axe, a pick, a spear and a torch, build a campfire, a shelter and a bed, cook a fish and fill a flask at the spring. At sunset things come out of the jungle that are scared of your fire. Die and your bag stays where you fell. Live until dawn and you have made it through your first night. One line builds the whole island, and one setting, the mode, picks how hard it plays.

Version 1.0.29. New in 1.0.29: shelters stay closed on sloped ground. A blueprint with pieces resting on others (lean-to, tent, pavilion, stone hearth, raised cot) stands all its walls and posts on the lowest ground under them, digging into the slope on the uphill side, so every top is level and the roof meets every wall; ground that falls more than 0.6 m across those pieces (MAX_STEP) is refused with "Too steep to build here" instead of leaving a gap under the roof. The hammock is a net on ropes between its two posts, without the bed frame under it (bare = true on a bed hides the bed piece's own look). New in 1.0.28: built against survivalNeedsKit 1.0.13, so a burning fire no longer stops heatSignatures from working. New in 1.0.27: the quick start was followed by a stranger in a new world and timed. It now leads with the fork route (playing in under a minute) and gives the fresh-world install its real time (about nine minutes, nearly all of it the first download); the how-to guide also answers "island survival game with a campfire and a shelter". New in 1.0.26: every shelter, fire and bed is built so it reads as itself from any side: the tent's two roof halves sit on its side walls and meet at the ridge, the lean-to's roof runs from a low back wall up to two front posts, the pavilion's roof sits on its four posts, the stone hearth is a fire on a raised stone plinth with a low back wall, the signal fire flies a flag, and the beds look different (palm fronds and a leaf fan, a woven mat with a rolled blanket, a hammock net on ropes to its posts, a cot on a plank floor). Blueprint pieces can rest on the pieces before them and beds carry dress parts. New in 1.0.25: built against recipeKit 1.0.5 (the craft menu on a gamepad and on small screens), nightCreaturesKit 1.0.12 (creatures close in on a player in the dark), survivalNeedsKit 1.0.11 (status chips side by side) and a clean aiKit 1.3.14 install (one navKit); the API section now says which data comes from the castaway module and which only from the presets. New in 1.0.24: the quick start and both guides describe the one-step install into a brand-new world, checked in an empty world. New in 1.0.23: installs into an empty world in one step (built against aiKit 1.3.14, whose navKit comes from one release; before, the install was refused because aiKit reached two navKit releases). New in 1.0.22: five fires (campfire, torch post, signal fire, stone hearth, torch ring), five shelters (lean-to, palm hut, tent, driftwood cabin, beach pavilion) and four beds (palm bed, bedroll, hammock, raised cot), each its own blueprint, cost and stats, swapped the same way; a burnt-out fire is cold at once and stays dark through a reconnect; the clock comes back at the hour you left (worldClockKit 1.7.3); on touch the action buttons stand clear of the needs bars, and a player who comes back with a need at zero gets a fair moment to act. New in 1.0.20 and 1.0.21: on a gamepad, Select opens only crafting (the map moved to a right-stick click; mapPad picks another); on touch, the Build button stands beside the action buttons where a tap reaches it, and the move stick is a fixed one, so a held tap on Eat/Use, Bag, Swing or Craft is never taken for the stick. New in 1.0.19: fires keep their fuel and stay out through a restart; the controls answer from the first frame; every dawn shows the dawn screen; Escape, Start and a pad's B close the open craft menu, bag or build mode before the pause menu (menuBackKit); and each mode also sets the craft menu's look and how fast gather spots grow back. Earlier: a campfire or torch that runs out of fuel goes dark and cold and lights again when it is fed; swing, craft, eat, the bag and the hotbar are rebindable controlsKit actions.

Quick start

Fastest: playing in under a minute. Fork the Castaway Isle world, which already holds survivalCraftKit and every kit it uses, and press Play. Timed on 2026-11-15 from a stranger's first command: fork 3 s, open 5 s, island loaded at 34 s, playing at 48 s.

  1. Fork it: Fork on the Castaway Isle page, or in the engine shell zero zeromind fork --guid 261f357e-6a20-4912-ac33-d9972b929762.
  2. Open your fork: the ZeroMind panel, or zero zeromind swap --guid <the guid the fork answered>.
  3. When First Night has loaded, press Play. You wake on the beach; the fork is your own world to change.

Your own island in a brand-new world: about nine minutes. The same timed run: install 7 min 49 s, the other steps under a minute. The install is the slow part: it fetches about forty packages (around 1.6 GB, art and materials included) the first time.

  1. Install survivalCraftKit from the ZeroMind panel, or zero zeromind installAsset --guid f395424b-1efa-4e47-9761-83a768cb3983 in the engine shell. It brings aiKit, navKit and every other kit it uses in one step. Wait for it to finish before the next step; the shell shows a report naming survivalCraftKit.package when it is done.
  2. Make a scene (zero scene create myIsland empty --startup) and put this in its build.luau:
-- scenes/myIsland.scene/build.luau
local Island = require("survivalCraftKit.island")
function content()
    Island.build({ start = "cove", mode = "castaway" })
end
  1. Let players spawn: zero scene player spawns (a scene made from the empty template is playerless and would strip the island's player at play).
  2. Open the scene once so tropicalKit cooks the island ground (12 s in the timed run), then press Play. You wake on the beach of the cove with your needs running; night creatures come out at dusk.

For a guided setup, run zero workflow start --name setUpYourOwnSurvivalIsland (the workflow is in survivalCraftKit.package/workflows).

Styles and choices

Island.build options

OptionValues
startcove (a horseshoe bay of white sand), volcano (a steep cone with black-sand beaches), atoll (a ring of sandy islets round a lagoon)
modecastaway, cozy, hardcore, creative
looka tropicalKit look (default toon)
dayLengthMinutesreal minutes per in-game day (default 16)
startHourin-game hour you wake at (default 7)
showerEveryMinuteshow often a rain shower comes (default 9)
spotsgather spots: { { resource, count, nearest, farthest } }
springa fresh water spring (default true)
hudTheme, hudLayoutoverride the mode's HUD (survivalNeedsKit's eight themes and six layouts)

Modes

One setting sets the needs rules, the HUD, the death drop and the night.

ModeNeedsHUD layout / themeDeath drop (style, look, rule, marker)Night
castawaycastawaycorners / realisticlootBag, burlap, dropAll, bothisland, normal
cozycozyring / cozyspiritOrb, azure, keepAll, ringisland, calm
hardcorehardcoresilhouette / horrorgravestone, weathered, hardcore, flarehaunted, swarming
creativeoffminimal / minimalbackpack, canvas, keepAll, iconno creatures

Modes also scale what things cost (cozy half, hardcore one and a half, creative free) and what you start with.

Recipes

RecipeNeedsWhat it does
Stone Axewood 2, stone 2, fiber 1Doubles palm yield; 20 damage.
Stone Pickwood 2, stone 3, fiber 1Doubles what you get from rocks.
Fishing Spear (spear)wood 3, stone 1, fiber 214 damage, 3 m reach, doubles fishing.
Coconut Flask (waterFlask)coconut 1, fiber 2Needed to fill fresh water at the spring (up to 3 at a time).
Torchwood 1, fiber 1A light in your hand that creatures fear.
Cook fish, Grill crab, Roast berries and rootraw food, by a burning fireCooked food.
Campfire, Torch post, Signal fire, Stone hearth, Torch ringwood, stone, fiber, palm leavesFive fires (survivalNeedsKit HeatSources): a stone hearth is the warmest and slowest to burn but lights less far; a torch ring is four torches round a camp, lots of light and little heat.
Lean-to, Palm hut, Tent, Driftwood cabin, Beach pavilionwood, palm leaves, fiber, stoneFive shelters from buildPlaceKit pieces: the lean-to's roof runs from a low back wall up to two posts, the tent's two roof halves meet at the ridge over two low walls, the hut and the cabin stand on a floor (the cabin with a doorway and two windows), and the pavilion is a roof on four posts, open on every side.
Palm bed (palmBed), Bedroll, Hammock, Raised cotpalm leaves, wood, fiberFour beds, each dressed its own way (palm fronds, a woven mat and rolled blanket, a hammock net on ropes, a cot on a plank floor): standing at one restores rest (2.5 to 5 per second by bed) and a little health.

Every fire, shelter and bed is a blueprint in the presets (P.FIRES, P.SHELTERS, P.BEDS, each with an _ORDER list) with its own cost and stats, crafted from the craft menu and built piece by piece in front of you; the whole blueprint is checked before anything is paid, and a few nearby spots and turns are tried when the spot ahead is blocked. Add an entry to add one.

Beds are not respawn points: SecondWind has no respawn-point API.

Switching mode while the island runs

The mode is one synced field, mode on the island's CastawayGame entity. Change it while playing (in the inspector, or entity.find("CastawayGame").component.get(asset.resolve("survivalCraftKit.CastawayGame", "component")).mode = "hardcore" from a script on the host) and every player's game switches on the spot: the needs rules and HUD layout and theme, the death drop style, look, rule and marker for the next death, and the night's threat set. At night the host also sends the creatures out and starts the night again with the new set. Castaway.setup({ mode = "hardcore" }) does the same on one machine.

Controls

The engine's own walking controls stay in charge of moving, jumping, sprinting and interacting (controlsKit's castaway scheme runs with takeOver = false), and the scheme adds Swing, Craft, Eat or use, Bag, Previous and Next slot and the hotbar's number keys on every device. CastawayPlayer answers them as controlsKit events (Controls.on), so they show on controlsKit's rebinding screen and its prompts, and a rebound key works at once.

Keyboard and mouseGamepadTouch
MoveWASDleft stickfloating stick (left)
JumpSpacesouth buttonJump button
SprintShiftSprint button
Gather, drink, recover your bagEwest buttonInteract button or tap the prompt
Swing (at creatures), or feed or light the fire in reachXright shoulder (RB)Swing button (above the stick)
Tend a fire: add fuel, or light it again once it is out (wood, palm leaves, fiber or a coconut feed it; a torch or a flint lights it)E at the firewest buttonInteract button or tap the "Tend the fire" prompt
Eat or use what you hold (food, a filled flask)Feast button (B)Eat/Use button
BagTab or Ileft shoulder (LB)Bag button
Pick a hotbar slot1 to 8d-pad left and righttap the slot
Craft menuC (click a recipe, or arrows and Enter, Esc closes)Select (d-pad and south to pick, east closes)Craft button (above the stick)
Build mode: pick a piece, a green or red ghost shows where it goes, place it; each piece costs bag itemsB (wheel or 1-0 picks, R turns, click places, Esc leaves)north button (Y; d-pad picks, RB turns, RT places, B leaves)Build button (then tap a piece, tap the world, Place, Exit)

What is saved

With saveKit installed, leaving play, rejoining or restarting brings the island back as it was left: the day, hour and weather (worldClockKit's persist, on by default in Island.build; pass persist = false to start fresh), each player's bag (inventoryKit), each player's needs (survivalNeedsKit), death drops until their owner picks them up (deathDropKit), what was built (buildPlaceKit) and nights survived.

What it is built from

survivalCraftKit holds only the survival rules and the wiring. Every mechanic is an installed kit:

PartKit
Needs, statuses, fires, shelters, springs, foodsurvivalNeedsKit
Your things stay where you die, a marker backdeathDropKit
Creatures at dusk that fear firelight and leave at dawnnightCreaturesKit (on spawnerKit; aiKit brains on navKit paths when aiKit is installed)
Health, damage, respawnSecondWind (with barsKit bars)
Status effects from needsabilitiesKit
The one bag and hotbar every kit sharesinventoryKit
Fires, shelters and beds as placed piecesbuildPlaceKit
Recipes and the craft menurecipeKit (this world's own package; the kit defines its recipes there)
Gather spotsgatherKit (this world's own package), placed by Island.build
Things that run out and grow backregrowKit (this world's own package, under every gatherKit spot)
Heat from firesheatSignatures (with survivalNeedsKit's own fire falloff as the floor)
Day, night and weatherworldClockKit
The islandtropicalKit, tropicalProps, tropicalMaterials
PromptsinteractKit
Objectives, compass, toastsnavUiKit
Victory screenmenusKit
Nights survivedsaveKit
FeedbackjuiceKit
Keyboard, gamepad, touchcontrolsKit

API

island module

local Island = require("survivalCraftKit.island")

  • build(opts): build a whole survival island in a scene's content() (options above); returns { spawn = { x, y, z }, island = settings }.
  • DEFAULT_SPOTS: the gather spots it lays out when spots is not given.

castaway module

local Castaway = require("~survivalCraftKit.castaway")

  • setup(opts): pick a mode (castaway, cozy, hardcore, creative), with optional hudTheme and hudLayout; call on every peer in onLoad.
  • config(): a copy of the current settings.
  • mode(): the current mode table.
  • on(event, fn): listen to gathered(item, n), crafted(recipe), placed(kind, id), refused(what, why), objective(id, done), won(nights), tended(how, fireId), setup(cfg); returns a function that stops listening.
  • island(start?, extra?): the tropicalKit Island settings for a start, with extra laid over them.
  • craft(recipeId): craft as the local player through recipeKit: an item goes in the bag, a fire, shelter or bed is built in front of them.
  • costOf(recipeId): what a recipe costs under the current mode (recipeKit's cost, scaled by the mode).
  • missing(recipeId): what the local player lacks for a recipe (empty when they can make it).
  • nearFire(): whether the local player stands by a burning fire.
  • gather(resourceId, withTool?): give the local player one pick of a gatherKit resource; returns what they got.
  • _defineRecipes(): put the kit's recipes into recipeKit for the current mode (setup calls it); cooking recipes need the "fire" station, fires, shelters and beds are placed with buildPlaceKit.
  • placeBlueprint(id, recipeId?): build a fire, shelter or bed blueprint 3 m in front of the local player. A spot that does not fit (no room, or too steep) is refused with a toast after a few nearby spots and turns are tried.
  • blueprintFits(id, x, z, yawDeg): whether a blueprint fits with its centre at a spot: every standing piece passes buildPlaceKit's own check, and a closed blueprint's ground falls no more than MAX_STEP. Returns fits and the refusal text.
  • footing(id, x, z, yawDeg): for a closed blueprint (one with rest pieces: a roof on walls, a fire on a plinth), the lowest and highest ground under its standing pieces; nil for an open one. Closed blueprints stand every piece on the lowest of them, so the tops stay level on a slope.
  • MAX_STEP (0.6): how far, in metres, the ground under a closed blueprint's standing pieces may fall before the spot is too steep.
  • buildAt(id, x, groundY, z, yawDeg, direct?): build a blueprint at a spot; direct = true places it the way a scene does (host, no reach check) and returns the entities.
  • groundAt(x, z): ground height under a point, or nil.
  • localBody(): the local player's body, or nil.
  • wireStatusEffects(): give the local player an abilitiesKit Character so survivalNeedsKit's statuses land as real effects; returns an unhook function.
  • startObjectives(): start the objective list.
  • objectiveEvent(ev, n?): count an event toward the objectives (gather:<item>, craft:<recipe>, place:fire, place:shelter, eat, drink, dawn).
  • toast(text, opts?): show a navUiKit toast.
  • juice(name, target?): play a juiceKit effect.
  • saved(key), save(key, value): read and write saveKit values.
  • tagOf(pieceId), tagInfo(pieceId), tags(), loadTags(t): which blueprint a placed piece belongs to.
  • Data on Castaway (require("survivalCraftKit.castaway")): MODES, STARTS, FIRES, SHELTERS, BEDS, RECIPES and OBJECTIVES with their order lists (MODE_ORDER, START_ORDER, FIRE_ORDER, SHELTER_ORDER, BED_ORDER, RECIPE_ORDER), plus VERSION and EVENTS, which only the castaway module has. These tables are the presets' own, so an entry added to one is seen by both.
  • Data only on the presets module (require("survivalCraftKit.presets")): PIECES and PIECE_ORDER (what each build-mode piece takes from the bag; Castaway.pieceCost(kind) reads it for the current mode) and ITEMS (the materials, tools and foods as inventoryKit items). The castaway module does not re-export them.
  • pieceCost(kind): what a buildPlaceKit piece costs in the current mode ({ item = n }, nil when castaways cannot build it). Build mode checks it on the deciding machine against the builder's bag and takes it when the piece lands; tended(action, fireId) fires when the local player feeds or lights a fire.

Components

CastawayGame (one, synced): runs the mode on every peer, starts the objectives, turns placed fires, roofs and beds into HeatSources, Shelters and rest spots on the host, tracks dusk and dawn, and shows the victory screen at the first dawn.

  • mode ("castaway"), hudTheme (""), hudLayout (""): empty takes the mode's HUD.
  • isNight, nightsSurvived, won: host-written.
  • duskAt (0.55), dawnAt (0.3): darkness where night begins and ends.
  • Method: skipToDusk() (host): advances the shared clock to 18:30.

CastawayPlayer (on the player body): swing, feed fires, open recipeKit's craft menu (C, pad Select, the Craft button), a torch in the hand that creatures fear, on-screen buttons.

  • torchLit (false): owner-written, holding a lit torch.
  • reach (2.8), fistDamage (8), spearDamage (14, reach 3 m), axeDamage (20).
  • torchLight (7): how far a held torch keeps creatures back.
  • buttons (true): show the on-screen Craft and Swing buttons.

GatherSpot (kept for scenes made with 1.0.5 and earlier): puts a gatherKit GatherSpot with the same resource on its entity and does nothing else. New scenes place gatherKit.GatherSpot directly.

  • resource ("palm"): any gatherKit resource. propScale (1).

ModePreview: mode buttons that switch the game live, with the mode's death drop and night creature set shown on a stand.

  • mode ("castaway"): the mode shown first. panel (true): show the buttons.
  • Method: show(id): switch to a mode by name.

CastawayGallery: every fire and shelter built for real from buildPlaceKit pieces.

  • spacing (8), labels (true), floor (true).

What it installs

Installing survivalCraftKit brings these packages, each from its own world, at the versions it was built and tested with:

PackageVersion
survivalNeedsKit1.0.13
deathDropKit1.0.9
nightCreaturesKit1.0.13
inventoryKit1.0.26
buildPlaceKit1.0.35
interactKit1.6.3
navUiKit1.3.7
menusKit1.3.19
saveKit1.3.13
juiceKit1.2.10
controlsKit1.3.2
SecondWind1.4.7
worldClockKit1.7.3
tropicalKit1.0.4
tropicalProps1.0.2
tropicalMaterials1.0.2
spawnerKit1.1.8
barsKit1.4.6
abilitiesKit1.1.4
recipeKit1.0.6
gatherKit1.0.4
regrowKit1.0.2
aiKit1.3.16
heatSignatures1.0.9
menuBackKit1.0.2

Multiplayer

Fires, shelters and creatures are decided by the host and seen by everyone. Each player has their own needs, their own bag (inventoryKit, owner-written) and their own objectives; a dropped bag is seen by all and taken back only by its owner (or anyone, in hardcore). A gather spot's charges are decided by its owner so two players never take the same pick.

Gallery

Put a CastawayGallery on a synced entity in a scene of its own to see all five fires, five shelters and four beds built for real from buildPlaceKit pieces, with the four modes and three island starts on signs. Put a ModePreview beside it to flip between modes. The Castaway Isle world ships a gallery scene with every castaway gallery side by side.

Guides

  • How do I make a survival game where you survive the night (survivalCraftKit.package/how-do-i-make-a-survival-game-where-you-survive-the-night.guide)
  • Example: make a survival game where you survive the night on an island (survivalCraftKit.package/example-make-a-survival-game-where-you-survive-the-night-on-an-island.guide)
  • Workflow: set up your own survival island (zero workflow start --name setUpYourOwnSurvivalIsland)

Tests

18 tests in survivalCraftKit.testSuite. Run them with asset.resolve("survivalCraftKit", "testSuite"):run().

Known limits

  • craftingKit cannot be installed into this world yet (platform issue #25685), so recipes and the craft menu come from recipeKit and gathering from gatherKit and regrowKit, three small packages published from this world.
  • Beds restore rest but are not respawn points.