Design format

Design format

The JSON specification for a weapon skin. This is what the Skin Studio produces, what an ATY1: share code decodes to, and what an AI should return.

The authoritative values live in Schema.skinLimits() in shared/schema.lua; this page mirrors them. The same specification ships in the resource as AI_SKINS.md, which is the file the studio's Build prompt button copies.

The shape

A design is a list of layers drawn onto a 512×512 canvas, bottom-first. That canvas becomes the weapon's texture.

{
  "base": "#1a1c20",
  "layers": [
    { "type": "pattern", "pattern": 3, "color": "#2b3038", "opacity": 1, "blend": "normal" },
    { "type": "decal", "decal": 0, "color": "#ffd166", "x": 0.5, "y": 0.42,
      "scale": 0.8, "rot": 0, "opacity": 1, "blend": "normal" }
  ]
}

That is the whole format. No wrapper object, no markdown fence, no commentary.

Coordinates are normalised: 0 is the left or top edge, 1 the right or bottom, 0.5 the centre. They are not pixels.

Order is array order. Index 0 is at the bottom, the last entry on top.

base is optional — a #rrggbb string that fills the canvas before any layer.

Layer types

Every layer needs a type. Types marked (placed) accept x, y, scale, rot, opacity and blend.

base — flat fill

{ "type": "base", "color": "#2a2f36", "opacity": 1, "blend": "normal" }

pattern — full-canvas repeating pattern

{ "type": "pattern", "pattern": 2, "color": "#69ffec", "opacity": 0.55, "blend": "normal" }

Patterns 14–21 animate on the weapon itself, live, for everyone who can see it. They take one extra field:

{ "type": "pattern", "pattern": 14, "color": "#8a5cff", "speed": 1, "opacity": 1, "blend": "normal" }

• speed — 0 to 4, default 1. 0 freezes the pattern on its first frame
• Every animated pattern derives its whole palette from the single color, so pick the colour you want the effect to be: #ff6a1e for lava reads as fire, #8a5cff for galaxy reads as deep space
• One animated layer is enough. Two moving patterns fight each other and the result reads as flicker

decal — a shape (placed)

{ "type": "decal", "decal": 4, "color": "#ff4e4e", "x": 0.5, "y": 0.5,
  "scale": 0.9, "rot": 0, "opacity": 1, "blend": "normal" }

text — writing (placed)

{ "type": "text", "text": "GHOST", "font": 3, "outline": true,
  "outlineColor": "#000000", "color": "#ffffff", "x": 0.5, "y": 0.6,
  "scale": 0.4, "rot": 0, "opacity": 1, "blend": "normal" }

• text — 1 to 24 characters. Longer is rejected
• font — 0 Impact · 1 Georgia · 2 Courier · 3 Arial Black · 4 Verdana
• outline / outlineColor — optional; an outline keeps text readable on busy art

stroke — freehand line

{ "type": "stroke", "points": [[0.1,0.8],[0.3,0.72],[0.5,0.86]],
  "color": "#ffd166", "width": 0.03, "opacity": 1, "blend": "normal" }

• points — 2 to 240 normalised [x, y] pairs, smoothed into a curve automatically
• width — 0.002 to 0.25, a fraction of the canvas
• erase: true — cuts through every layer beneath instead of drawing

Strokes are not placed layers: they ignore x, y, scale and rot, because the points already carry their position.

image — an external picture or GIF (placed)

{ "type": "image", "url": "nui://aty_gunsmith_assets/art/decals/skull.svg",
  "tint": true, "color": "#ff4e4e", "x": 0.5, "y": 0.5,
  "scale": 0.7, "rot": 0, "opacity": 1, "blend": "normal" }

• url — https and on Config.Lanes.composite.images.whitelist, or a nui:// path inside the server's own resources
• tint: true — recolours single-colour art to color
• gif: true — animates. Animated images always composite above everything drawn on the canvas; static ones obey layer order

Shared fields

Hard limits

Loading a design

1. Open the workshop, press Custom design
2. Right panel → Share → paste into the "Paste a code or raw JSON" box
3. Both formats work: raw JSON as above, or an ATY1: code exported from the studio

It loads as an editable draft. The server validates every field on save, so a malformed design cannot get in.

Make code then Copy exports a design as a portable string, usable on any server running this resource.

Export as template produces the exact line to paste into aty_gunsmith_assets/art/templates.json, adding the design to the built-in gallery for everyone. Templates are read from that file, so adding one never touches code.

See also

• AI designs — having a model write one
• Skin Studio — the editor