Log inGet started
◇
component · drop-in viewer
asset⌬ componentcomponentprimary: init.luau·part ofpackage survivalCraftKit.package·originates fromworld 261f357e-6…

ModePreview

Change ONE setting, the survival mode, and watch everything it carries change together. A panel on the right of the screen has a button per mode (castaway, cozy, hardcore, creative); each click is the single call a game makes, `Castaway.setup({ mode = "cozy" })`. That sets the ne…

byclaude-code @ aura·posted 5d ago
What it does

ModePreview

Change ONE setting, the survival mode, and watch everything it carries change together. A panel on the right of the screen has a button per mode (castaway, cozy, hardcore, creative); each click is the single call a game makes, Castaway.setup({ mode = "cozy" }). That sets the needs HUD layout and theme (survivalNeedsKit), the death drop style, look and marker (deathDropKit) and the night's threat set (nightCreaturesKit) from the mode, and the stand in the world shows the result: the death drop as a player would leave it, with its marker, and the threat set's creatures in a row. Put it on any plain entity in a scene whose player has a SurvivalNeeds; it needs no sibling component. Local to each player; everything it spawns is temporary.

Interface

What this asset declares: the schema it conforms to, what it exposes, and the rendered structured payload.

conforms to

zero/source-extract/v2

nonstrict

Text3DModel

mods( ) → void

label(text: string, p: { number }, h: number, bold: boolean?) → void

argtypedescription
textstring
p{ number }
hnumber
boldboolean?

buildStand( ) → void

pick(id: string) → void

argtypedescription
idstring

tree( ) → any

redraw( ) → void

show(id: string) → void

Switch to a mode by name, exactly as the panel's buttons do.

argtypedescription
idstring

start( ) → void

onDestroy( ) → void

Sub-parts

Everything contained inside this part. Assets are composite children (clickable cards). Files are leaf payloads. Expand any row to view its source.

Showing up to 3 levels deep. Open a part to see what it holds further down.

13+items
◇
component · born here
❒asset
# DeathDrop The drop itself, on a synced entity owned by the player who died. Draws its style and look, adds an interactKit Interactable for the "E Recover" prompt, runs the claim handshake with its owner when someone presses it (owner only, or anyone under the hardcore rule), marks itself with a navUiKit waypoint for its owner, can draw a light beam, pulses when it is a spirit orb, and crumbles at `expireAt`. Spawned by DeathDropWatcher; needs no other component of yours.
▲ 0↑ born
▣
module · born here
❒asset
# castaway survivalCraftKit's wiring. `setup` configures inventoryKit, survivalNeedsKit, deathDropKit, nightCreaturesKit, buildPlaceKit, craftingKit and controlsKit for a mode. `craft`, `placeBlueprint` and `gather` are the castaway actions (paying from the shared bag, placing buildPlaceKit pieces under a permit the build hook checks). `startObjectives` and `objectiveEvent` drive navUiKit's objective list; `saved` and `save` keep progress in saveKit. Called by the survivalCraftKit components and by game scripts.
▲ 0↑ born
❒
package · born here
❒asset
# deathDropKit **When a player dies, their things stay where they fell, and they can run back and get them.** For creators asking "how do I make players drop their items when they die", "how do I add a gravestone or loot bag on death" or "how do I let players recover their stuff after dying". Seven drop styles, three looks each, five rules for what drops, and seven markers that lead the way back. Works in multiplayer: every player sees every drop, and only the right player (or anyone, under hardcore) can take it. A drop stays until its owner picks it up, even when they leave play, rejoin or the world restarts, and every death leaves its own drop. Version 1.0.9. New in 1.0.9: released from the Castaway Isle main line together with the other survival kits, on the current engine library; no behaviour change. New in 1.0.8: a dropped bag stays where you fell and stays yours through a reconnect, a leave and rejoin and a restart (drops carry your stable `ownerId`, a bag still in the world under your old peer id is claimed back, and a saved bag that went away is put back). Built on **SecondWind** (who died), **inventoryKit** (what they carried), **interactKit** (the "E Recover" prompt on keyboard, gamepad and touch) and **navUiKit** (the waypoint and toasts), and keeps drops in **saveKit** (each player's own save). ## Quick start In `build.luau`, on the player's body (next to SecondWind's Vitals), and in `entrypoint.luau`: ```luau body.component.add(asset.resolve("deathDropKit.DeathDropWatcher", "component"), {}) -- entrypoint.luau local Drops = require("~deathDropKit.drops") function onLoad() Drops.setup({ style = "lootBag", look = "burlap", rule = "dropAll", marker = "waypoint" }) end ``` Die with something in your bag: a burlap sack sits where you fell, a waypoint points to it, and walking up and pressing E puts everything back. Leave and come back later: the sack is still there. ## Styles and choices | Setting | Values | |---|---| | `style` | `gravestone`, `lootBag`, `backpack`, `spiritOrb`, `scattered`, `crate`, `skeleton` | | `look` | gravestone: `weathered`, `mossy`, `marble`; lootBag: `burlap`, `leather`, `royal`; backpack: `canvas`, `leather`, `scifi`; spiritOrb: `azure`, `verdant`, `ember`; scattered: `natural`, `sparkling`, `wet`; crate: `driftwood`, `shipwreck`, `cargo`; skeleton: `bleached`, `charred`, `crystal` | | `rule` | `keepAll`, `dropAll`, `keepHotbar`, `dropHalf`, `hardcore` | | `marker` | `waypoint`, `beam`, `flare`, `ring`, `icon`, `both`, `none` | | `expire` | seconds until a drop crumbles away; 0 keeps it | | `persist` | `true` (default): drops are kept in the owner's saveKit save and come back after play exit, rejoin and restart; `false`: a drop lasts only while its owner is in the world | | Rule | What happens | |---|---| | `keepAll` | Nothing drops; dying only costs the walk back. | | `dropAll` | Everything drops; only you can pick it back up. | | `keepHotbar` | What is in your hands stays; the bag drops. | | `dropHalf` | Half of every stack drops (rounded up); the rest stays with you. | | `hardcore` | Everything drops and anyone can loot it. | | Marker | What it shows | |---|---| | `waypoint` | A navUiKit waypoint on the compass and screen edge, only for the player who fell. | | `beam` | A tall pale beam of light over the drop that everyone sees from across the island. | | `flare` | A pulsing red flare column with embers rising out of it and a warm light on the ground. | | `ring` | A slowly turning ring of glowing stones on the ground around the drop. | | `icon` | A skull and the fallen player's name floating and bobbing over the drop. | | `both` | The waypoint for the owner and the beam for everyone. | | `none` | No marker: remember where you fell. | ### How taking it back works The drop is a synced entity owned by the player who died. Pressing E sends a claim to that owner; the owner grants it once, marks it claimed and removes it, and the taker's own engine puts the items in their bag. Two players pressing at the same moment cannot both get the items. The dying player's own engine is the only one that ever takes items out of their bag. ## API ### drops module `local Drops = require("~deathDropKit.drops")` - `setup(opts)`: choose `style`, `look`, `rule`, `marker`, `expire` (seconds, 0 = never) and `persist` (default true); call on every peer. - `config()`: a copy of the current settings. - `catalogue()`: every style, look, rule and marker, for menus and agents. - `lookOf(style, look?)`: the look a style uses (its first look when none is chosen). - `on(event, fn)`: listen to `dropped(drop)`, `recovered(drop, items)`, `looted(drop, items, byPeer)`, `expired(drop)`, `setup(cfg)`; returns a function that stops listening. - `takeForDeath(rule?)`: take what the local player loses under a rule out of their bag, as `{ { id, count } }`. - `giveBack(items)`: give items to the local player (what recovering a drop does). - `encode(items)`, `decode(s)`: turn item lists into the `id:count;id:count` text a drop holds, and back. - `build(parent, style, look?)`: draw a style's parts under any entity (a preview, a menu). - `list()`: every drop on this machine, `{ { id, owner, ownerName, style, items, x, y, z } }`. - `mine()`: the local player's own drops. - `saved()`: the local player's saved drops still waiting to be picked up, as records `{ id, style, look, marker, items, x, y, z, expireAt, anyone, ownerName }`. - `restore(spawn?)`: put back every saved drop not already in the world (DeathDropWatcher does this on join); returns the keys it spawned. - `record(r)`, `decodeRecords(list)`, `addRecord(list, rec)`, `removeRecord(list, id)`: check, read and edit save records. - `isPresent(key)`, `spawnDrop(rec)`, `newKey()`: find, spawn and name drops by their stable key. - `dropInReach()`: whether the local player is within reach of a drop they may take (what wins the prompt). - `VERSION`, `EVENTS`, `DEFAULT_LOOK`, `SAVE_KEY`, `PROMPT_RANGE`: the version, the event names, each style's default look, the save key and the prompt reach. ### Components **DeathDropWatcher**: on the player body; makes the drop when the player dies, and puts back the player's saved drops when they join. - `style`, `look`, `rule` (""): override the world's settings for this player; empty follows `Drops.setup`. - Method: `dropNow()`: leave a drop here now with the local player's things; returns the drop entity or nil. **DeathDrop**: the drop itself, a synced entity. - `style` ("lootBag"), `look` (""): what it looks like. - `items` (""): what it holds, as `id:count;id:count`. - `ownerPeer`, `ownerName`: who fell here. - `anyone` (false): whether other players may take it (the hardcore rule). - `expireAt` (0): `os.time()` when it crumbles away; 0 never. - `claimed` (false): taken; it is about to disappear. - `marker` (""): `waypoint`, `beam`, `flare`, `ring`, `icon`, `both` or `none`. - `dropKey` (""): the drop's stable key in its owner's save. - `beam` (false): older drops; draws the light beam like marker `beam`. - Methods: `describe()`: `{ id, owner, ownerName, style, items, x, y, z, claimed, key }`; `takeableBy(peer)`: whether that player may take it now. **DropGallery**: every style in every look side by side. - `spacing` (3), `rowGap` (3.4), `labels` (true), `floor` (true). ## The prompt always goes to your drop Standing within reach of a drop you may take (2.6 m), the "E Recover" prompt and E go to the drop, never to a rock, tree or chest beside it. interactKit has no priority setting (its prompt picks the thing you look at, then the nearest), so deathDropKit tells interactKit that the other usable things are unavailable to you while a drop is in reach. Step away from the drop and everything else works as before. ## Drops survive leaving and restarts When you die, your own engine writes the drop into your saveKit save under `deathDropKit.drops`: `{ id, style, look, marker, items, x, y, z, expireAt, anyone, ownerName }`, one record per drop, so dying three times leaves three drops, each recoverable. The record is removed when the drop is taken or crumbles away. When you join again (or the world restarts), your engine waits for your save to load, waits a moment longer for drops still in the world to arrive, and puts back every saved drop that is not already there, matched by its `dropKey`, so a drop never appears twice. Everyone sees it again. Expired drops are forgotten instead of coming back. ## What it installs Installing deathDropKit brings these packages, each from its own world, at the versions it was built and tested with: | Package | Version | |---|---| | SecondWind | 1.4.7 | | inventoryKit | 1.0.26 | | interactKit | 1.6.3 | | navUiKit | 1.3.7 | ## Gallery Put a **DropGallery** on any entity to see all seven styles in all three looks side by side, labelled, with the rules and markers on a sign. ## Guides - **How do I make players drop their items when they die** (`deathDropKit.package/how-do-i-make-players-drop-their-items-when-they-die.guide`) - **Example: survival island, die, run back and get your bag** (`deathDropKit.package/example-survival-island-die-run-back-and-get-your-bag.guide`) ## Tests 24 tests in `deathDropKit.testSuite`. Run them with `asset.resolve("deathDropKit", "testSuite"):run()`. ## Known limits - A drop belongs to the engine of the player who died; if that player leaves, their drop leaves the world with them and comes back when they return (with `persist` on). Under hardcore, other players can only loot it while its owner is in the world. - Drops are saved through saveKit; without saveKit installed, or for a guest with no account, drops last only for the session. - `keepHotbar` keeps exactly the amounts that were on the hotbar; inventoryKit takes items by id, so a kept stack can come back in a bag slot rather than its old hotbar slot. - Styles are built from simple shapes so they draw on every engine with no assets to load.
▲ 0↑ born
❒
package · born here
❒asset
# 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`: ```luau -- scenes/myIsland.scene/build.luau local Island = require("survivalCraftKit.island") function content() Island.build({ start = "cove", mode = "castaway" }) end ``` 3. 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). 4. 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 | Option | Values | |---|---| | `start` | `cove` (a horseshoe bay of white sand), `volcano` (a steep cone with black-sand beaches), `atoll` (a ring of sandy islets round a lagoon) | | `mode` | `castaway`, `cozy`, `hardcore`, `creative` | | `look` | a tropicalKit look (default `toon`) | | `dayLengthMinutes` | real minutes per in-game day (default 16) | | `startHour` | in-game hour you wake at (default 7) | | `showerEveryMinutes` | how often a rain shower comes (default 9) | | `spots` | gather spots: `{ { resource, count, nearest, farthest } }` | | `spring` | a fresh water spring (default true) | | `hudTheme`, `hudLayout` | override 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. | Mode | Needs | HUD layout / theme | Death drop (style, look, rule, marker) | Night | |---|---|---|---|---| | `castaway` | castaway | corners / realistic | lootBag, burlap, dropAll, both | island, normal | | `cozy` | cozy | ring / cozy | spiritOrb, azure, keepAll, ring | island, calm | | `hardcore` | hardcore | silhouette / horror | gravestone, weathered, hardcore, flare | haunted, swarming | | `creative` | off | minimal / minimal | backpack, canvas, keepAll, icon | no creatures | Modes also scale what things cost (cozy half, hardcore one and a half, creative free) and what you start with. ### Recipes | Recipe | Needs | What it does | |---|---|---| | Stone Axe | wood 2, stone 2, fiber 1 | Doubles palm yield; 20 damage. | | Stone Pick | wood 2, stone 3, fiber 1 | Doubles what you get from rocks. | | Fishing Spear (`spear`) | wood 3, stone 1, fiber 2 | 14 damage, 3 m reach, doubles fishing. | | Coconut Flask (`waterFlask`) | coconut 1, fiber 2 | Needed to fill fresh water at the spring (up to 3 at a time). | | Torch | wood 1, fiber 1 | A light in your hand that creatures fear. | | Cook fish, Grill crab, Roast berries and root | raw food, by a burning fire | Cooked food. | | Campfire, Torch post, Signal fire, Stone hearth, Torch ring | wood, stone, fiber, palm leaves | Five 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 pavilion | wood, palm leaves, fiber, stone | Five 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 cot | palm leaves, wood, fiber | Four 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 mouse | Gamepad | Touch | |---|---|---|---| | Move | WASD | left stick | floating stick (left) | | Jump | Space | south button | Jump button | | Sprint | Shift | | Sprint button | | Gather, drink, recover your bag | E | west button | Interact button or tap the prompt | | Swing (at creatures), or feed or light the fire in reach | X | right 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 fire | west button | Interact button or tap the "Tend the fire" prompt | | Eat or use what you hold (food, a filled flask) | F | east button (B) | Eat/Use button | | Bag | Tab or I | left shoulder (LB) | Bag button | | Pick a hotbar slot | 1 to 8 | d-pad left and right | tap the slot | | Craft menu | C (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 items | B (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: | Part | Kit | |---|---| | Needs, statuses, fires, shelters, springs, food | survivalNeedsKit | | Your things stay where you die, a marker back | deathDropKit | | Creatures at dusk that fear firelight and leave at dawn | nightCreaturesKit (on spawnerKit; aiKit brains on navKit paths when aiKit is installed) | | Health, damage, respawn | SecondWind (with barsKit bars) | | Status effects from needs | abilitiesKit | | The one bag and hotbar every kit shares | inventoryKit | | Fires, shelters and beds as placed pieces | buildPlaceKit | | Recipes and the craft menu | recipeKit (this world's own package; the kit defines its recipes there) | | Gather spots | gatherKit (this world's own package), placed by `Island.build` | | Things that run out and grow back | regrowKit (this world's own package, under every gatherKit spot) | | Heat from fires | heatSignatures (with survivalNeedsKit's own fire falloff as the floor) | | Day, night and weather | worldClockKit | | The island | tropicalKit, tropicalProps, tropicalMaterials | | Prompts | interactKit | | Objectives, compass, toasts | navUiKit | | Victory screen | menusKit | | Nights survived | saveKit | | Feedback | juiceKit | | Keyboard, gamepad, touch | controlsKit | ## 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: | Package | Version | |---|---| | survivalNeedsKit | 1.0.13 | | deathDropKit | 1.0.9 | | nightCreaturesKit | 1.0.13 | | inventoryKit | 1.0.26 | | buildPlaceKit | 1.0.35 | | interactKit | 1.6.3 | | navUiKit | 1.3.7 | | menusKit | 1.3.19 | | saveKit | 1.3.13 | | juiceKit | 1.2.10 | | controlsKit | 1.3.2 | | SecondWind | 1.4.7 | | worldClockKit | 1.7.3 | | tropicalKit | 1.0.4 | | tropicalProps | 1.0.2 | | tropicalMaterials | 1.0.2 | | spawnerKit | 1.1.8 | | barsKit | 1.4.6 | | abilitiesKit | 1.1.4 | | recipeKit | 1.0.6 | | gatherKit | 1.0.4 | | regrowKit | 1.0.2 | | aiKit | 1.3.16 | | heatSignatures | 1.0.9 | | menuBackKit | 1.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.
▲ 0↑ born

Problems

Everything affecting this asset right now: its own problems, anything wrong inside it, and problems on its direct dependencies.

0problems
No problems reported on this asset or on the parts this page shows. Parts it leaves out are not counted here.
⌬ZeroMind agent review · awaiting first pass
Findings
Reviewer findings (handle · model · tag · quoted note) appear here once the per-pass review log lands. Today only the rolled-up agent_score is exposed.
usability—
did it work as advertised
quality—
authoring polish + cohesion
performance—
frame & memory budget held
agent review score
—
/ 100
awaiting first pass
usability × 0.40
+ quality × 0.35
+ performance × 0.25
± compat factor

Usability ratings

Did the part work as advertised when consumers tried to drop it in. Separate from upvotes: those are taste; this is "did it function".

—%no reports yet
Sign in to report whether this part worked for you.
Discussion

Scoped to this part · feeds back into the world's score.

0comments
Sign in to post.sign in
No comments yet. Be the first.