twoDKit
Make side-scrolling pixel platformers in the spirit of **Celeste** and **Hollow Knight** in any Zero world. Type a level as rows of characters and get a proper tiled level with the right edge and corner tile in every cell; drop in a player who runs, jumps higher the longer you ho…
twoDKit: 2D pixel-art platformer kit
Make side-scrolling pixel platformers in the spirit of Celeste and Hollow Knight in any Zero world. Type a level as rows of characters and get a proper tiled level with the right edge and corner tile in every cell; drop in a player who runs, jumps higher the longer you hold the button, forgives late ledge jumps and early presses, wall slides, wall jumps and dashes in eight directions, on keyboard, gamepad and phone; watch it all through a pixel-perfect camera that holds still while you jump and eases at ledges, with parallax backgrounds scrolling behind. Every style switches with one field: 14 themes (each a tile set and a four-layer parallax background), 12 characters, 11 movement feels, 3 camera styles, 8 HUD looks, 6 gem looks and 5 checkpoint looks, and one theme sets the tile set and background together. Levels can hold spikes, saw blades, lava, crumbling blocks and fire jets, and hearts, dash crystals and springs, each typed as one character. Landings kick up dust and squash, dashes leave after-images, checkpoints light up with a glow and embers, and the goal plays a slow-motion win with fireworks. It is multiplayer by default: every player sees the same level and every other player running, jumping, wall jumping and dashing with the right animation.
It builds on published kits it installs with it: controlsKit (keyboard, gamepad and touch controls), Trapline (checkpoints, lives, respawn), platformsKit (moving platforms and lifts), and four small packages that came out of this kit and work on their own: pixelSprites (animated sprites), pixelParallax (parallax backgrounds), pixelPaint (paint pixel art in code) and chipSfx (8-bit sound effects).

Install
Search ZeroMind for "twoDKit" or "2D platformer kit", or install it in one step (it brings controlsKit, Trapline, platformsKit, pixelSprites and pixelParallax, and what they use):
tools.use("zeromind", "installAsset", "2cfaadfa-6235-41c4-a20d-d81508632c78") -- from Luau
or zero zeromind installAsset 2cfaadfa-6235-41c4-a20d-d81508632c78 in the engine shell. It lands at /source/twoDKit.package. Installs with several dependencies take a minute (engine issue #21420; a fresh install took 25 to 40 s in testing); while files arrive the editor may say a component "is waiting for content it requires"; that is install order and clears by itself.
Which version did I get?
- The kit:
require("twoDKit.api").VERSIONin a script, or theversion:line of/source/twoDKit.package/package.yaml. This README is for 1.3.0. - Everything the install brought:
zero zeromind installsin the engine shell lists every installed package with the build it holds; each one'spackage.yamlnames its version. - What arrives with 1.3.0 (the same as 1.2.2): Trapline 1.5.4, held to exactly that build because the kit's own files name it, with the kits Trapline is built on (SecondWind 1.4.4, Lifeline 1.0.1, MatchFlow 1.3.1, juiceKit 1.2.8, barsKit 1.4.3); and the four packages that came out of this kit and live in its own world, pixelSprites, pixelParallax, pixelPaint and chipSfx, each at its newest release (1.0.3, 1.0.3, 1.0.1 and 1.0.1 in a fresh install on the day of release).
- Not held to a build: controlsKit and platformsKit arrive at their newest published release (engine issue #19270), so a new install can hold a newer one than this kit was tested with (controlsKit 1.2.3; platformsKit 1.5.5 here and 1.5.7 / 1.5.8 in fresh installs). If something looks off after one of them updates, run
zero tests run twoDKitTests.
Make your first level in five minutes
- Install (about a minute):
zero zeromind installAsset 2cfaadfa-6235-41c4-a20d-d81508632c78in the engine shell. - Three calls (one minute): open
scenes/main.scene/build.luau, replace the whole file with this, and press Play:
With no options you get the built-in starter level (local PP = require("twoDKit.api") function content() PP.level() PP.player() PP.hud() endPP.STARTER): grassland tiles and sky, a knight with thetightfeel, a pixel-perfect camera, the pixel HUD, a checkpoint, spikes, a moving platform, a wall to climb and the goal. Run with A / D, jump with Space (hold it to jump higher), dash with Shift, and press E for the STYLES panel. - Restyle it (one minute):
PP.level({ theme = "candy" }),PP.player({ character = "slime", feel = "bouncy" }),PP.hud({ style = "comic" }). Each is one field; the table under One field switches each style lists every value. - Type your own map (two minutes): pass
text = [[ ... ]]toPP.level, one character per tile, top row first:#ground,=plank,^spikes,Pstart,Ggoal,ogem,Ccheckpoint,Mmoving platform. Levels from text lists all of them, saws, lava and springs included. - Add lives:
PP.player({ lives = 3 })gives three tries, hearts in the HUD and a GAME OVER card. Lives, checkpoints and moving platforms below says how they fit together.
Your first level (works as written in a brand-new world)
Open scenes/main.scene/build.luau and replace the whole file with this, then press Play:
local PP = require("twoDKit.api")
function content()
PP.level({ theme = "grassland", moverLength = 3, moverTravel = 3, text = [[
##############################
#............................#
#....o.......................#
#.......................o....#
#.......................##...#
#...====..........o.....##...#
#.......................##...#
#..P.........C..........##.G.#
##########^^###M.....#########
###############......#########
]] })
PP.player({ character = "fox", feel = "tight", lives = 3 })
PP.hud()
end
With lives = 3 the player has three tries: run out and the HUD shows a GAME OVER card with the run's gems, time and lives lost; TRY AGAIN, or a fresh press of Jump on any device once the card has been up for a beat, starts the run over from the level start with full lives (gems, timer and deaths back to zero). Leave lives out for endless respawns at the last checkpoint.
You get a 30 x 10 grassland level with a parallax sky, a fox you control, a checkpoint flag, a row of spikes, a moving platform over a bottomless drop, a wall to climb with wall jumps, three gems, a goal, and a HUD with a STYLES button that switches theme, tile set, background, character, feel, camera and HUD style live. Change theme = "grassland" to "cave", "castle", "lab", "snow", "desert", "volcano", "jungle", "coast" or "crypt" and the whole level re-skins.
Step by step: from a text map to a finished level
Each step is a complete scene script: paste it over your scene's build.luau (for a new world, scenes/main.scene/build.luau), save, and the editor rebuilds the scene; press Play to try it. Each step adds one thing to the one before.
1. Build a level from the text map
Type the level as rows of characters, top row first, all rows the same width. # is solid ground (the kit picks the right edge and corner tile for every cell and merges the collision so nothing snags on seams), . is empty air, P is where players start, o is a gem and G is the goal.
local PP = require("twoDKit.api")
function content()
PP.level({ theme = "grassland", text = [[
################################
#..............................#
#..............................#
#..............................#
#..............................#
#..............................#
#..............................#
#..P.......o..........o......G.#
################################
################################
]] })
PP.player({ character = "fox" })
PP.hud()
end
The fox runs from P to G picking up two gems; the HUD counts gems, time and lives (hearts for the lives left) and shows the level-clear card at the goal. The full legend is under Levels from text below.
2. One-way ledges and moving platforms
= is a one-way ledge: jump up through it from below and stand on it; hold Down and press Jump to drop through. M is a moving platform that travels sideways (V travels up and down), drawn with the tile set's planks; it carries whoever stands on it, and a jump off it keeps its speed. Here it ferries you over a pit; the three mover numbers set its width, how far it travels and how fast.
local PP = require("twoDKit.api")
function content()
PP.level({ theme = "grassland", moverLength = 3, moverTravel = 6, moverSpeed = 2, text = [[
################################
#..............................#
#..............................#
#..............o...............#
#.............====.............#
#..............................#
#.....====.............o.......#
#..P...................##...G..#
##########M.........############
##########..........############
]] })
PP.player({ character = "fox" })
PP.hud()
end
For a platform you place by hand instead of in the text (any size, any path), use platformsKit and add twoDKit.PixelSkin so it is drawn in the level's style: see Bring other kits' parts into the pixel style in the how-to guide.
3. Checkpoints, lives and game over
C is a checkpoint (touch it and you come back there after a hit), ^ are spikes. lives = 3 gives each player three lives: losing the last one shows the GAME OVER card, and TRY AGAIN (or a fresh press of Jump) starts the run over from the start with full lives. Leave lives out for endless respawns at the last checkpoint. Falling off the bottom of the level costs a life too.
local PP = require("twoDKit.api")
function content()
PP.level({ theme = "grassland", moverLength = 3, moverTravel = 6, moverSpeed = 2, text = [[
################################
#..............................#
#..............................#
#..............o...............#
#.............====.............#
#..............................#
#.....====.............o.......#
#..P....C.............C#.^^^.G.#
##########M.........############
##########..........############
]] })
PP.player({ character = "fox", lives = 3 })
PP.hud()
end
4. Swap styles with one setting each
The same level in another style: theme switches the tile set and the background together, and every other part takes one setting. Any of these can also change while the game runs, for this player or for everyone (see One field switches each style).
local PP = require("twoDKit.api")
function content()
PP.level({
theme = "volcano", -- tiles and background together
gemLook = "coin", -- crystal, coin, star, cherry, orb, battery
checkpointStyle = "campfire", -- flag, lantern, campfire, banner, beacon
moverLength = 3, moverTravel = 6, moverSpeed = 2,
text = [[
################################
#..............................#
#..............................#
#..............o...............#
#.............====.............#
#..............................#
#.....====.............o.......#
#..P....C.............C#.^^^.G.#
##########M.........############
##########..........############
]],
})
PP.player({ character = "pirate", feel = "classic", camera = "smooth", lives = 3 })
PP.hud({ style = "neon" })
end
While playing, the STYLES button (or E / the gamepad's X) cycles every style live, and from code PP.setTheme("crypt"), PP.setCharacter("ninja"), PP.setFeel("moon") and PP.setCamera("rooms") do the same.
Controls
| Keyboard | Gamepad | Touch | |
|---|---|---|---|
| Run | A / D or arrows | left stick or d-pad | d-pad on the left |
| Jump (hold for higher) | Space or K | A | Jump button (or swipe up) |
| Dash (8 directions: hold a direction) | Shift or J | RB or Y | Dash button |
| Drop through a one-way platform | hold Down (S) + Jump, or Crouch (C) + Jump | down + A | down on the d-pad + Jump |
| Open the style gallery | E or L (Interact), or the STYLES button | X | Interact button |
Controls come from controlsKit's platformer scheme, so rebinding, button prompts and touch layouts work the controlsKit way (require("controlsKit.controls")).
Levels from text
Level2D.text (or PP.level({ text = ... })) is the level, top row first. One character is one tile (one world unit, 16 art pixels). The entity's position is the grid's bottom-left corner.
| Char | Becomes |
|---|---|
# | Solid ground. Autotiled: every cell picks the right edge, corner or inner-corner tile from its eight neighbours (47-tile blob). |
= | One-way platform: jump up through it, stand on it, drop down through it. |
^ | Spikes, pointing away from the solid next to them. Touching them costs a life (Trapline). |
W | Saw blade: a spinning two-tile buzzsaw. Touching it costs a life. |
L | Lava: an animated pool that bubbles and throws embers. Falling in costs a life. |
X | Crumbling block: solid ground that cracks and shakes when stood on, falls away after half a second and comes back three seconds later. |
F | Fire jet: a steel nozzle that fires up to three tiles away from what it is mounted on, every three seconds, after a sputtering warning. The flame costs a life. |
H | Heart: gives back one Trapline life (once per run, per player); grey while lives are full or off. |
D | Dash crystal: refills a spent dash in the air, then grows back after a second. |
T | Spring: bounces you about six tiles up and gives the dash back. |
C | Checkpoint (a Trapline checkpoint, drawn as a pixel flag that raises when you reach it; checkpointStyle picks lantern, campfire, totem banner or sci-fi beacon instead). |
P | Player start. |
M / V | Moving platform side to side / up and down (platformsKit pingpong), drawn as the tile set's planks. You ride it. |
o | Gem to collect (per player, counted in the HUD; gemLook picks crystal, coin, star, cherry, orb or battery). |
G | Goal: shows the level-clear card with gems, time and lives lost. |
* | A decoration on this floor tile (others are scattered by seed). |
B | Back wall: a darker fill behind the level, no collision. |
. or space | Empty. |
Outside the grid counts as solid, so the border reads as one mass. Collision is built from merged rectangles (no seams to catch on). A Trapline kill zone sits killDepth tiles below the bottom row, so a fall costs a life and you come back at your last checkpoint. Level.parse, Level.tiles, Level.rects and Level.mask in twoDKit.level are there for your own tools.
Lives, checkpoints and moving platforms
They come from three kits, and the kit wires them together for you:
- Checkpoints (
Cin the map) are Trapline checkpoints drawn in the kit's pixel art (checkpointStyle: flag, lantern, campfire, banner or beacon). Touching one makes it your respawn point: it lights up with a glow, embers and a chime, the HUD shows a CHECKPOINT toast, and it stays lit for you (each player has their own). - Dying happens on spikes, saws, lava and fire jets, or by falling
killDepthtiles below the bottom row. You come back at your last checkpoint, or atPif you have none. - Lives are off unless you ask:
PP.player({ lives = 3 }). Without lives every death just respawns you. With lives, the HUD shows hearts for the lives left, a heart pickup (H) gives one back, and losing the last one shows the GAME OVER card; TRY AGAIN (or Jump) restarts the run fromPwith full lives and the checkpoints cleared. - Moving platforms (
Mside to side,Vup and down;moverLength,moverTravelandmoverSpeedset their size, distance and speed) are platformsKit platforms. They carry you while you stand on them, keep their speed when you jump off, and run on a shared clock so every player sees them in the same place. A checkpoint is a point in the level, never on a platform: if you die after riding one, you come back at the checkpoint, not on the platform. - Crumbling blocks (
X) break and come back for everyone; gems, hearts and dash crystals are per player.
Ability gates and joined rooms (metroidvania)
Two moves are off by default so a game can hand them out as upgrades, and rooms can be joined into one map:
- Double jump:
Player2D.airJumps(orPP.player({ airJumps = 1 })) is how many jumps you get in mid-air; they refill on landing and on a wall, like the dash. Each is the feel'sairJumpHeight(85% ofjumpHeightby default) and plays a wing-beat puff with a higher jump sound. - Down-slam:
Player2D.canSlam(orPP.player({ canSlam = true })). Press down in the air and you drive straight down at the feel'sslamSpeed(30 tiles/s) until you hit the ground: a dust ring, a heavy shake and a hard-landing thud. Down + jump on a one-way platform still drops through. - Joined rooms:
Level2D.edgeWalls = false(orPP.level({ edgeWalls = false })) leaves out the invisible walls past a level's left and right edges. Put the next level at this one's x + width with a gap in the touching edge columns and you walk across; stack one under another with a gap in the floor and ceiling rows to fall and jump between them (killDepth = 0on the upper room). The camera clamps to whichever room you are in and only that room draws its background. - React to them:
twoDKit.eventsfiresairJump,slamandslamLandon every peer (payloadplayer,x,y,isLocal, andgroundonslamLand: the entity the slam hit), so a breakable floor or a boss can listen:require("twoDKit.events").on("slamLand", function(e) ... end).Player2D:state()also givesairJumpsLeft,slamming,slamGroundandslamAt.
So a level with a moving platform over a pit, a checkpoint after it and lives = 3 plays like this: fall off the platform and you lose a heart and start again before the pit; cross it, touch the checkpoint, and a later fall brings you back after the pit instead.
When the editor and play look different
| What you see in the editor | Why, and what to do |
|---|---|
| The level looks soft or the background sits at a different depth. | The editor's fly camera is a perspective camera; in play the kit's pixel-perfect camera takes over, and that is the picture players get. Judge pixel crispness in play. |
| There is no player, camera or HUD. | They are made from the player template when play starts (every person who joins gets their own). Press Play. |
| Moving platforms stand still, checkpoints are unlit, saws and fire jets are idle. | They run in play only. Their start positions in the editor are where they begin. |
| A style chosen in the STYLES panel is gone after play. | The panel changes your own view for this play session. To keep a style, set its field in build.luau (PP.level({ theme = ... }) and so on). |
After an edit to build.luau the level did not change. | Save the file: the scene rebuilds on save. If you are in play, stop and press Play again. |
| The editor says a component "is waiting for content it requires". | Seen right after installing, while files arrive. It clears by itself. |
| A theme you just added is missing from the Style Hall. | The hall builds its rooms when the scene loads. Reload the scene, or press Play again. |
One field switches each style
| What | Field | Values |
|---|---|---|
| Theme (tile set + background) | Level2D.theme | grassland, cave, castle, lab, snow, desert, volcano, jungle, coast, crypt, sky, factory, candy, autumn |
| Tile set | Level2D.tileset | the fourteen above, or auto (follow the theme) |
| Background | Level2D.background | the fourteen above, auto, or none |
| Character | Player2D.character | knight, robot, fox, mage, ninja, astronaut, frog, pirate, skeleton, viking, slime, bird |
| Movement feel | Player2D.feel | tight, floaty, heavy, slippery, classic, nimble, moon, retro, snappy, bouncy, glide |
| Camera | Camera2D.style (or Level2D.camera for one level) | pixelPerfect, smooth, rooms |
| HUD style | Hud2D.style (or PP.hud({ style = ... })) | pixel (default), gameboy, parchment, neon, minimal, arcade, wood, comic |
| Gem look | Level2D.gemLook | crystal (default), coin, star, cherry, orb, battery |
| Checkpoint look | Level2D.checkpointStyle | flag (default), lantern, campfire, banner, beacon |
Each tile set has ground, edges, outer and inner corners, a back wall, one-way platform ends, spikes in four directions and eight decorations. Each background has four parallax bands (sky, far, mid, near). Each character sheet has idle, run, jump, fall, wall slide, dash, land and hurt. In play, PP.setTheme(id), PP.setCharacter(id), PP.setFeel(id) and PP.setCamera(style) switch them from code.
Every style, pictured
All pictures are taken in play through the kit's own camera, on the showcase's first level with only the one field changed.
Themes (theme): each one is its own tile set, spikes, planks, decorations and four-layer background.
grassland | cave |
castle | lab |
snow | desert |
volcano | jungle |
coast | crypt |
sky | factory |
candy | autumn |
Characters (character), idle and running, from the top left: knight, robot, fox, mage, ninja, astronaut, frog, pirate, skeleton, viking, slime, bird.

HUD looks (style):
pixel | gameboy |
parchment | neon |
minimal | arcade |
wood | comic |
Hazards and pickups in the castle theme: a crumbling block, a spring, a heart, spikes, a dash crystal, lava and a fire-jet nozzle.

The movement feels
Each feel is built around one idea, and the numbers below are measured from the motor (the test suite holds them to it):
| Feel | Plays like | Full jump / time in the air | Reaches top speed | Stops within | Running jump | Falls 8 tiles |
|---|---|---|---|---|---|---|
tight | Celeste-like: instant, precise, short hop on a tap, fast 3.5-tile dash. | 3.6 tiles / 0.72 s | 0.08 s | 0.17 tiles | 5.0 tiles | 0.60 s |
floaty | Low gravity: twice the hang time, a slow fall you can steer, a long slow dash. | 4.5 tiles / 1.58 s | 0.12 s | 0.24 tiles | 7.9 tiles | 1.15 s |
heavy | Weighty: winds up slowly, carries momentum, short committed jumps that slam down, little air control. | 3.1 tiles / 0.60 s | 0.45 s | 0.70 tiles | 3.9 tiles | 0.45 s |
slippery | On ice: slow to get going, slides about 3.5 tiles to stop, slow to turn, momentum carries. | 3.4 tiles / 0.73 s | 0.48 s | 3.5 tiles | 5.9 tiles | 0.65 s |
classic | Momentum platforming: builds up to a high top speed, slides a tile when you let go, big jumps you can steer. | 4.4 tiles / 0.87 s | 0.33 s | 1.1 tiles | 7.4 tiles | 0.63 s |
nimble | An acrobat: two dashes per jump, high wall jumps off slow wall slides, instant and light. | 3.2 tiles / 0.70 s | 0.07 s | 0.17 tiles | 5.3 tiles | 0.65 s |
moon | Barely any gravity: six-tile jumps that last almost three seconds, a slow drift down, gentle steering. | 6.2 tiles / 2.65 s | 0.15 s | 0.3 tiles | 11.9 tiles | 1.80 s |
retro | 8-bit committed jumps: the same arc however long you hold, almost no steering in the air, instant on the ground. | 3.5 tiles / 0.72 s | 0.03 s | 0.04 tiles | 3.9 tiles | 0.68 s |
snappy | Arcade-sharp: full speed on the first frame, dead stops, a short sharp hop that drops fast. | 3.0 tiles / 0.47 s | 0.02 s | 0 tiles | 4.2 tiles | 0.42 s |
bouncy | Springy: a real fall bounces you back up, and a jump pressed as you land springs about a third higher. | 3.5 tiles / 0.75 s | 0.13 s | 0.35 tiles | 5.3 tiles | 0.63 s |
glide | A glider: hold jump while falling to drift down slowly and steer across long gaps; let go to drop. | 3.4 tiles / 2.28 s | 0.10 s | 0.25 tiles | 14.8 tiles | 0.63 s (4.5 s holding jump) |
Every number is data in twoDKit.feels (run speed, accelerations, jump height, rise / fall / cut gravity, apex hang, coyote time, jump buffer, wall slide speed, wall jump launch and lock, dash speed, time, count and cooldown, and how fast speed above the top speed bleeds off after a dash). Make your own: PP.registerFeel("moon", { jumpHeight = 6, fallGravity = 15 }).
Pixel-perfect camera
Camera2D is the player's camera behaviour. The view height is always the window height divided by a whole number of screen pixels per art pixel (chosen so about targetHeight = 216 art pixels show, and at least about minWidth = 240 wide, so a phone held upright still sees the level), and the view is snapped to the pixel grid, so every art pixel is the same whole number of screen pixels at any window size, odd sizes included: no shimmer, no uneven pixels. The parallax backgrounds scroll in whole screen pixels on the same grid, so their pixels are as crisp as the tiles'. The test suite checks this at fourteen window sizes from a phone to 4K. While crisp is on it also turns off temporal and edge antialiasing and holds render scale at 1 on that peer. It never shows anything outside the level the player is in: when a level is smaller than the view would be (the 10-row first example on a 1080p window, say), the zoom goes up by whole steps until the whole view fits inside it, and the final pixel snap is kept inside the level's edges too. Styles: pixelPerfect (dead zone, snapped to the art grid), smooth (eased with look-ahead), rooms (holds a roomWidth x roomHeight room and slides to the next).
Bring your own art
- A character sheet: any material on the
pixelSprites.spriteshader (nearest-filtered texture). Register it and name it inPlayer2D.character:
Frames are read left to right from the top-left; the character faces right, feet on the frame's bottom row, centred. Missing animations fall back (wall slide to fall, fall to jump, jump to idle, dash to run), so idle + run is enough to start.local PP = require("twoDKit.api") PP.registerCharacter("hero", { material = asset.resolve("myArt.hero", "material"), frameWidth = 32, frameHeight = 32, columns = 8, rows = 8, anims = { idle = { row = 0, frames = 4, fps = 6, loop = true }, run = { row = 1, frames = 6, fps = 12, loop = true } }, }) - A tile set: a 128 x 128 atlas of 16 px tiles in the layout
twoDKit.autotiledocuments (cells 0-46 blob ground, 47 back wall, 48-51 one-way, 52-55 spikes, 56-63 decorations), thenPP.registerTileset(id, { material = ... }). - A background: four 320 x 180 images that repeat horizontally, each on a material using the
pixelParallax.parallaxshader, thenPP.registerBackground(id, { layers = { { material = sky, factor = 0.04 }, ... } }). - Generate art in code: the pixelPaint package (
twoDKit.paintis the kit's name for it) is the raster painter all the kit's art was made with (rects, lines, ellipses, polygons, ordered dither, gradients, outlines, ASCII sprites, seeded noise,Paint.saveto a nearest-filtered texture,Paint.material). The kit's own generators are inartgen/(tilesets,characters,backgrounds,fx,pickups,hazards,juicefx): runrequire("twoDKit.artgen.tilesets").generate("cave")to repaint one. They stay in the kit because they paint the kit's own catalogue.
Game feel and sound
Every moment has a pixel effect and an 8-bit sound out of the box, on every peer, for every player it sees (others' sounds quieter, fading with distance), driven by synced animation changes and Trapline's events, so it adds no network traffic. Jumps stretch, landings squash (a fall of 5 tiles or more lands hard: a wide dust cloud and a small shake), wall jumps kick dust, dashes leave speed lines and distinct after-images, starting to run or turning kicks up dust and wall slides scrape specks off the wall. A death flashes the body white, bursts it into pixels, shakes the camera and holds a 75 ms hit stop for that player; gems pop. A checkpoint lights up with a warm glow that blooms and then pulses, two waves of embers and a chime. Reaching the goal is a win: time slows to 0.3 for a moment and eases back, fireworks and confetti burst over the goal, the character hops twice, and only then does the level-clear card come up. A glide leaves sparkles, and hearts, dash crystals and springs each have their own burst and sound. Squash and stretch is drawn by the sprite shader at art-pixel resolution, so it never blurs. The pixelPerfect and smooth cameras rest at the height of the ground you last stood on, so jumping does not bob the view; they follow you down when you fall past the dead zone and ease between heights at ledges.
- Sounds: jump, land, hard landing, dash, wall jump, gem, checkpoint, death, game over, level clear and a UI click, synthesised from square, triangle and noise voices by the chipSfx package (
twoDKit.sfxis the kit's name for it) and shipped as clips.Player2D.sfxVolume(0.55) andPlayer2D.soundset the volume and mute;require("twoDKit.sfx").play("click")plays one from your own UI. - Tuning:
require("twoDKit.juice")holdsenabled,shake,hitstopandHARD_LAND_DROP;Sprite2D.effectsandSprite2D.squashswitch them per sprite. - Hooks:
require("twoDKit.events").on("gem", fn)hears jump, land, dash, wallJump, gem, checkpoint, death, gameOver, restart and goal (or"*"), each with the player, where it happened and whether it is your own.
Multiplayer
Every peer builds the same level from the same text on its own temporary entities, so nothing about the level crosses the network. Each player's body is moved only by its owner; the engine replicates its pose to everyone, and the Sprite2D's character, anim, facing and blink are synced fields, so every peer draws every player with the right animation. Dash flash and after-images, the hurt fade, jump, wall-kick and landing dust are derived from those fields on each peer, and on someone else's player each animation change waits the engine's pose smoothing delay so it lines up with the smoothed body. Lives and checkpoints are per player through Trapline; after a respawn the character is back upright, facing the camera and looking exactly as before, for every player watching; moving platforms run on platformsKit's shared clock. Style choices in the gallery: character and feel are per player and seen by everyone; tile set, background, theme and camera are each peer's own view.
What is inside
| Asset | What it does |
|---|---|
api | The front door: PP.level, PP.player, PP.hud, PP.startOf, the register* functions and the in-play switches. |
Level2D (component) | A level from text: tiles, collision, markers, parallax. |
Player2D (component) | The platformer motor (box sweeps with the engine's Physics.boxCast, one-way colliders, riding moving platforms), animation choice, spikes, gems, goal, run timer. |
Sprite2D (component) | An animated sprite from a sheet, facing left or right, pixel-snapped; motion effects. |
Camera2D (component) | The pixel-perfect camera behaviour (tagged cameraBehavior). |
Hud2D (component) | Gems / time / lives (hearts for the lives left when Trapline lives are on, else lives lost; the gem counter bumps on each gem, a CHECKPOINT toast on each new checkpoint), animated level-clear and GAME OVER cards with TRY AGAIN (or Jump, after a short beat) when Trapline lives run out, STYLES gallery and level travel. One style setting picks its look: pixel, gameboy, parchment, neon or minimal (Catalog.hudStyleList). |
PixelSkin (component) | Draws a Trapline saw or a platformsKit platform you place yourself as pixel art that matches the level (a pixel buzzsaw on a track; the tile set's planks). |
catalog, feels | Every style as labelled data, and the registries for your own. |
traps | Saw blades, lava, crumbling blocks, fire jets, hearts, dash crystals and springs from the level text (W L X F H D T). |
level, autotile | Text parsing, blob autotiling, merged collision rectangles, spike boxes. |
sprites, parallax | The kit's names for the pixelSprites and pixelParallax packages (installed with it, and installable on their own): sprite quads with flash, fade, tint and squash, and pixel-crisp parallax bands, plus SpriteSheet and ParallaxBackground components for games that don't use the rest of the kit. |
fx, view, levels | pixel effects, the shared camera view, the live registry of levels and players. |
juice, sfx, events | Game feel (each moment's effect, sound, shake, hit stop and squash curve), the kit's name for the chipSfx 8-bit sounds, and the moments event bus. |
paint, artgen/* | The kit's name for the pixelPaint painter, and the generators for every texture in art/. |
pixelSprites.sprite, pixelParallax.parallax (shaders, in those packages) | Unlit alpha-cut pixel shaders; the frame of a sheet is picked per entity, so one material draws every sprite on a sheet. |
| guides | how-to-make-a-2d-platformer-tilemap-from-text-wall-jump-dash-pixel-perfect-camera and example-2d-platformer-level-from-an-empty-world. |
twoDKitTests (test suite) | Parsing, autotiling, collision merging, feels, catalog, motor and level build checks. |
Guides
guides { path: "twoDKit.package/how-to-make-a-2d-platformer-tilemap-from-text-wall-jump-dash-pixel-perfect-camera" }: how to use every part.guides { path: "twoDKit.package/example-2d-platformer-level-from-an-empty-world" }: from an empty world to a small playable level with checkpoints, a hazard and a moving platform.
Notes and limits
-
The body has no rigid body: the motor writes its position, so it is not affected by #11892 (setting velocity on a player's own body can do nothing) and does not use the built-in CharacterController (whose capsule rounds off ledges and has no acceleration curves, wall slide or jump cut).
-
Players pass through each other (as in Celeste); Trapline hazards and kill zones you place yourself work with the kit's player as with any player.
-
Two engines signed in to one account count as one player (#14448): test multiplayer with two accounts.
-
Dependency versions. An install of 1.2.2 brings Trapline 1.5.4 at exactly that build, because the kit's own files name it; Trapline 1.5.4 is a released Trapline (the
nonecheckpoint look the kit's pixel checkpoints use, merged on Trapline's world from pull request #3), and Trapline's own 70 tests pass on it. pixelSprites, pixelParallax, pixelPaint and chipSfx live in this kit's own world and arrive at their newest release (a fresh install on the day of release brought 1.0.3, 1.0.3, 1.0.1 and 1.0.1). controlsKit and platformsKit are named only inpackage.yaml, and an install brings each one's newest published release rather than the version this kit's world held (engine issue #19270). This release was tested with controlsKit 1.2.3 and platformsKit 1.5.5 here, and platformsKit 1.5.8 in a fresh install. Trapline and platformsKit bring the kits they are built on: SecondWind 1.4.4, Lifeline 1.0.1, barsKit 1.4.3, juiceKit 1.2.8 and MatchFlow 1.3.1.zeromind.updatekeeps a dependency at its version when the new one would leave a file of this kit not loading or holding a new error; it does not play the kit, so after updating any of them,zero tests run twoDKitTestsconfirms that movement, levels and styles still behave the same. -
A world that already held Trapline 1.4 kept the SecondWind 1.2.0, barsKit 1.2.0 and juiceKit 1.2.1 copies that install placed through later Trapline updates (engine issue #23583). Updating Trapline to the 1.5.4 build removed them in this kit's own world, and Trapline 1.5.4's dependency check reads the copies Trapline runs rather than whatever a name finds, so its tests pass either way. A world without an earlier Trapline gets only the versions above.
Changelog
- 1.3.4: the player and the HUD read controlsKit 1.2.8, the release every package that ships with sideScrollerKit (menusKit, saveKit, abilitiesKit, interactKit, navUiKit, slash2D) moves to together, so a world installing them holds one controlsKit. No gameplay change.
- 1.3.3: the controls test passes wherever twoDKit is installed. In a world holding several controlsKit builds a registered scheme can land in another build than the player reads; the test now checks what matters there, that the player ends up on a scheme with move and jump. No gameplay change.
- 1.3.2: a player can always run and jump. When
Player2D.schemenames a scheme the controlsKit build twoDKit reads does not hold (not registered yet, or registered in another build of controlsKit the world also holds), the player runs on the stockplatformerscheme and tries the named scheme again every half second; 1.3.1 stayed on controlsKit's default twin-stick scheme, where move works and jump does not. NewPP.registerScheme(name, scheme)registers a kit's own scheme in the build twoDKit reads. Two tests cover both. - 1.3.1: the player and the HUD read controlsKit 1.2.4, the same build sideScrollerKit, slash2D, abilitiesKit and interactKit read. 1.3.0 read 1.2.3, so a world holding both builds ran two input loops that kept resetting each other, and a player made with another kit's control scheme never moved. The dependency now states controlsKit 1.2.4.
- 1.3.0 (published from pull requests #4 and #5, used by metroidvaniaKit): three opt-in features a metroidvania needs, all off by default so existing levels and players play exactly as before.
- Double jump:
Player2D.airJumps(motoropts.airJumps,PP.player({ airJumps = n })): mid-air jumps of the feel'sairJumpHeight(default 85% ofjumpHeight), refilled on landing and on a wall like the dash. MomentairJump: a wing-beat puff and the jump sound pitched up. - Down-slam:
Player2D.canSlam(motoropts.canSlam,PP.player({ canSlam = true })): a fresh press of down in the air drives straight down at the feel'sslamSpeed(default 30) until the ground. MomentsslamandslamLand(ground= what it landed on): a dust ring, a heavy shake and the hard-landing sound. Drop-through on one-way platforms is unchanged. - The new moments reach every peer through Player2D's synced
movefield and fire ontwoDKit.events(airJump,slam,slamLand);Player2D:state()addsairJumpsLeft,slamming,slamGround,slamAt,clock. Sprite2D no longer plays the ground jump's dust for an air jump. - Joined rooms:
Level2D.edgeWalls(default true;PP.level({ edgeWalls = false })) leaves out the invisible edge walls so rooms placed side by side or stacked are walked, fallen and jumped between; with it off the kill zone spans only the level's width, so it never sits under a neighbour. - Tests for air jumps, the slam (and drop-through with it on) and joined rooms.
- Double jump:
- 1.2.2: "Which version did I get?" and the notes say what a fresh install really brings: Trapline held to 1.5.4, and pixelSprites, pixelParallax, pixelPaint and chipSfx at their newest release (found by installing 1.2.1 in a new world).
- 1.2.1: preview pictures for the new backgrounds (no change to the kit's code or art).
- 1.2.0: more life, better defaults, more to choose from.
- Look and feel: landings kick dust to both sides and squash a little longer; checkpoints light up with a blooming, pulsing glow, embers and a chime; the goal plays a slow-motion win with fireworks, confetti and a victory hop before the level-clear card; gliding leaves sparkles; the
pixelPerfectandsmoothcameras rest at the ground you last stood on, so jumps no longer bob the view, and ease at ledges. - Defaults:
PP.level()with no options builds a starter level, soPP.level() PP.player() PP.hud()is a whole game.PP.VERSIONnames the kit's version. - Variety: themes
sky,factory,candy,autumn(14); charactersskeleton,viking,slime,bird(12); feelssnappy,bouncy,glide(11); HUD looksarcade,wood,comic(8); hazardsWsaw,Llava,Xcrumbling block,Ffire jet; pickupsHheart,Ddash crystal,Tspring. - Parts: the painter is the pixelPaint package and the 8-bit sounds are the chipSfx package, each installable on its own (
twoDKit.paint,twoDKit.sfxandtwoDKit.artgen.sfxstill work). Trapline 1.5.4 is now a released Trapline. - Docs: a five-minute walkthrough, "Which version did I get?", how lives, checkpoints and moving platforms fit together, what differs between the editor and play, and a picture of every theme, character, HUD look and the hazards.
- Look and feel: landings kick dust to both sides and squash a little longer; checkpoints light up with a blooming, pulsing glow, embers and a chime; the goal plays a slow-motion win with fireworks, confetti and a victory hop before the level-clear card; gliding leaves sparkles; the
- 1.1.11: built on Trapline 1.5.4 (Trapline's pull request #3, which supersedes #2): the same
nonecheckpoint look, now with one version everywhere and a dependency check that reads the copies Trapline runs, so all 70 of Trapline's own tests pass where 1.1.10's Trapline build failed 2. Checkpoint lanterns and flags still light, and an install still loads Trapline's api at one release. No change to the kit's own code. - 1.1.10: a rider keeps its footing on a lift on every frame, also when the lift's collider catches up into the feet or, after a frame hitch, drops away from feet carried onto where it was (on moving ground the ground probe looks again from above, and a small outside move that leaves the feet inside the lift settles onto it instead of starting the body again from rest), with a regression test; a 30 s ride up and down the showcase lift shows 0 airborne frames (1.1.9: about 1 in 200). A fresh install lands Trapline.api at one release: this kit's world holds Trapline exactly as the build of pull request #2, so the kit and Trapline share one api and its checkpoint list (the 1.1.9 flag fallback stays for worlds that hold another Trapline copy). The package description names the right version.
- 1.1.9 (pull request #3, released as part of 1.1.10): riding a moving platform no longer loses footing or falls through it when it stops (a platform's collider can trail its entity by a frame; the new
Motor.settleputs the feet back on its real top after a carry, and the ground probe reaches further on moving ground), with a regression test. Hud2D shows the lives left as hearts when Trapline lives are on (lives lost otherwise). Checkpoint flags light up again when an install lands Trapline.api at two releases (Level2D also reads the player's synced Trapline.Runner, not onlyTL.hasReached, whose list is private to each copy of the api). In edit mode the parallax background fills a perspective editor camera's view instead of showing as a box behind the level (View.current()sizes a perspective camera's view from its fov, and Level2D scales the bands for their depth). - 1.1.7: this changelog; pixelSprites and pixelParallax 1.0.3 (their changelogs). No change to the kit's code.
- 1.1.6: Notes and limits say which dependencies an install holds to a build (pixelSprites, pixelParallax, Trapline) and which arrive at their newest release (controlsKit, platformsKit), and the versions this release was tested with.
- 1.1.5: the old-Trapline-copies limit cites engine issue #23583; the closed #22971 is no longer listed as a limit.
- 1.1.4: dependency versions corrected (platformsKit 1.5.5, not 1.5.1) and the kits Trapline and platformsKit bring are named; the install note cites #21420.
- 1.1.3: the first example says the STYLES panel also switches HUD style (found by following it word for word in a new world).
- 1.1.2: README and guides cover all 8 characters and 8 feels, the HUD styles and the gem and checkpoint looks; built on the engine's library d4061d2 and Trapline 1.5.3.
- 1.1.1: installs again in a new world (1.1.0 had an optional juiceKit require that the install check refused); hit stop uses the engine's time scale.
- 1.1.0: game feel and 8-bit sound; 10 themes, 8 characters, 8 feels, 5 HUD styles, 6 gem and 5 checkpoint looks; finished level-clear and game over cards; sprites and backgrounds released on their own as pixelSprites and pixelParallax.
Scoped to this part · feeds back into the world's score.