Log inGet started
Package

setup.module

Newest version

README.md

arpgKit.setup

One-time authoring helpers, run from the console in edit mode. Called by people setting up a world, never by the game.

  • require("arpgKit.setup").prepare(): readies a new world's scene for arpgKit, whichever way the world started. A new world arrives either with Zero's empty-world template (a default player and its spawn point, ground, sun, ambient light, sky, two lamp posts and a crate; left in, the engine spawns players as that default player instead of the hero) or with no scene loaded at all. prepare makes the main scene when none is loaded (keeping a build.luau already written there, else writing the quick start's), deletes the template, and sets the scene to give each joining user a player, keeping arpgKit's own player and spawn. Run it after writing build.luau. Returns { created, cleared, players }.
  • clearStarter(): deletes only the template entities, through the engine's entityOps tool; the scene saves itself.
  • starterLeft(): the template entities still in the scene, changing nothing.
  • foreignSpawns(): every player spawn besides arpgKit's own Start (ArpgGame warns in play when there is one).