Log inGet started
World

Castaway Isle: Island Survival and Crafting Kit

Branchmain
Branchesmain
Commit2a168afc93

README.md

setUpYourOwnSurvivalIsland

Make a survival game where you survive the night on an island: an island survival crafting game built with survivalCraftKit, set up with your own choices from start to a tested first night.

What it does

  1. Choose. Asks the creator every choice that shapes the game, with the kit's real values: the scene, the island start (cove, volcano, atoll), the survival mode (castaway, cozy, hardcore, creative), survivalNeedsKit's needs rules and climate, the needs HUD layout and theme, deathDropKit's drop style, look, rule and marker, nightCreaturesKit's threat set, density and whether creatures come at all, the tropicalKit island look, the styleKit art look (saturdayMorning by default, as in the Castaway Isle showcase), and optionally day length and start hour. Picking a mode fills in the rest; any choice can then be changed.
  2. Scene. Makes the scene (or reads an existing one) and writes its build.luau as one call: Island.build({ start, mode, look, hudTheme, hudLayout, dayLengthMinutes, startHour }) from survivalCraftKit.island, then checks the island, clock, CastawayGame, NightDirector, player, spawn, gather spots and spring are there.
  3. Rules. When the choices are not exactly a preset mode, registers a custom mode in Castaway.MODES from the scene's entrypoint.luau (needs, climate, drops, drop style and look, threat, density, creatures), so CastawayGame sets up survivalNeedsKit, deathDropKit and nightCreaturesKit with them on every peer. A drop marker other than both is set with Drops.setup({ marker }) on Castaway.on("setup").
  4. Look. Applies the art look with StyleKit.applyLook(look) on the scene's synced StyleStack and checks the HUD still reads.
  5. Play. Presses Play and proves the first night: gather wood, stones and fiber, craft a stone axe and a torch, build a campfire and a shelter, drink at the spring, speed the clock to dusk, see the creatures keep away from the fire, die and recover the drop, and reach dawn and the "You survived the night" screen. Also checks the touch controls on a phone-sized screen.
  6. Report. Answers with the scene, the build call, the mode, every choice, the checks, fixes and remaining problems, the controls, and where to change each choice later.

What it needs

survivalCraftKit and the kits it uses (survivalNeedsKit, deathDropKit, nightCreaturesKit, inventoryKit, buildPlaceKit, SecondWind, worldClockKit, tropicalKit and the rest), and styleKit with toonBlocks for the toon art looks: install survivalCraftKit into the world first (one step; about eight minutes the first time, since it fetches about forty packages), or run this in a fork of the Castaway Isle world, which already holds them all. The first build cooks the island ground, which takes about half a minute.

Controls the game gets

Keyboard: WASD, mouse, Space jump, E interact and pick up, X swing, C craft, Tab bag, 1 to 8 hotbar. Gamepad: stick, A jump, X interact, Y swing, Select craft. Touch: floating stick with Jump, Swing, Craft and Sprint buttons.

Starting it

zero workflow start --name setUpYourOwnSurvivalIsland
zero workflow start --name setUpYourOwnSurvivalIsland --args '{"scene":"myIsland","choices":{"start":"volcano","mode":"hardcore","artLook":"saturdayMorning"}}'

scene names the scene (default: asks, proposing myIsland); choices holds any choice already decided, which is then not asked.