# survivalNeedsKit
**Add hunger, thirst, staying warm, rest, stamina, getting soaked, sanity and oxygen to any multiplayer Zero game.** For creators asking "how do I add hunger and thirst to my game", "how do I make players get cold at night" or "how do I make a survival game with food and water". Every player has their own meters on their own body, statuses like Well Fed or Freezing change how they play, and you pick the rules, the climate, the HUD layout and the theme by name.
Version 1.0.13. New in 1.0.13: a burning fire no longer breaks heatSignatures. The fire's own heat record gave heatSignatures `active = true` where it reads a temperature, so heatSignatures' whole tick failed every frame while a fire burned; it gives 420 C now, the same as the fire's built piece. New in 1.0.12: 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.11: status chips (Shivering, Soaked, Well Fed and the rest) stand side by side with room for their names; before, an emoji at the head of each chip's text made it too narrow and the names ran over each other. New in 1.0.10: a fire that went out is cold the moment it dies. heatSignatures cools the stones and sand round a fire over minutes, so what it reads beside a dead fire no longer counts as warmth unless something there is still burning (before, a burnt-out fire kept a player warming for about two minutes). New in 1.0.9: a fire that has gone out is cold everywhere. heatSignatures warmth only counts with something hot in reach, so sun-warmed sand no longer warms you, and a HeatSource's new `piece` field makes the built thing it belongs to (a campfire piece) read hot only while it burns. A fire that runs out goes cold: its warmth and light stop at once, and with heatSignatures installed its heat record goes too (a dead fire no longer warms anyone). Rain comes from worldClockKit's live weather, so a shower soaks you outside, and a Shelter keeps you dry and holds most of the night's cold out (`insulation`). All six HUD layouts are now barsKit bars. Fires can always be brought back: feed one wood, palm leaves, fiber or a coconut, or light it with a torch or a flint once it is out (`feedFire`, `lightFire`, `HeatSource:relight`). Each player's meters are saved with **saveKit** when it is installed, so hunger, thirst and the rest come back as they were left after leaving play, rejoining or restarting the world. Built on **SecondWind** (empty meters hurt, healthy ones heal), **barsKit** (all six HUD layouts), **inventoryKit** (food and drink are bag items) and **worldClockKit** (needs follow the shared day and night). Works with **tropicalKit**'s island for the sea (wading soaks you, diving uses oxygen) and with **abilitiesKit** for status effects.
## Quick start
In your scene's `build.luau`, after the default player setup (`body` is the player's body), and in its `entrypoint.luau`:
```luau
body.component.add(asset.resolve("survivalNeedsKit.SurvivalNeeds", "component"), {})
local fire = entity.spawnSynced("Campfire", { position = { 4, 0, 6 } })
fire.component.add(asset.resolve("survivalNeedsKit.HeatSource", "component"), { radius = 6, warmth = 30 })
local spring = entity.spawn("Spring", { position = { -6, 0, 3 } })
spring.component.add(asset.resolve("survivalNeedsKit.WaterSource", "component"), { label = "Spring" })
-- entrypoint.luau
local Needs = require("~survivalNeedsKit.needs")
function onLoad()
Needs.setup({ rules = "castaway", climate = "tropical", layout = "corners", theme = "realistic" })
end
```
Your scene needs a worldClockKit WorldClock: needs drain by in-game hours, so without a clock they hold still. Press Play: your meters sit on the left edge, drain with the clock, and the spring and fire bring them back.
## Styles and choices
| Setting | Values |
|---|---|
| `rules` | `off` (creative), `cozy`, `standard`, `castaway`, `hardcore`, `horror` |
| `climate` | `tropical`, `temperate`, `desert`, `arctic`, `swamp` |
| `layout` | `corners`, `ring`, `pips`, `silhouette`, `minimal`, `hotbarStrip`: every one is barsKit bars (the theme's look, then barsKit's `ring`, `pips`, vertical `gauge`, `line` and the theme's look again); without barsKit the kit draws its own panels |
| `theme` | `scifi`, `fantasy`, `cartoon`, `pixel`, `minimal`, `realistic`, `horror`, `cozy` |
| Rules | What runs |
|---|---|
| `off` | No needs at all: build and explore freely. |
| `cozy` | Hunger, thirst, warmth, rest, gentle and slow. |
| `standard` | Adds stamina and getting soaked. |
| `castaway` | Adds oxygen; thirst bites and the sea soaks you. |
| `hardcore` | All eight, fast, no natural healing. |
| `horror` | Sanity drains in the dark and away from fire. |
| Climate | Feel |
|---|---|
| `tropical` | Hot days, cool damp nights, sudden showers. |
| `temperate` | Mild days and properly cold nights. |
| `desert` | Scorching sun, freezing nights, thirst doubles at noon. |
| `arctic` | Cold all day, deadly at night: a fire is life. |
| `swamp` | Warm, wet and never quite dry. |
### The needs
- **Hunger, thirst, rest, sanity** drain by the in-game hour, so any day length works.
- **Warmth** moves toward how warm it feels: the climate's day and night air, plus every burning HeatSource nearby, minus a chill when you are soaked. Under a Shelter the roof keeps out `insulation` (0.6 by default) of the night's cold and adds its own `warmth` (6), so a lean-to at night feels far warmer than the open beach (about 62 against 34 on the tropical island).
- **Wetness** rises in the sea and in rain outside a shelter (worldClockKit's blended weather: steady rain soaks you in a few seconds), and dries by the fire and in the sun.
- **Stamina** drains while sprinting and returns faster when fed and rested.
- **Oxygen** drains while your head is under the sea and comes back fast in the air.
A meter at its critical line hurts through SecondWind (`label = "Exposure"`); all meters healthy heal slowly. After a SecondWind respawn the meters refill to `respawnFill` percent.
### Statuses
Seven statuses come from what the meters add up to. They show as small chips on every HUD layout, fire the `statusOn` and `statusOff` events, and with abilitiesKit installed each becomes a real abilitiesKit effect on the body called `survival_<id>`.
| Status | Effect |
|---|---|
| `wellFed` (bonus) | Health comes back slowly and stamina refills 30% faster. |
| `starving` | Your swings deal 30% less damage. |
| `parched` | 15% slower, stamina refills at half speed. |
| `shivering` | 10% slower and you jump lower. |
| `freezing` | 35% slower and you lose health until you warm up. |
| `soaked` | 10% slower and you take 15% more damage. |
| `exhausted` | 25% slower and stamina barely refills. |
### Food and drink
Eighteen inventoryKit items with `useEffect = "event"`: coconut, wild berries, banana, mango, raw fish, cooked fish, crab meat, grilled crab, seaweed, fresh water, coconut water, herbal tea, fish stew, roasted root, jerky, honeycomb, ration bar, bitter coffee. Use one from the hotbar and it feeds the needs it lists. Add your own with `Needs.defineFood`.
## API
### needs module
`local Needs = require("~survivalNeedsKit.needs")`
- `setup(opts)`: pick `rules`, `climate`, `layout`, `theme` by name (any subset); call on every peer, changes apply live. `persist` (default true) saves each player's meters with saveKit; `persist = false` starts every session from the start values.
- `persists()`: whether the meters are saved (`persist` is on and saveKit is installed).
- `savedState()`: the local player's saved meters, `{ v = 1, needs = { hunger = 72.4, ... } }`, or nil when nothing is saved yet, saveKit is missing or the save has not loaded.
- `config()`: a copy of the current settings.
- Fires: `fires({ includeOut = true })` lists every HeatSource, burning or out (without it, only burning ones); `fireNear(x, z, range?)` is the nearest one in reach. `feedFire(fire, item?)` puts one fuel item from the local player's bag on it (`FUEL`: wood 120 s, palm leaf 40, coconut 30, fiber 20; `defineFuel(item, seconds)`), which also lights it again when it was out. `lightFire(fire)` lights a fire that is out with a lighter from the bag (`LIGHTERS`: torch, flint; `defineLighter(item)`), burning on what fuel is left, or on `KINDLING` (45 s) when it burned out. `tendAction(fire)` says which of the two the local player can do there, with prompt words. On the component, from any peer: `HeatSource:addFuel(seconds)` and `HeatSource:relight(kindling?)`.
- `rules()`: the current rule preset table.
- `climate()`: the current climate table.
- `active(need)`: whether a need runs under the current rules.
- `activeNeeds()`: the needs that run, in display order.
- `catalogue()`: every preset, climate, layout, theme, need and food, for menus and agents.
- `on(event, fn)`: listen to an event; returns a function that stops listening. Events: `changed`, `low`, `critical`, `recovered`, `ate`, `drank`, `setup`, `statusOn`, `statusOff`.
- `defineFood(id, def)`: add a food or drink: `{ name, gives = { hunger = 20 }, hp?, rarity? }`.
- `describeFood(id)`: a short text of what a food gives.
- `defineFoods()`: register every food as an inventoryKit item (done for you).
- `consume(foodId)`: apply a food's effect to the local player.
- `get(need)`: the local player's value for a need (0..100), or nil before their body is ready.
- `state()`: every need of the local player, `{ hunger = 72, ... }`.
- `add(need, n)`: change a need of the local player by n points (negative to drain).
- `spend(n)`: spend stamina; returns false when too tired.
- `of(body, need)`: read another player's need from their body (synced).
- `heatAt(x, y, z)`: heat at a point from every burning HeatSource.
- `lightAt(x, y, z)`: firelight at a point (0..1), for creatures that fear fire.
- `fires()`: every burning heat source, `{ { x, y, z, radius, lightRadius } }`.
- `shelterAt(x, y, z)`: the Shelter covering a point, or nil.
- `waterAt(x, y, z)`: the WaterSource within reach of a point, or nil.
- `darkness()`: 0 in full day, 1 at night.
- `rain()`: 0..1, how hard it is raining.
- `waterDepth(x, y, z)`: how far below the sea surface a point stands; 0 on land.
- `temperatureAt(x, y, z, wetness?)`: the felt temperature on the 0..100 comfort scale (50 is comfortable).
### statuses module
`local Statuses = require("survivalNeedsKit.statuses")`
- `define(id, def)`: add or replace a status: `{ label, icon, color, good?, when = { { need, op, value } }, description, effect, heal?, hurt? }`.
- `evaluate(values, running?)`: which statuses a set of need values gives, in order.
- `active()`: the local player's statuses right now.
- `has(id)`: whether the local player has a status.
- `STATUSES`, `STATUS_ORDER`: the status table and its display order.
### hud module
- `draw(c)`: draw the HUD for the local player's SurvivalNeeds component (done for you).
- `restyle()`: tear the HUD down so the next draw builds the chosen layout fresh.
- `teardown()`: remove the HUD.
### Components
**SurvivalNeeds**: one player's meters, on the PlayerPrototype body. Owner-written, synced.
- `hunger`, `thirst`, `warmth`, `rest`, `stamina`, `sanity`, `oxygen` (0..100), `wetness` (0..100, 0 is dry).
- `sprintSpeed` (5.2): ground speed above which the player spends stamina.
- `headHeight` (1.55): how deep the feet must be for the head to be under water.
- `respawnFill` (60): what each meter is set to after a respawn (percent).
- Methods: `value(need)`, `add(need, n)` (owner only), `refill(pct?)`.
**HeatSource**: a fire, torch or brazier on a synced entity.
- `radius` (6): how far the warmth reaches. `warmth` (30): comfort added at the centre.
- `lightRadius` (9): how far its light keeps night creatures away.
- `burning` (true), `fuel` (-1 burns for ever), `maxFuel` (600 seconds).
- `flame` (true), `flameSize` (1), `flameHeight` (0.25): the drawn flame and light.
- Methods: `heatAt(x, y, z)`, `lightAt(x, y, z)`, `describe()`, `addFuel(seconds)` (any peer, relights), `setBurning(on)`.
**Shelter**: inside its footprint rain stops, the roof keeps out `insulation` of the night's cold and adds `warmth`, and standing still restores rest.
- `radius` (2.5), `height` (3), `restBonus` (1).
- Method: `covers(x, y, z)`.
**WaterSource**: press E (pad X, or tap the prompt) to drink.
- `radius` (2.2), `label` ("Spring"), `amount` (35 thirst per drink), `cooldown` (1.2 s).
- `fill` (true): also give a Fresh Water to carry when the bag has room.
- `container` (""): item a player must carry to fill water, such as a flask; empty fills without one.
- `salty` (false): sea water makes you thirstier instead.
- Methods: `reaches(x, y, z)`, `drink()`, `prompt()`.
**NeedsGallery**: a panel to try every layout, theme, rule preset and climate.
- `tour` (true), `tourSeconds` (3), `open` (true).
## Works with heatSignatures
When heatSignatures is installed, every burning HeatSource also registers as a fire in heatSignatures (so a thermal look draws it) and is taken out again the moment it goes out, so a dead fire reads cold there too. The fire's owner gives the scene a heatSignatures climate that matches the needs climate if it has none, and `Needs.heatAt` reads heatSignatures' temperature (`Heat.at`, `HEAT_PER_DEGREE` points per degree above the air) and takes the larger of that and the fire's own falloff. Anything heatSignatures knows to be hot then warms a player too, so a fire drawn by another kit (a buildPlaceKit campfire piece) has to go cold there as well: survivalCraftKit puts the piece out with `Build.setLit` when its HeatSource dies. Without heatSignatures the fires' own falloff is the whole story.
## What it installs
Installing survivalNeedsKit brings these packages, each from its own world, at the versions it was built and tested with:
| Package | Version |
|---|---|
| SecondWind | 1.4.7 |
| barsKit | 1.4.6 |
| inventoryKit | 1.0.26 |
| worldClockKit | 1.7.3 |
## Saving
With saveKit installed (and `persist` left on), the local player's own SurvivalNeeds writes their meters to their saveKit profile under the key `survivalNeedsKit.needs` every 5 seconds when they changed, and once more when the body goes away (leaving play or the world). When the body starts again, the meters wait (at most 8 seconds) for saveKit to load the player's save, then take the saved values back, clamped 0..100, for every need the current rules run, before the first drain. A player who leaves while dead is saved with what a respawn gives them (`respawnFill`, dry, full stamina and oxygen), and a SecondWind respawn still refills the meters as before. Each player's values live in their own saveKit profile, so players never share meters. In saveKit's `checkpoint` mode the values are kept only when saveKit saves at a checkpoint. Without saveKit the kit works as before and nothing is saved.
## Multiplayer
Each player's engine owns and writes their own SurvivalNeeds; the values are synced so anyone can read them. HeatSource `burning` and `fuel` are synced and burned down by the entity's owner; `addFuel` from any peer is sent to the owner. Drinking and eating change only your own meters.
## Gallery
Put a **NeedsGallery** on any entity to step your own HUD through all six layouts and eight themes (buttons, the [ ] and - = keys, or an automatic tour) and to try every rule preset and climate with a click. The Castaway Isle world has a gallery scene with all four castaway galleries side by side.
## Guides
- **How do I add hunger and thirst to my game** (`survivalNeedsKit.package/how-do-i-add-hunger-and-thirst-to-my-game.guide`)
- **Example: island survival, stay fed, watered and warm through the night** (`survivalNeedsKit.package/example-island-survival-stay-fed-watered-and-warm-through-the-night.guide`)
## Tests
32 tests in `survivalNeedsKit.testSuite`. Run them with `asset.resolve("survivalNeedsKit", "testSuite"):run()`.
## Known limits
- Warmth from the sun is a climate number; there is no shade simulation.
- Oxygen needs a sea at height 0 (tropicalKit's island) to know when your head is under.