Skip to main content
nebulaModding docs
Nebula home

LumaKit reference

Look up every module of LumaKit, the library mod of ready-made parts.

#About the LumaKit reference

LumaKit is one library mod with the id lumakit. A mod that uses a module adds lumakit to the needs of its luma.json and writes use kit.<module>. Each page lists the module's public declarations as its source declares them.

#Modules

Module Gives
kit.actor a new object kind in a few lines, and the helpers a mod's own class uses for the usual parts.
kit.area new kinds of area, placed like the game's, with what happens inside.
kit.camera the main camera taken for a time, camera rigs for views (follow, eye, side, above), mirror, field of view. A rig is a draw.ViewCamera (svc.draw), so the same rig drives the main camera or a draw.view.
kit.cutscene scripted scenes of shots and lines, waited on, skippable.
kit.gravity the player's gravity overridden, new gravity shapes placeable like the game's, the gravity at a point.
kit.hud counters, timers, meters, text, pictures in corners; text in 3D; popups; subtitles; the game's own HUD parts hidden.
kit.item things picked up, placed in stages by name or made by code, in containers, carried in an inventory.
kit.menu entries in the game's pause menu. (A mod's settings are its luma.json options on the Mods page, read with option and on option: a setting is an option, not a menu entry.)
kit.net.kit reliable ordered messages and rooms over the net service's datagrams; a clock shared between peers; a small HTTP and WebSocket server for a page (a phone as a controller).
kit.player.character a playable character (name, icon, model, animations, voice, constants), switching mid-level, a second player.
kit.player.form a power-up: its look, aura, timer, music, what the player's actions do while it lasts, its own physics and scale, and the game's own forms by name to give from code.
kit.player.state a new move (its trigger, animation, physics each frame, how it ends, whether it attacks) and the player's constants changed by name.
kit.pointer the star pointer: where it points on screen and in the world, what B throws and what it costs, grabbing, the source that aims it (IR, gyro, mouse, stick), a co-star pointer.
kit.progress stars beyond 120 and new star kinds counted, comets added to any galaxy, per-file flags and counters, what a star gives, new-file rules.
kit.projectile things thrown or shot, with bounces, life, trail, burst and a hit callback.
kit.replay recording and playing back poses, puppets posed from data, input files played frame-exactly, rewind of the player and chosen actors.
kit.ride mounts and vehicles: getting on and off, their moves, the player posed on them.
kit.screen whole screens: a message, a choice, a list, a loading screen, a layout of the mod's as a screen.
kit.shop buying things with coins or star bits.
kit.stage new galaxies with stars and comets in the domes, a new dome, music per galaxy, warping, stars appearing, the hub replaced, stages built in code.
kit.talk lines and choices from an actor in the game's balloon, dialogue trees, voice for lines.
kit.ui.kit widgets for a mod's own panels: buttons, sliders, toggles, color pickers, lists, text fields, a wheel, a model view; pad, mouse and touch focus.

#Further reading