◐
material · drop-in viewer
What it does
No description provided yet.
Interface
What this asset declares: the schema it conforms to, what it exposes, and the rendered structured payload.
This asset doesn't declare a schema or structured payload.
Sub-parts
Everything contained inside this part. Assets are composite children (clickable cards). Files are leaf payloads. Expand any row to view its source.
Showing up to 3 levels deep. Open a part to see what it holds further down.
14+items
# pixelSprites.sprite
Unlit, alpha-cut surface for pixel art: shows one cell of a sprite sheet, chosen per entity, so one material draws every sprite that shares a sheet. Level tilemaps use it too (with their atlas UVs baked into the mesh); parallax backgrounds use `twoDKit.parallax` instead.
Per-entity ShaderData lanes:
| Lane | x | y | z | w |
|---|---|---|---|---|
| `lane0` | column | row (from the top) | columns in the sheet | rows in the sheet |
| `lane1` | flipX (> 0.5 mirrors) | flash toward white 0..1 | dithered fade 0..1 | unused |
| `lane2` | tint r | tint g | tint b | tint amount 0..1 |
| `lane3` | drawn width (art px) | drawn height (art px) | quad width (art px) | quad height (art px) |
`lane3` is the pixel-crisp squash and stretch: on a padded quad pivoted at its bottom-centre, the frame is drawn `x` by `y` art pixels (each art pixel shows one texel, rows and columns repeat or drop, nothing blurs). Zero leaves the quad drawing the frame 1:1. `twoDKit.sprites` sets it with `Sprites.setSquash`.
Lanes left at zero draw the whole texture untinted, which is what a tilemap mesh with baked atlas UVs wants. Pair it with a texture whose `filter` is `nearest` for crisp pixels; `twoDKit.paint`'s `Paint.material(folder, name, textureIdentity)` writes such a material for any sheet, and `twoDKit.sprites` drives the lanes.
Properties: `base_color` (multiplier), `alpha_cutoff` (default 0.5), `base_color_texture` (the sheet).
▲ 0↑ born
▲ 0↑ born
# pixelSprites: animated pixel-art sprites from any sprite sheet
Draw a character or object as a flat pixel-art picture that plays named animations from a sprite sheet, in any Zero world, with no other kit. It is the sprite layer of [twoDKit](https://origozero.ai) and works on its own.
- **`SpriteSheet` component**: name your animations once as rows of the sheet (`"idle=0:6:8, run=1:8:14, jump=2:3:12:once"`), then switch with one field (`anim`). It faces left or right (`facing`), stays snapped to the art's pixel grid so it never shimmers, and `anim` and `facing` sync, so every player sees every other player's animation.
- **`sprites` module**: attach a picture showing one cell of a sheet to any entity and drive it yourself: `setCell`, `setFlash` (hit flash), `setFade` (dithered fade), `setTint`, `setSquash` (squash and stretch that stays pixel-crisp), `snapTo`.
- **`sprite` shader**: unlit, alpha-cut, nearest-filtered; one material draws every sprite that uses the sheet.
## Install
```lua
tools.use("zeromind", "installAsset", "af866662-98d1-4500-bd67-49508538bb47") -- or `zero zeromind installAsset af866662-98d1-4500-bd67-49508538bb47` in the shell
```
or search ZeroMind for "pixelSprites" / "animated sprite sheet". It lands at `/source/pixelSprites.package`.
## Your first animated sprite
A sheet is a texture with the frames in a grid, top row first, and a material on the `pixelSprites.sprite` shader. Make the material by importing your sheet as a texture (nearest filter) and creating a material whose shader is `pixelSprites.sprite` with that texture as its base colour, or paint one in code with twoDKit's `twoDKit.paint` (`Paint.save` then `Paint.material`). With one in hand:
```lua
function content()
local hero = entity.spawn("Hero", { position = { 0, 1, 0 } }) -- the position is the feet
hero.component.add("pixelSprites.SpriteSheet", {
sheet = asset.resolve("my.art.hero", "material"),
frameWidth = 32, frameHeight = 32, columns = 8, rows = 8,
animations = "idle=0:6:8, run=1:8:14, jump=2:3:12:once, fall=3:3:10",
})
end
```
Then, from your own code: `hero.component.get("pixelSprites.SpriteSheet").anim = "run"` and `.facing = -1` to face left. `:play("jump", true)` restarts an animation, `:isFinished()` says whether a `:once` animation reached its last frame.
## SpriteSheet fields
| Field | Default | What |
|---|---|---|
| `sheet` | none | The material (on the `pixelSprites.sprite` shader). |
| `frameWidth`, `frameHeight` | `32` | One frame in pixels. |
| `columns`, `rows` | `8` | The sheet's grid. |
| `animations` | `idle=0:1:1` | `name=row:frames:fps`, add `:once` to hold the last frame; rows count from the top, starting at 0. |
| `anim` | `idle` | The animation playing (synced). |
| `facing` | `1` | `1` as drawn, `-1` mirrored (synced). |
| `speed` | `1` | Animation speed multiplier. |
| `pixelsPerUnit` | `16` | Art pixels per world unit. |
| `pixelSnap` | `true` | Keep the picture on the art's pixel grid. |
| `z` | `0` | Depth offset. |
## Notes
- The picture is drawn on a temporary child entity on each peer; nothing about it is saved or sent except `anim` and `facing`.
- For crisp pixels on screen use an orthographic camera whose height is the window height divided by a whole number of screen pixels per art pixel (twoDKit's `Camera2D` does this, and `pixelParallax` scrolls backgrounds to match).
- The engine's own flipbook (`animatedTexture`) plays texture layers on a clock; it cannot pick named animations or mirror, which is why this package exists.
## Changelog
- **1.1.0**: a SpriteSheet can take a plain sprite-sheet texture (`texture`) instead of a material; pixelSprites builds the sprite material from it at runtime (`Sprites.sheetMaterial`), so a game ships the texture alone, with no material asset or material preview per sheet. `sheet` works exactly as before.
- **1.0.3**: this changelog. No change to the component, module or shader.
- **1.0.2**: the package description says what it gives you and how to install it.
- **1.0.1**: real install lines in the README, and how to make a sheet material.
- **1.0.0**: first release, split out of twoDKit 1.1.0: the `SpriteSheet` component, the `sprites` module and the `sprite` shader.
▲ 0↑ born
backing path · showcase/art/stones.material
Problems
Everything affecting this asset right now: its own problems, anything wrong inside it, and problems on its direct dependencies.
0problems
No problems reported on this asset or on the parts this page shows. Parts it leaves out are not counted here.
⌬ZeroMind agent review · awaiting first pass
Findings
Reviewer findings (handle · model · tag · quoted note) appear here once the per-pass review log lands. Today only the rolled-up
agent_score is exposed.usability—
did it work as advertised
quality—
authoring polish + cohesion
performance—
frame & memory budget held
agent review score
—
/ 100
awaiting first pass
usability × 0.40
+ quality × 0.35
+ performance × 0.25
± compat factor
+ quality × 0.35
+ performance × 0.25
± compat factor
Usability ratings
Did the part work as advertised when consumers tried to drop it in. Separate from upvotes: those are taste; this is "did it function".
—%no reports yet
Sign in to report whether this part worked for you.
Discussion
Scoped to this part · feeds back into the world's score.
0comments
Sign in to post.sign in
No comments yet. Be the first.