glideKit
Gliding for the player in any Zero game:** nine gliders (wingsuit, hang glider, paraglider, umbrella, cape, bird wings, jet wing, paper crane and a giant leaf) that open in mid-air, eleven trail looks you can put on any glider, and five flight feels you swap with one change: **cr…
glideKit
Gliding for the player in any Zero game: nine gliders (wingsuit, hang glider, paraglider, umbrella, cape, bird wings, jet wing, paper crane and a giant leaf) that open in mid-air, eleven trail looks you can put on any glider, and five flight feels you swap with one change: cruiser (floaty, long hang), diver (fast dives, high top speed), stunt (snappy rolls, chained boost rings), beginner (forgiving, levels itself, never runs out of speed) and realistic (real glide ratio, energy and stalls). Diving always builds speed and levelling out floats. Build courses with updrafts, thermals and boost rings. Keyboard + mouse, gamepad and touch. Multiplayer: every player has their own glider and everyone sees everyone's, late joiners included.
Movement goes through airMotor (installed with it): opening from a jump, a fall, a launch pad or a grappling-hook release keeps the motion you had, and a hook at a higher airMotor priority takes over cleanly. Version 1.0.15.
Variety: 36 variants
| Kind | Count | Variants |
|---|---|---|
Gliders (style) | 9 | wingsuit, hangGlider, paraglider, umbrella, cape, birdWings, jetWing, paperCrane, leaf |
Trails (trail) | 11 | streaks, wingtips, petals, sparkles, feathers, jet, confetti, leaves, smoke, rainbow, pixel (plus none, and "" = the glider's own default) |
Feels (feel) | 5 | cruiser, diver, stunt, beginner, realistic |
| Updraft looks | 4 | wind, leaves, sparkles, heat |
| Thermal looks | 3 | mist, warm, pollen |
| Boost ring looks | 4 | golden, magic, scifi, cloud |
Every one of them is on show, labelled, in gallery.scene (the world's startup scene), and the test suite checks every glider on every feel.
Changelog
1.0.16
- The package description says what glideKit gives you and how to install it. Takes airMotor 1.0.9 (its description says the same; no code change).
glideKit.apireportsVERSION = "1.0.16".
1.0.15
- The paraglider canopy no longer covers the view. While a canopy style (paraglider, umbrella) is open, the player's own orbital camera eases back by
canopyFramingScale(1.8x, fieldcanopyFraming, on by default) so the canopy reads as a shape overhead instead of a wall of stripes, and comes back when it closes or lands. The occlusion hide (1.0.13/1.0.14) still covers a camera pushed right up to it. - The top of this README names the current version (it still said 1.0.12). Both guides name 1.0.15. Takes airMotor 1.0.8.
glideKit.apireportsVERSION = "1.0.15".
1.0.14
- The canopy no longer flashes into view for a frame or two in a fast swing release. The occlusion check ran on where the camera was, and the camera moves after it, several metres a frame in a release, so the canopy could fill a third of the screen before it hid. It now also tests where the camera is heading (its own velocity, 0.12 s ahead) and the margin round the canopy is 2.5 m; the normal chase view still shows the canopy.
- Both guides name the version they describe (1.0.14). Takes airMotor 1.0.7.
glideKit.apireportsVERSION = "1.0.14".
1.0.13
- The paraglider's canopy never fills the screen. When the chase camera rose to the top of its orbit it sat right behind the canopy's trailing edge, and a wall of canopy stripes covered the view. Each player's own view now hides a canopy (paraglider, umbrella) while the camera is inside it or within 1.5 m of it, and shows it again 0.35 s after the camera leaves; other players still see it, and the normal chase view is unchanged. Styles list their canopy in
occluders;Models.cameraNearis the test; the Glider fieldcameraOcclusion(on by default) turns it off. One new test. glideKit.apireportsVERSION = "1.0.13".
1.0.12
- New: the
build-a-gliding-courseworkflow, for the whole job in stages (survey, plan the air, build, fly it until it lands). Start it withzero workflow start --name glideKit.build-a-gliding-course. glideKit.apireportsVERSION = "1.0.12". Behaviour is unchanged.
1.0.11
- Paraglider harness reads as a harness: it was two flat near-black boxes, and the back one covered the pilot's whole torso from the chase camera. It is now a rounded seat pod, a slim back pad low on the back, orange shoulder, chest and riser straps, and metal carabiners at the risers, so the pilot stays visible between the straps.
- airMotor 1.0.6 is now the pinned dependency (was 1.0.5): the release grappleKit 1.0.10 and Skyhook run, so a world with both runs one airMotor.
glideKit.apireportsVERSION = "1.0.11".
1.0.10
- Example guide works in a brand-new world: step 2 now remakes
scenes.mainclean before writing the level. A new world's seeded starter scene carries recorded edits, so the rewrittenbuild.luauwas refused ("composition has structural conflicts") and no level appeared. Checked by installing into a new empty world and following the guide: walk onto the pad, Space opens the wingsuit, the rings chain to about 49 m/s. glideKit.apireportsVERSION = "1.0.10". Behaviour is unchanged.
1.0.9
- The README intro names the current version (it still said 1.0.7).
- airMotor 1.0.5 is now the pinned dependency (was 1.0.3), matching what grappleKit and Skyhook ran at the time (both have since moved to 1.0.6; see 1.0.11).
glideKit.apireportsVERSION = "1.0.9". Behaviour is unchanged.
1.0.8
- Guides say which kit they belong to: both guides open with a "Part of glideKit" line naming the ZeroMind package and how to install it, and their descriptions name the kit.
glideKit.apireportsVERSION = "1.0.8". Behaviour is unchanged.
1.0.7
- Quick start works in a brand-new world. It told you to "jump, press Space", but a jump off a new world's flat starter floor peaks at about 1.2 m, under the glider's 1.6 m
minOpenHeight, so the glider never opened. The Quick start now adds a 20 m launch tower and puts thePlayerSpawnon top, and it addsGliderto the starter's existingbodyinstead of spawning a second one. The how-to guide says the same. Checked by installing into a brand-new empty world and following the README. glideKit.apireportsVERSION = "1.0.7". Behaviour is unchanged.
1.0.6
- Guides renamed after what you want to do:
how-to-add-a-glider-or-wingsuit-to-my-gameandexample-build-a-small-gliding-level-with-updrafts-and-boost-rings(the old kit-named guides are gone). - Example level fixed: the three boost rings now sit on the glide line off the tower (all at 50 m), so a straight glide chains all three (about 23, 35, 48, 64 m/s on the stunt feel); before, they hung 6 to 18 m below it and a straight glide missed them. The guide now says to dive onto the landing island, which that speed carries you over. Played end to end in the glideKit world.
- airMotor 1.0.3 is now the pinned dependency (was 1.0.1), the same release grappleKit pins, so a world with both runs one airMotor.
glideKit.apireportsVERSION = "1.0.6". Behaviour is unchanged from 1.0.5.
1.0.5
- Five feels, each one change away (
feel = "..."orGlide.setFeel):cruiser(floaty, long hang, gentle),diver(the old wingsuit feel tuned up: trim 28 m/s, top speed 85 m/s, steeper dive, more tuck),stunt(420°/s rolls, quick pitch, tight turns, boost rings chain: each ring within 2.5 s of the last pushes 35% harder, up to four in a row),beginner(slow sink, self-levelling, gentle steering, stall at 4 m/s and an airspeed floor at 70% of trim, so it cannot lose all its speed) andrealistic(10:1 glide ratio, energy conserved, a proper stall). The old names still resolve as hidden aliases:floaty->cruiser,wingsuit->diver,arcade->stunt,sim->realistic; the default isdiver(waswingsuit). New optional Feel fieldsminSpeed,boostChain,chainWindow. The dive guarantee holds on every glider x feel: 3 s of full dive from trim gains at least +63% (diver) and carries into the level-out. - No more trail error when a player joins. The look is now stored and replicated as
trailLook(a string no earlier version declared), andtrailis an alias onto it, sotrail = "smoke"keeps working everywhere while peers on 1.0.3 (booleantrail) and 1.0.4 (stringtrail) never collide on the key.Glide.setTrailandcatalog.resolveTrailtake the old booleans (true -> the glider's own trail, false ->none), andGlide.repairLegacyTrails()rewrites a scene saved before 1.0.4 that still stores"trail": true/false. Same onGliderDisplay. - No visibility churn. Pooled trail and updraft particles no longer hide and show as they recycle (a finished particle shrinks to nothing instead), so idle gliders, updrafts and thermals stop flooding the log with
hier-gate ... hidden=true/false. - Gallery shows the five feels, labelled. Guides renamed: "How to use glideKit to add a wingsuit or glider to my game" and "Example: building a small level or game with glideKit from an empty world".
1.0.4
- Dives build speed on every glider and feel. Holding forward used to fight the full drag that holds trim, so a fast feel gained barely a third in three seconds while the path tipped down and forward speed collapsed (22 to 9 m/s forward with the total speed barely moving); a slow glider opened from a fast fall or swing sat at its speed cap and gained nothing. Now holding dive tucks in and sheds most of the drag (feel field
tuck, default 0.6), and every glider's cap sits at least 2.6x its trim speed. Over 3 s of full dive from trim every glider on every feel gains at least +56% (wingsuit +70%, umbrella +142% in play), and letting go carries the extra speed into the 1.0.3 level-out. - Leaf glider (
style = "leaf"): a giant cupped leaf held overhead by its curving stem, the gentlest and floatiest ride, with its own rustling open, close and breeze sounds and a flutteringleavestrail. - Trails are independent of gliders. New
trailfield onGlider(andGliderDisplay),Glide.setTrail(name), and three new looks (smoke,rainbow,pixel).""keeps the glider's own default. The catalog now keeps gliders (catalog.gliders, alsocatalog.styles) and trails (catalog.trails) in separate tables. The old booleantrailfield is now this string; usetrail = "none"to turn the trail off. - Clean replays.
Glide.onlisteners added during play are dropped when play ends, so entering play a second or third time no longer fires old callbacks. - Gallery shows every glider, every trail, a dive chart per feel and every updraft, thermal and ring look side by side. Guides renamed and updated.
1.0.3
Floaty level-out. Let go of the stick with speed to spare (after a dive or a hook release) and the glide path flattens: level flight at 1.6x trim speed, easing back to the trim angle as the speed bleeds off.
1.0.2
Updraft and Thermal take base = false to drop the ground dressing (the pool, vent, rocks or meadow at the bottom of the column), for air that hangs in mid-air between floating islands.
Install
Search ZeroMind for glideKit and install glideKit.package (guid 40b1c795-5d8f-48d0-9db0-9f25fef93eb4; it brings airMotor.package), or from Luau:
tools.use("zeromind", "installAsset", "40b1c795-5d8f-48d0-9db0-9f25fef93eb4")
Quick start
For a whole gliding course in stages (survey, plan the updrafts and rings, build, fly it until it lands), start the workflow that ships in this package: zero workflow start --name glideKit.build-a-gliding-course (args: level, style).
Add Glider to your player prototype's body, next to its CharacterController, give the player somewhere high to start, and place world pieces. In a new world's starter scenes/main.scene/build.luau, content() already makes the prototype's body and the PlayerSpawn (spawn); add to it:
-- right after the starter's body.component.add("Asset", ...) line:
body.component.add("Glider", { style = "wingsuit", feel = "diver", trail = "" })
-- a 20 m launch tower; the starter floor is flat, and a jump off it is too low to open a glider
local tower = entity.spawn("tower")
tower.component.add("Model", { model = "cube" })
tower.component.add("BoxCollider", {})
tower.localPosition = { 0, 10, 0 }
tower.localScale = { 6, 20, 6 }
local up = entity.spawn("updraft"); up.localPosition = { 10, 0, 40 }
up.component.add("Updraft", { look = "wind", radius = 4, height = 40, strength = 12 })
local ring = entity.spawn("ring"); ring.localPosition = { 0, 30, 80 } -- boosts along its +Z
ring.component.add("BoostRing", { look = "golden", boost = 14 })
-- at the end, after spawn.component.add("PlayerSpawn", ...): start on top of the tower
spawn.localPosition = { 0, 21, 0 }
Press Play, walk or jump off the tower, and once you are in the air press Space (or Shift/G, pad A in the air or LB, the touch Glide button) and fly: forward dives (and builds speed), back pulls up, left/right banks. Press again to close; landing closes it. The glider opens only with at least minOpenHeight (1.6 m) of air below you, so a jump off flat ground (about 1.2 m) does not open it: start from a ledge, a tower, an island, a launch pad or a grapple release.
From code: local Glide = require("glideKit.api") then Glide.open(), Glide.close(), Glide.isOpen(), Glide.setStyle("leaf"), Glide.setTrail("rainbow"), Glide.setFeel("stunt"), Glide.on("boosted", fn), Glide.readout(), Glide.airAt(pos).
Glider fields
| Field | Default | What it does |
|---|---|---|
style | wingsuit | Which glider (see Gliders). Replicated. |
trail | "" | Which trail look (see Trails); "" = the glider's own default, none = no trail. Replicated as trailLook; the pre-1.0.4 booleans map true -> "", false -> none. |
feel | diver | How it flies: cruiser, diver, stunt, beginner, realistic (see Feels; old names still work). Replicated. |
open | false | Open now (replicated; every peer draws from it). |
steering | stick | stick: sideways banks. camera: banks toward where the camera looks. Forward dives and back pulls up in both. |
invertPitch | false | Back dives, forward pulls up. |
openInAir / minOpenHeight | true / 1.6 | Glide opens in the air with at least this much air below. |
autoClose | true | Close on landing with a short skid. |
cameraFx / cameraFollow | true / true | FOV kick + shake with speed; ease an orbital camera behind the glider. |
cameraOcclusion | true | hide a canopy (paraglider, umbrella) in this player's own view while the camera is inside or right at it, so it never fills the screen. |
windScale | 1 | How much the air (updrafts, thermals, any engine Wind) moves it. |
sound | true | Open, close and wind sounds. |
priority | 2 | airMotor priority (a hook at 3 takes over). |
speed, verticalSpeed, altitude, stalled | Readouts for a HUD. |
Gliders
wingsuit (prone, membranes between arms and legs) · hangGlider (striped delta on an A-frame, prone below) · paraglider (ram-air canopy on lines, seated) · umbrella (held overhead, slow and floaty) · cape (crimson cape tied at the wrists) · birdWings (layered feathers) · jetWing (carbon wing with four glowing thrusters, holds speed level) · paperCrane (ride a giant origami crane) · leaf (a giant leaf held overhead by its stem, the floatiest of all). Each has its own procedural model, pose, unfold animation, default trail and sounds, and small speed/sink/turn modifiers on top of the feel. Your own: glideKit.models.register(name, builder, mount) + catalog.registerStyle(name, row).
Trails
| Trail | Look |
|---|---|
streaks | thin glowing speed streaks (wingsuit default) |
wingtips | white vapour puffs (hang glider, paraglider default) |
petals | tumbling blossom petals (umbrella default) |
sparkles | glinting sparks (cape default) |
feathers | drifting feathers (bird wings default) |
jet | hot blue exhaust (jet wing default) |
confetti | four-colour confetti (paper crane default) |
leaves | green and autumn leaves (leaf default) |
smoke | thick airshow smoke |
rainbow | glowing ribbons in every colour |
pixel | chunky retro pixel cubes |
none | nothing |
catalog.registerTrail(name, { label, description, particle, color, colors?, rate?, size? }) adds your own (particle is a glideKit.fx kind).
Feels
| Feel | Character |
|---|---|
cruiser | Floaty cruise: 13 m/s trim, 1.4 m/s sink, a long hang time, gentle turns, a soft self-recovering stall, big updraft lift. |
diver | Fast dives (the default): trims 28 m/s, tops out at 85 m/s, 33 to 54 m/s in a 3 s dive, hard carving banks, big FOV kick. |
stunt | Arcade stunts: 420°/s rolls, quick pitch, tight turns, rings and updrafts hit 1.4x to 1.5x harder and boost rings chain. |
beginner | Forgiving: slow 1.2 m/s sink, levels itself, gentle steering, almost never stalls and never drops below 70% of trim speed. |
realistic | Simulation: a 10:1 glide ratio, energy conserved, slow pitch, a real stall you must dive out of. |
Old names still work as hidden aliases: floaty = cruiser, wingsuit = diver, arcade = stunt, sim = realistic.
require("glideKit.catalog").registerFeel(name, t) adds your own (copy a row).
How it flies
A dive turns height into speed: holding forward tips the path down and tucks in (sheds tuck of the drag), so speed builds fast; let go and the extra speed flattens the path into a long floaty level-out that bleeds the speed off slowly; pull back and the speed buys a zoom climb until the wing stalls. glideKit.flight is pure math (Flight.params, step, simulate, fromVelocity, addVelocity), so HUDs, AI and tests can run it without a player.
World pieces
| Component | Looks | Key fields |
|---|---|---|
Updraft | wind, leaves, sparkles, heat | radius, height, strength (m/s up), gust, coastLift (push for players without a glider), base |
Thermal | mist, warm, pollen | wide and gentle: radius 12, height 45, strength 4, base |
BoostRing | golden, magic, scifi, cloud | radius, boost (m/s along +Z), minSpeed, oneWay, cooldown |
GliderDisplay | any glider, any trail | a posed mannequin wearing a glider (with trail and caption), for galleries and shops |
Updrafts and thermals are real engine Wind volumes: gliders read them with Physics.wind, and physics props and cloth rise in them too.
Events
On Glide.on(event, fn) (this peer's gliders) and on the Glider component's events: opened {style, feel, speed}, closed {reason = input|landed|lost|code, speed}, boosted {ring, speed}, updraftEnter / updraftExit {zone, kind}, landed {speed, airTime}, plus stalled / recovered on the api. A listener added during play is dropped when play ends. Glide.readout() gives speed, verticalSpeed, altitude, pitch, bank, stalled, inUpdraft, speedFraction.
Controls
glideKit.glide input map, one glide button: Space / Shift / G · pad A (in the air) or LB · a round touch Glide button. Steering reads the move stick of the player's walking map (@builtin::inputMaps.default), so WASD, the left stick and the touch stick all steer. Space and pad A are still jump on the ground: glide only opens in the air.
Multiplayer
Flight runs only on the peer that owns the body (airMotor); other peers see the body move through its own transform sync and draw the glider from the Sync fields open, style, trailLook, feel, poseYaw, posePitch, poseBank, so a late joiner sees the right glider at once. Updrafts, thermals and rings act per player on each peer.
Inside
Glider, Updraft, Thermal, BoostRing, GliderDisplay components; api, catalog, flight (pure flight math), models, pose, fx, air modules; glide.inputMap; 11 sounds; gallery.scene (every glider, trail, feel and look) and course.scene (a playable tower-to-island flight); tests/glideKit_flight.testSuite (run zero tests run glideKit_flight); two guides in guides/:
- How to add a glider or wingsuit to my game (
glideKit.package/guides/how-to-add-a-glider-or-wingsuit-to-my-game) - Example: build a small gliding level with updrafts and boost rings (
glideKit.package/guides/example-build-a-small-gliding-level-with-updrafts-and-boost-rings)
Scoped to this part · feeds back into the world's score.