@pinepaper.studio/mcp-server 1.6.22 → 1.6.24
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.de.md +1 -1
- package/README.es.md +1 -1
- package/README.fr.md +1 -1
- package/README.hi.md +1 -1
- package/README.ja.md +1 -1
- package/README.ko.md +1 -1
- package/README.md +115 -5
- package/README.pt-BR.md +1 -1
- package/README.zh-CN.md +1 -1
- package/SECURITY.md +46 -0
- package/dist/agent/types.d.ts +114 -106
- package/dist/agent/types.d.ts.map +1 -1
- package/dist/agent/types.js +1 -1
- package/dist/agent/types.js.map +1 -1
- package/dist/browser/puppeteer-controller.js +2 -2
- package/dist/browser/puppeteer-controller.js.map +1 -1
- package/dist/build-info.json +2 -2
- package/dist/design/design-systems.d.ts +50 -0
- package/dist/design/design-systems.d.ts.map +1 -1
- package/dist/design/design-systems.js +220 -35
- package/dist/design/design-systems.js.map +1 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +13 -2
- package/dist/index.js.map +1 -1
- package/dist/ontology/hints.d.ts.map +1 -1
- package/dist/ontology/hints.js +5 -1
- package/dist/ontology/hints.js.map +1 -1
- package/dist/ontology/upstream-vocabulary.d.ts +1 -1
- package/dist/ontology/upstream-vocabulary.js +1 -1
- package/dist/ontology/vocabulary.d.ts.map +1 -1
- package/dist/ontology/vocabulary.js +1 -0
- package/dist/ontology/vocabulary.js.map +1 -1
- package/dist/tools/batch-macros.d.ts +27 -0
- package/dist/tools/batch-macros.d.ts.map +1 -0
- package/dist/tools/batch-macros.js +157 -0
- package/dist/tools/batch-macros.js.map +1 -0
- package/dist/tools/choreograph.d.ts +4 -0
- package/dist/tools/choreograph.d.ts.map +1 -1
- package/dist/tools/choreograph.js +12 -2
- package/dist/tools/choreograph.js.map +1 -1
- package/dist/tools/compact-descriptions.js +3 -3
- package/dist/tools/compact-descriptions.js.map +1 -1
- package/dist/tools/definitions.d.ts.map +1 -1
- package/dist/tools/definitions.js +122 -15
- package/dist/tools/definitions.js.map +1 -1
- package/dist/tools/engine-lists.d.ts +2 -2
- package/dist/tools/engine-lists.js +2 -2
- package/dist/tools/engine-methods.d.ts.map +1 -1
- package/dist/tools/engine-methods.js +3 -0
- package/dist/tools/engine-methods.js.map +1 -1
- package/dist/tools/engine-surface.d.ts +1 -1
- package/dist/tools/engine-surface.d.ts.map +1 -1
- package/dist/tools/engine-surface.js +52 -6
- package/dist/tools/engine-surface.js.map +1 -1
- package/dist/tools/export-file-check.d.ts +31 -0
- package/dist/tools/export-file-check.d.ts.map +1 -0
- package/dist/tools/export-file-check.js +103 -0
- package/dist/tools/export-file-check.js.map +1 -0
- package/dist/tools/export-file-receipt.d.ts +56 -0
- package/dist/tools/export-file-receipt.d.ts.map +1 -0
- package/dist/tools/export-file-receipt.js +151 -0
- package/dist/tools/export-file-receipt.js.map +1 -0
- package/dist/tools/handlers/beats.d.ts +7 -44
- package/dist/tools/handlers/beats.d.ts.map +1 -1
- package/dist/tools/handlers/export.d.ts.map +1 -1
- package/dist/tools/handlers/export.js +31 -6
- package/dist/tools/handlers/export.js.map +1 -1
- package/dist/tools/handlers/generate.d.ts +41 -270
- package/dist/tools/handlers/generate.d.ts.map +1 -1
- package/dist/tools/handlers.d.ts +84 -1
- package/dist/tools/handlers.d.ts.map +1 -1
- package/dist/tools/handlers.js +389 -82
- package/dist/tools/handlers.js.map +1 -1
- package/dist/tools/lane.d.ts +34 -0
- package/dist/tools/lane.d.ts.map +1 -0
- package/dist/tools/lane.js +210 -0
- package/dist/tools/lane.js.map +1 -0
- package/dist/tools/minimal-descriptions.d.ts.map +1 -1
- package/dist/tools/minimal-descriptions.js +3 -2
- package/dist/tools/minimal-descriptions.js.map +1 -1
- package/dist/tools/nested-ignored.d.ts +16 -0
- package/dist/tools/nested-ignored.d.ts.map +1 -0
- package/dist/tools/nested-ignored.js +83 -0
- package/dist/tools/nested-ignored.js.map +1 -0
- package/dist/tools/shape-params.d.ts +2 -2
- package/dist/tools/shape-params.d.ts.map +1 -1
- package/dist/tools/shape-params.js +9 -2
- package/dist/tools/shape-params.js.map +1 -1
- package/dist/tools/stick-vocabulary.d.ts +4 -4
- package/dist/tools/stick-vocabulary.d.ts.map +1 -1
- package/dist/tools/stick-vocabulary.js +8 -4
- package/dist/tools/stick-vocabulary.js.map +1 -1
- package/dist/tools/timeline.d.ts +136 -0
- package/dist/tools/timeline.d.ts.map +1 -0
- package/dist/tools/timeline.js +1036 -0
- package/dist/tools/timeline.js.map +1 -0
- package/dist/tools/toolkits.d.ts +1 -1
- package/dist/tools/toolkits.d.ts.map +1 -1
- package/dist/tools/toolkits.js +12 -2
- package/dist/tools/toolkits.js.map +1 -1
- package/dist/types/code-generator.d.ts +66 -3
- package/dist/types/code-generator.d.ts.map +1 -1
- package/dist/types/code-generator.js +629 -96
- package/dist/types/code-generator.js.map +1 -1
- package/dist/types/schemas.d.ts +5278 -24999
- package/dist/types/schemas.d.ts.map +1 -1
- package/dist/types/schemas.js +93 -40
- package/dist/types/schemas.js.map +1 -1
- package/manifest.json +5 -1
- package/package.json +8 -7
|
@@ -81,6 +81,8 @@ The generated code is shown in tool responses and can be copied into PinePaper's
|
|
|
81
81
|
|
|
82
82
|
${CHOOSE_THE_DOOR}
|
|
83
83
|
|
|
84
|
+
THE AGENT LANE — when the job is a scene of shapes, text, keyframes and relations exported to a file (a data animation, a title card, a motion test), and no craft tool above is wanted: PINEPAPER_TOOLKIT=lane (or pinepaper_set_toolkit {toolkit: "lane"}) serves five tools — pinepaper_agent_batch_execute, pinepaper_keyframe_animate, pinepaper_pattern, pinepaper_agent_export, pinepaper_lint_scene — whose descriptions carry the rules that otherwise cost a failed build (the keyframe shape, an item's words and look inside properties, position is the centre). The whole contract is under 10k tokens. Use the full surface for characters, styled scenes, maps, diagrams and sound.
|
|
85
|
+
|
|
84
86
|
WORKFLOW — Create → Validate → Iterate:
|
|
85
87
|
|
|
86
88
|
1. pinepaper_agent_start_job (clearCanvas: true, canvasPreset)
|
|
@@ -464,7 +466,7 @@ the label to replace the content.
|
|
|
464
466
|
fontWeight: 400 / 700 / 'bold'. fontStyle: 'italic'. leading: line spacing in px; lineHeight: a multiple of fontSize (<= 4) or px. Multi-line content splits on \n.
|
|
465
467
|
fit: {maxWidth, maxHeight?, minFontSize? (8), maxFontSize? (current), wrap? (true), hold? ('top' | 'center' | …)} — auto-size the text into a box, keeping its anchored edge. The box is remembered: changing content later refits (shrinks, or grows back to maxFontSize); modify_item {fit: {...}} sets a new box; {fit: null} stops fitting. The result's textFit says {fontSize, lines, fits}; fits:false means it overflows even at minFontSize. Studios without auto-fit say so in textFit. Every export's fidelity then lists text_overflow for any text past its box or off the frame — the check to run before a batch of variants.
|
|
466
468
|
direction: 'auto' (default: the first strong letter decides, so Arabic and Hebrew need nothing) | 'ltr' | 'rtl' — the paragraph's base direction, which places neutrals like the final period (aliases textDirection, dir). The result's direction says whether the studio applied it; a studio without RTL support lays text out left-to-right and says so. justification: 'right' is alignment, not direction.
|
|
467
|
-
tabularFigures: true (or fontVariantNumeric: 'tabular-nums', or fontFeatures containing 'tnum') — fixed-width digits, so a counter, price or timer does not jitter as it changes. The result's tabularFigures
|
|
469
|
+
tabularFigures: true (or fontVariantNumeric: 'tabular-nums', or fontFeatures containing 'tnum') — fixed-width digits, so a counter, price or timer does not jitter as it changes. The result's tabularFigures.applied is measured on the current studio: true only when the layout moves a digit's advance; false with a reason (font-digits-already-equal: the font's digits are one width already, so nothing changes and steadyWidth is true; rtl; not-requested); 'unverified' on an older studio that records the request but cannot measure it.
|
|
468
470
|
strokePosition: 'outside' — the stroke sits entirely outside the letters (drawn under the fill at twice strokeWidth), so a thick caption / meme outline keeps the letterform; 'center' (default) is the ordinary stroke. The result's strokePosition says whether the studio applied it.
|
|
469
471
|
- circle: Circular shape (properties: radius, color, strokeColor, strokeWidth)
|
|
470
472
|
- star: Star shape (properties: radius1, radius2, points, color)
|
|
@@ -550,7 +552,8 @@ Use itemType: "path" with either:
|
|
|
550
552
|
ADVANCED STYLING (NEW):
|
|
551
553
|
All shapes support these additional properties:
|
|
552
554
|
- No fill (stroke-only outlines, line art): fillColor: null, 'transparent' or 'none', with a strokeColor and strokeWidth.
|
|
553
|
-
-
|
|
555
|
+
- fillOpacity (0..1): the solid fill's own alpha, apart from opacity (which fades the stroke too) — on text, fillOpacity: 0.3 with a strokeColor is a see-through letter with a solid outline. Not applied to a gradient fill. The result's fillOpacity says whether the studio applied it (an older studio ignores the key and says so).
|
|
556
|
+
- Gradients: color can be an object: {type: "linear"|"radial", stops: [{color: "#fff", offset: 0}, {color: "#000", offset: 1}], origin: [x,y], destination: [x,y]}. Without origin / destination a radial gradient is centred on the item's own bounds and reaches its right edge, wherever anchor put it.
|
|
554
557
|
- Shadows: shadowColor, shadowBlur (pixels), shadowOffset: [x, y]
|
|
555
558
|
- Blend modes: blendMode: "multiply"|"screen"|"overlay"|"darken"|"lighten"|etc.
|
|
556
559
|
- Opacity: opacity (0-1)
|
|
@@ -729,7 +732,8 @@ USE WHEN:
|
|
|
729
732
|
|
|
730
733
|
MODIFIABLE PROPERTIES:
|
|
731
734
|
- position: {x, y} or separate x, y
|
|
732
|
-
- color/fillColor: Fill color (solid string OR gradient object)
|
|
735
|
+
- color/fillColor: Fill color (solid string OR gradient object); null, 'transparent' or 'none' removes the fill
|
|
736
|
+
- fillOpacity (0..1): the solid fill's own alpha, apart from opacity; on the current studio it is kept when a later fillColor changes the fill. The result's fillOpacity says whether the studio applied it.
|
|
733
737
|
- strokeColor: Outline color (solid string OR gradient object)
|
|
734
738
|
- strokeWidth: Outline thickness
|
|
735
739
|
- fontSize: Text size
|
|
@@ -1175,6 +1179,7 @@ Use maxWidth/maxHeight to constrain the image dimensions while preserving aspect
|
|
|
1175
1179
|
- maxEdge: the longest edge the studio STORES the image at (px), or 'native' to keep every pixel. The result says when it was stored smaller.
|
|
1176
1180
|
- nativeSize: true places the image at its source footprint even if it was stored smaller.
|
|
1177
1181
|
- smoothing: 'off' (nearest-neighbour, for pixel art) | 'low' (default) | 'medium' | 'high'.
|
|
1182
|
+
- shadowColor / shadowBlur / shadowOffset: a drop shadow on the placed image, the same keys pinepaper_modify_item takes.
|
|
1178
1183
|
|
|
1179
1184
|
EXAMPLES:
|
|
1180
1185
|
- Import photo: url: "https://example.com/photo.jpg"
|
|
@@ -1215,6 +1220,9 @@ EXAMPLES:
|
|
|
1215
1220
|
enum: ['off', 'low', 'medium', 'high'],
|
|
1216
1221
|
description: "Resampling when the image is scaled. 'off' = nearest-neighbour, hard pixel edges — use it for pixel art. Default 'low'. Change it later with pinepaper_modify_item {smoothing}.",
|
|
1217
1222
|
},
|
|
1223
|
+
shadowColor: { type: 'string', description: 'Drop shadow colour (hex, rgb(a) or a name), applied to the placed image — the mask group when masked. result.shadow says whether it applied.' },
|
|
1224
|
+
shadowBlur: { type: 'number', description: 'Drop shadow blur radius in px.' },
|
|
1225
|
+
shadowOffset: { type: 'array', items: { type: 'number' }, minItems: 2, maxItems: 2, description: 'Drop shadow offset [x, y] in px.' },
|
|
1218
1226
|
},
|
|
1219
1227
|
required: ['url'],
|
|
1220
1228
|
},
|
|
@@ -2715,7 +2723,7 @@ An AESTHETIC STYLE is a look: Bauhaus, Art Deco, Swiss typographic, De Stijl, va
|
|
|
2715
2723
|
- list_easings: every motion curve across every system as a named easing, with its licence and whether it was authored here. Use these to make a motion match a system it has to sit beside.
|
|
2716
2724
|
- list_motion: those curves AND the duration scale sitting beside them — the other half of a motion token, published nowhere until now. A curve is a shape; a motion is a shape over a length, and matching a system's easing while inventing its timing gets only the easy half right. Durations come back in ms and in seconds, because every animation tool here takes seconds. These are the licensed SYSTEMS' motion scales: an aesthetic style carries no upstream motion data, so pair one of these with a style rather than expecting the style to name its own.
|
|
2717
2725
|
- list_styles: every style with its TOKENS — palette, background, font stacks, type sizes and any variants — derived by composing it, so they are what the generator will actually draw. Read these to hand-build in a style rather than reverse-engineering its colours.
|
|
2718
|
-
- compose: build a titled scene in a style. Layout is decided in this server by a pure function, so 'compose' with draw:false returns the scene and the ops as DATA and draws nothing — read it before committing, the same way pinepaper_story's distill works. Element boxes are converted to the centre anchor app.create wants, and text carries its alignment, so a left-aligned headline starts at its x instead of centring on it.
|
|
2726
|
+
- compose: build a titled scene in a style. Layout is decided in this server by a pure function, so 'compose' with draw:false returns the scene and the ops as DATA and draws nothing — read it before committing, the same way pinepaper_story's distill works. Element boxes are converted to the centre anchor app.create wants, and text carries its alignment, so a left-aligned headline starts at its x instead of centring on it. A style's circles are drawn as circles, a clip-path frame keeps its angled corners, a neon glow becomes a shadow, and a scanline overlay is drawn as lines. At a width/height the style was not laid out for, text can land on a shape it clears at its own default size; the result names each such pair in layoutCollisions rather than drawing it as intended.
|
|
2719
2727
|
|
|
2720
2728
|
A partial composition reports as a failure with the elements that did not create, rather than as a success with half a poster.`,
|
|
2721
2729
|
inputSchema: {
|
|
@@ -3888,11 +3896,12 @@ ANIMATABLE PROPERTIES:
|
|
|
3888
3896
|
- strokeColor: Color string
|
|
3889
3897
|
- strokeWidth, width, height, radius, shadowBlur, shadowColor: Numbers / colours
|
|
3890
3898
|
- fontSize: Number
|
|
3899
|
+
- TEXT (current studio): fontStyle ('normal' / 'italic' / 'oblique', discrete — switches at the next key), textAlign ('left' / 'center' / 'right', discrete; the anchor stays put), lineHeight (px, or a multiple of fontSize up to 5), letterSpacing (px, or a CSS length such as '0.1em'). An older studio stores these keys without drawing them; the result names any it did not animate (ignoredProperties).
|
|
3891
3900
|
- STROKE DRAW-ON (paths): trimStart, trimEnd (0-1 of the path's length), trimOffset (shifts the visible window along it), dashArray. A draw-on is trimEnd 0 -> 1.
|
|
3892
3901
|
The authoritative list for a given item is pinepaper_get_animatable_properties — ask it rather than guessing.
|
|
3893
3902
|
|
|
3894
|
-
EASING — IT SHAPES THE SEGMENT ARRIVING AT THE KEYFRAME IT IS ON.
|
|
3895
|
-
The move from keyframe A to keyframe B is eased by B's easing, not A's.
|
|
3903
|
+
EASING — BY DEFAULT IT SHAPES THE SEGMENT ARRIVING AT THE KEYFRAME IT IS ON.
|
|
3904
|
+
The move from keyframe A to keyframe B is eased by B's easing, not A's. So by default the FIRST keyframe's easing has no effect (no segment arrives at it) — a Ken Burns with easing only on its first key plays linear. Put the easing on the key you are moving TO, or pass easingAt: 'departure' for the other reading: each key's easing shapes the move LEAVING it, so the first key's easing eases the first move (current studio; an older one reads arrival and the result says so). 'hold' / 'step' stay on the key they mark either way.
|
|
3896
3905
|
${EASING_LINES}
|
|
3897
3906
|
- or a custom cubic-bezier [x1, y1, x2, y2] — x in 0..1, y may exceed 0..1 for overshoot. keyframe_animate and camera_animate only.
|
|
3898
3907
|
COUNTERS: a text item with a counter (create_item / modify_item counter) also animates the numeric property counterValue, drawn through the counter's format — keyframe it to shape a count by hand (hold on a number, then race). Its keys override the counter's own from / to.
|
|
@@ -3928,7 +3937,7 @@ EXAMPLE — Reveal at 2s, skip first second of keyframe data, end at 4s of keyfr
|
|
|
3928
3937
|
},
|
|
3929
3938
|
easing: {
|
|
3930
3939
|
...KEYFRAME_EASING_JSON_SCHEMA,
|
|
3931
|
-
description:
|
|
3940
|
+
description: "Shapes the segment ARRIVING at this keyframe (from the previous one), so by default it has no effect on the first keyframe; with easingAt: 'departure', the segment LEAVING it. A name, or a custom cubic-bezier [x1, y1, x2, y2] — x in 0..1, y may exceed 0..1 for overshoot.",
|
|
3932
3941
|
},
|
|
3933
3942
|
},
|
|
3934
3943
|
required: ['time', 'properties'],
|
|
@@ -3959,6 +3968,16 @@ EXAMPLE — Reveal at 2s, skip first second of keyframe data, end at 4s of keyfr
|
|
|
3959
3968
|
type: 'boolean',
|
|
3960
3969
|
description: 'Add these keys to the item\'s existing track (same-time keys merge, new values win) instead of replacing it — e.g. a button press after an entrance. Without it, a second call replaces the track. result.track says whether the track was appended to or replaced; studios without merge replace, and say so.',
|
|
3961
3970
|
},
|
|
3971
|
+
mode: {
|
|
3972
|
+
type: 'string',
|
|
3973
|
+
enum: ['replace', 'merge'],
|
|
3974
|
+
description: "The studio's spelling of append, accepted so its keyframe_track_replaced warning (\"Pass { mode: 'merge' }\") can be followed as written: 'merge' is append: true; 'replace' is the default. append and mode that disagree are refused as a contradiction.",
|
|
3975
|
+
},
|
|
3976
|
+
easingAt: {
|
|
3977
|
+
type: 'string',
|
|
3978
|
+
enum: ['arrival', 'departure'],
|
|
3979
|
+
description: "Which segment a key's easing shapes. 'arrival' (default): the move ARRIVING at the key, so the first key's easing has no effect. 'departure': the move LEAVING the key, so an ease placed where a motion starts applies there. Current studio; an older one reads arrival and the result says so.",
|
|
3980
|
+
},
|
|
3962
3981
|
},
|
|
3963
3982
|
required: ['itemId', 'keyframes'],
|
|
3964
3983
|
},
|
|
@@ -4808,6 +4827,57 @@ EXAMPLE:
|
|
|
4808
4827
|
},
|
|
4809
4828
|
},
|
|
4810
4829
|
},
|
|
4830
|
+
{
|
|
4831
|
+
name: 'pinepaper_pattern',
|
|
4832
|
+
annotations: {
|
|
4833
|
+
title: 'Pattern',
|
|
4834
|
+
readOnlyHint: false,
|
|
4835
|
+
destructiveHint: false,
|
|
4836
|
+
idempotentHint: false,
|
|
4837
|
+
openWorldHint: false,
|
|
4838
|
+
},
|
|
4839
|
+
description: `Move many items with ONE stored declaration instead of a keyframe track on each: a wave running through a row of letters, a stagger spreading across a grid. The pattern is kept as a node: change its amplitude once and every member follows; remove it and the members go back to where they were. It is saved with the scene, undone as one step and restored on load.
|
|
4840
|
+
|
|
4841
|
+
KINDS:
|
|
4842
|
+
- phase_wave — members move on a sine, each a phase later than the one before. params: property ('y' default, 'x', 'rotation', 'opacity'), amplitude (px, degrees or 0..1), period (seconds per cycle), wavelength (members per full cycle), phase (radians). window { from, to } limits when it plays; time counts from \`from\`.
|
|
4843
|
+
- stagger — each member's animationDelay, derived from its place. params: step (s between neighbours), start (s), order: index | reverse | center | edges.
|
|
4844
|
+
|
|
4845
|
+
MEMBERS — by names (a '*' matches any run: "letter-*"), ids, or a tag, in the order they are given; an array is taken as ids or names. A name that matches nothing is reported in the result, not ignored.
|
|
4846
|
+
|
|
4847
|
+
ACTIONS: create (needs id, kind, members) · modify (id + params, members or window) · remove (id) · list · get (id: the pattern and the items it holds).
|
|
4848
|
+
|
|
4849
|
+
EXAMPLE — a word waving, letter after letter:
|
|
4850
|
+
{ "action": "create", "id": "wave", "kind": "phase_wave", "members": { "names": "letter-*" }, "params": { "amplitude": 12, "period": 1.2, "wavelength": 6 } }`,
|
|
4851
|
+
inputSchema: {
|
|
4852
|
+
type: 'object',
|
|
4853
|
+
properties: {
|
|
4854
|
+
action: { type: 'string', enum: ['create', 'modify', 'remove', 'list', 'get'], description: 'create · modify · remove · list · get' },
|
|
4855
|
+
id: { type: 'string', description: "the pattern's name; required except for list" },
|
|
4856
|
+
kind: { type: 'string', enum: ['phase_wave', 'stagger'], description: 'create: phase_wave or stagger' },
|
|
4857
|
+
members: {
|
|
4858
|
+
description: 'which items: an array of ids or names, or { ids, names, tag }',
|
|
4859
|
+
oneOf: [
|
|
4860
|
+
{ type: 'array', items: { type: 'string' } },
|
|
4861
|
+
{
|
|
4862
|
+
type: 'object',
|
|
4863
|
+
properties: {
|
|
4864
|
+
ids: { type: 'array', items: { type: 'string' } },
|
|
4865
|
+
names: { oneOf: [{ type: 'string' }, { type: 'array', items: { type: 'string' } }] },
|
|
4866
|
+
tag: { type: 'string' },
|
|
4867
|
+
},
|
|
4868
|
+
},
|
|
4869
|
+
],
|
|
4870
|
+
},
|
|
4871
|
+
params: { type: 'object', description: 'phase_wave: property, amplitude, period, wavelength, phase · stagger: step, start, order' },
|
|
4872
|
+
window: {
|
|
4873
|
+
type: ['object', 'null'],
|
|
4874
|
+
properties: { from: { type: 'number' }, to: { type: 'number' } },
|
|
4875
|
+
description: 'phase_wave: when it plays, in scene seconds',
|
|
4876
|
+
},
|
|
4877
|
+
},
|
|
4878
|
+
required: ['action'],
|
|
4879
|
+
},
|
|
4880
|
+
},
|
|
4811
4881
|
{
|
|
4812
4882
|
name: 'pinepaper_stagger',
|
|
4813
4883
|
annotations: {
|
|
@@ -7976,7 +8046,13 @@ ACTIONS:
|
|
|
7976
8046
|
SPEC:
|
|
7977
8047
|
- mode: 'burst' (default) — bursts: [{ t, x, y, count, …per-burst overrides }]: a pop of particles at scene time t.
|
|
7978
8048
|
- mode: 'trail' (or give target) — target (an item id), rate (per second), emitWindows [[t0, t1], …], window, offset: particles shed from a moving item.
|
|
7979
|
-
- look and physics (per emitter or per burst): shape ('circle' | 'rect' | 'dash' | 'star' | 'confetti', or an array), palette [colours], size / sizes / sizeEnd, speed + angle ranges or velocities, gravity (px/s², +down), drag, friction, lifetime, fadeIn / fadeOut, spin, opacity, jitter, seed.
|
|
8049
|
+
- look and physics (per emitter or per burst): shape ('circle' | 'rect' | 'dash' | 'star' | 'confetti', or an array), palette [colours], size / sizes / sizeEnd, speed + angle ranges or velocities ([[vx, vy], …] px/s, or [{x, y}, …]; particle i takes velocities[i % length], so give one per particle — the reply warns when count and the list differ), gravity (px/s², +down), drag, friction, lifetime, fadeIn / fadeOut, spin, opacity, jitter, jitterGrow, seed.
|
|
8050
|
+
UNITS (a number, or a [min, max] range picked per particle where it says range):
|
|
8051
|
+
- count: particles per burst, at most 10000 on the current studio (2000 on older studios) — a larger count is drawn at the cap and the reply warns with the number drawn. For more, add a second burst at the same t.
|
|
8052
|
+
- speed: px/s (range). angle: degrees, 0 = right, 90 = down (range). gravity: px/s². lifetime: seconds (range, > 0). size: px (range).
|
|
8053
|
+
- fadeIn / fadeOut: SECONDS at the start / end of each particle's life. fadeOut is capped at that particle's lifetime (a 0.5 s life cannot fade for 2 s; it fades over its whole life instead), and the current studio warns when it caps one. Omitted (or fade: 'linear'), the particle fades linearly over its WHOLE life; fade: 'none' turns both off.
|
|
8054
|
+
- spin: DEGREES PER SECOND, positive = clockwise on screen (range; spinAlternate flips every other particle). It turns rect, confetti, star and dash particles; a circle has no orientation, so spin on circles shows nothing (the current studio warns when every particle is a circle).
|
|
8055
|
+
- jitter: PIXELS — on the current studio each particle is displaced up to ±jitter px on each axis from its path, at full size from birth; jitterGrow: true keeps the older ramp (zero at birth, the full ±jitter at the end of life). Older studios (before jitterGrow) displace up to ±jitter/2, growing from 0 at birth. jitterHz: how many times a second that offset is re-rolled (0, the default, keeps one offset per particle).
|
|
7980
8056
|
An unknown shape, mode or bad range is refused with the engine's reason — never defaulted.
|
|
7981
8057
|
|
|
7982
8058
|
EXAMPLE — confetti at 2 s:
|
|
@@ -8662,9 +8738,11 @@ ITEMS:
|
|
|
8662
8738
|
ANIMATION:
|
|
8663
8739
|
animate — Loop animation: {itemId, animationType, animationOptions}
|
|
8664
8740
|
animationType: ${SIMPLE_ANIMATION_TYPES_LIST}
|
|
8665
|
-
keyframe_animate — Timed animation: {itemId, keyframes: [{time, properties, easing}], duration, loop, append}. Replaces the item's track unless append: true; two ops on one item in a batch are merged into one.
|
|
8741
|
+
keyframe_animate — Timed animation: {itemId, keyframes: [{time, properties, easing}], duration, loop, append}. Replaces the item's track unless append: true (or mode: 'merge', the studio's spelling); two ops on one item in a batch are merged into one.
|
|
8666
8742
|
Animatable properties: opacity, scale, scaleX, scaleY, x, y, rotation, fillColor, strokeColor, strokeWidth, width, height, radius, fontSize, trimStart/trimEnd/trimOffset (path draw-on)
|
|
8667
8743
|
Easing (on the keyframe being moved TO): ${KEYFRAME_EASINGS_LIST}
|
|
8744
|
+
timeline — GSAP's timeline as JSON, compiled onto keyframe tracks (nothing is evaluated): {defaults: {ease, duration}, tweens: [{to: name | id | "$N" | [...] | "bar-*", vars: end values, from: start values, duration, delay, at: seconds | "<" | ">" | "+=0.2" | label, stagger: N | {each, from}, ease: "power2.out" | "none" | "back.out" | …, repeat, yoyo, repeatDelay}], duration?, labels?}. x/y are OFFSETS from where the item was created (as in GSAP); scale/scaleY on a bottom-anchored item (or transformOrigin "bottom") holds its edge; drawSVG "0%"→"100%" draws a path on; fill/color → fillColor. Every track is as long as the timeline. A tween it cannot carry is refused by name; the result has a receipt per tween.
|
|
8745
|
+
{type: "timeline", defaults: {ease: "power2.out"}, tweens: [{to: "bar-*", from: {scaleY: 0}, vars: {scaleY: 1}, duration: 0.8, at: 0.5, stagger: 0.15}, {to: "ring", vars: {rotation: 480}, duration: 8, ease: "none", at: 0}]}
|
|
8668
8746
|
relation — Behavioral link: {sourceId, targetId, relationType, relationOptions}
|
|
8669
8747
|
relationType: orbits, follows, attached_to, points_at, mirrors, parallax, wave_through, morphs_to, group_morphs_to, moves_along_path (+ 9 more in schema)
|
|
8670
8748
|
|
|
@@ -8710,8 +8788,8 @@ EXAMPLE — Animated sky scene with timed reveals:
|
|
|
8710
8788
|
properties: {
|
|
8711
8789
|
type: {
|
|
8712
8790
|
type: 'string',
|
|
8713
|
-
enum: ['set_canvas_size', 'set_background', 'execute_generator', 'create', 'modify', 'delete', 'group', 'animate', 'keyframe_animate', 'relation', 'apply_mask', 'apply_effect', 'play_timeline'],
|
|
8714
|
-
description: 'Operation type',
|
|
8791
|
+
enum: ['set_canvas_size', 'set_background', 'execute_generator', 'create', 'modify', 'delete', 'group', 'animate', 'keyframe_animate', 'relation', 'apply_mask', 'apply_effect', 'play_timeline', 'ring', 'grid', 'orbit', 'stagger', 'patch', 'timeline'],
|
|
8792
|
+
description: 'Operation type. timeline compiles a GSAP-shaped timeline onto keyframe tracks. ring / grid make many items in one op (each a create, so each fills a $N slot in order), orbit binds an orbits relation (making the orbiting item when itemType is given), stagger plays the same keyframes on itemIds one after another, patch changes the item with that name (refused when several items hold it).',
|
|
8715
8793
|
},
|
|
8716
8794
|
// Canvas setup
|
|
8717
8795
|
width: { type: 'number', description: 'Canvas width for set_canvas_size (100-16384)' },
|
|
@@ -8766,6 +8844,7 @@ EXAMPLE — Animated sky scene with timed reveals:
|
|
|
8766
8844
|
duration: { type: 'number', description: 'Duration in seconds for keyframe_animate or play_timeline' },
|
|
8767
8845
|
loop: { type: 'boolean', description: 'Loop for keyframe_animate or play_timeline' },
|
|
8768
8846
|
append: { type: 'boolean', description: "For keyframe_animate: add these keys to the item's existing track instead of replacing it (a key at the same time merges, the new values win). Without it the op replaces the track; the op's result says which happened." },
|
|
8847
|
+
mode: { type: 'string', description: "For keyframe_animate: the studio's spelling of append — 'merge' is append: true; 'replace' (the default) replaces the track." },
|
|
8769
8848
|
// Relations
|
|
8770
8849
|
sourceId: { type: 'string', description: 'For relation: source item ID or $N' },
|
|
8771
8850
|
targetId: { type: 'string', description: 'For relation: target item ID or $N' },
|
|
@@ -8797,8 +8876,32 @@ EXAMPLE — Animated sky scene with timed reveals:
|
|
|
8797
8876
|
description: 'For play_timeline: action',
|
|
8798
8877
|
},
|
|
8799
8878
|
time: { type: 'number', description: 'For play_timeline seek: time in seconds' },
|
|
8879
|
+
// Macros
|
|
8880
|
+
count: { type: 'integer', minimum: 1, maximum: 200, description: 'ring: how many items (default 12)' },
|
|
8881
|
+
center: { type: 'object', properties: { x: { type: 'number' }, y: { type: 'number' } }, description: 'ring: the centre {x, y} (default 400, 300)' },
|
|
8882
|
+
radius: { type: 'number', description: 'ring: the circle the items sit on (default 150). orbit: the orbit radius.' },
|
|
8883
|
+
startAngle: { type: 'number', description: 'ring: degrees of the first item, clockwise from 3 o\'clock (default -90, the top)' },
|
|
8884
|
+
orient: { type: 'boolean', description: 'ring: turn each item to face out from the centre' },
|
|
8885
|
+
period: { type: 'number', description: 'ring: seconds for the stagger to travel once round (stagger = period / count)' },
|
|
8886
|
+
stagger: { type: 'number', description: 'ring, grid, stagger: seconds between one item\'s keyframes and the next' },
|
|
8887
|
+
rows: { type: 'integer', minimum: 1, description: 'grid: rows' },
|
|
8888
|
+
cols: { type: 'integer', minimum: 1, description: 'grid: columns (rows × cols up to 200)' },
|
|
8889
|
+
origin: { type: 'object', properties: { x: { type: 'number' }, y: { type: 'number' } }, description: 'grid: the first item {x, y} (default 100, 100)' },
|
|
8890
|
+
spacing: { oneOf: [{ type: 'number' }, { type: 'array', items: { type: 'number' }, minItems: 2, maxItems: 2 }], description: 'grid: gap between centres, or [dx, dy] (default 50)' },
|
|
8891
|
+
name: { type: 'string', description: 'ring, grid: name prefix (items are name_0, name_1 … or name_row_col). orbit: the made item\'s name. patch: the item to change.' },
|
|
8892
|
+
speed: { type: 'number', description: 'orbit: the orbits relation\'s speed (its own units; omit for the studio default)' },
|
|
8893
|
+
phaseDegrees: { type: 'number', description: 'orbit: starting angle in degrees' },
|
|
8894
|
+
// GSAP-shaped timeline (src/tools/timeline.ts)
|
|
8895
|
+
tweens: { type: 'array', items: { type: 'object' }, description: 'For timeline: [{to, vars, from, duration, delay, at, stagger, ease, repeat, yoyo, repeatDelay}]' },
|
|
8896
|
+
defaults: { type: 'object', description: 'For timeline: {ease, duration} for tweens that give none' },
|
|
8897
|
+
labels: { type: 'object', description: 'For timeline: {name: seconds}, for at: "name" or "name+=0.5"' },
|
|
8800
8898
|
},
|
|
8801
8899
|
required: ['type'],
|
|
8900
|
+
// Open, as the zod schema is (.passthrough()): a create op takes its
|
|
8901
|
+
// properties flat (content, fontSize, x, y …) and a keyframe op takes
|
|
8902
|
+
// timeOffset / timeUnits / clipInPoint / clipOutPoint at the top.
|
|
8903
|
+
// create_item's own check still names a property the studio ignores.
|
|
8904
|
+
additionalProperties: true,
|
|
8802
8905
|
},
|
|
8803
8906
|
description: 'Array of operations to execute in order',
|
|
8804
8907
|
},
|
|
@@ -8869,7 +8972,8 @@ Held exports last until released, or until a LATER export needs the space — an
|
|
|
8869
8972
|
},
|
|
8870
8973
|
description: `Smart export with automatic format detection and platform optimization.
|
|
8871
8974
|
|
|
8872
|
-
WHAT quality ACTUALLY SETS, because it bundles three things and only one of them is "quality": draft = 15fps / 72dpi / compression 0.6, standard = 30fps / 150dpi / 0.85, high = 60fps / 300dpi / 0.95. So asking for high DOUBLES the frame count and the render time against standard. Override either half directly - fps for frame rate, scale for resolution
|
|
8975
|
+
WHAT quality ACTUALLY SETS, because it bundles three things and only one of them is "quality": draft = 15fps / 72dpi / compression 0.6, standard = 30fps / 150dpi / 0.85, high = 60fps / 300dpi / 0.95. So asking for high DOUBLES the frame count and the render time against standard. Override either half directly - fps for frame rate, scale for resolution.
|
|
8976
|
+
The compression half is weaker than its name for VIDEO: on mp4 / webm it scales the encoder's resolution-derived target bitrate, and the browser encoder treats that target as a CEILING. A simple scene encodes well under either ceiling, so draft and high at the same fps can come out within bytes of each other; a scene with grain is encoded at a fixed quantizer and ignores it. To change a video's size or quality, use scale, or bitrate (with bitrateMode 'constant' to hold it); result.video.achievedBitrate says what the encoder produced. On jpg / webp stills compression IS the encoder quality, and lower means a smaller file.
|
|
8873
8977
|
|
|
8874
8978
|
DOES THIS SURVIVE EXPORT? It is a PATH fact, not a per-feature one, so the rule is short and does not go stale as capabilities land: IF IT TICKS INSIDE THE ENGINE'S UPDATE LOOP, IT EXPORTS. Loop presets (pinepaper_animate), relations, keyframes, generators and camera moves all do - measured frame-by-frame, not assumed. What does NOT survive is anything driven by the wall clock outside that loop, or anything on the realtime recorder path.
|
|
8875
8979
|
ONE MEASURED EXCEPTION TO CHECK: keyframe_animate's loop:true has been measured playing ONCE in an export and then holding the last keyframe. Before exporting past one cycle, sample a frame in the second cycle; if it holds, write the keyframes out for each cycle, or use a loop preset.
|
|
@@ -8985,7 +9089,7 @@ VERIFY MOTION BEFORE YOU RENDER. An export takes seconds to minutes and shows yo
|
|
|
8985
9089
|
quality: {
|
|
8986
9090
|
type: 'string',
|
|
8987
9091
|
enum: ['draft', 'standard', 'high'],
|
|
8988
|
-
description: 'Compression level (default: standard). It ALSO carries a default frame rate — draft 15, standard 30, high 60 — so "high" doubles the frame count and the render time against "standard" unless you set fps yourself.
|
|
9092
|
+
description: 'Compression level (default: standard). It ALSO carries a default frame rate — draft 15, standard 30, high 60 — so "high" doubles the frame count and the render time against "standard" unless you set fps yourself. For mp4 / webm the compression only scales a bitrate CEILING the encoder rarely reaches on a simple scene, so it may not change the file at all — use scale or bitrate to control size. For jpg / webp it is the encoder quality.',
|
|
8989
9093
|
},
|
|
8990
9094
|
fps: {
|
|
8991
9095
|
anyOf: [{ type: 'number', minimum: 1, maximum: 120 }, { type: 'string', pattern: '^[0-9]+/[0-9]+$' }],
|
|
@@ -9482,6 +9586,8 @@ USE WHEN: You need full parameter docs, examples, or workflow guidance — espec
|
|
|
9482
9586
|
|
|
9483
9587
|
PREFER RESOURCES WHERE POSSIBLE: The full AI Agent Guide is also available via the MCP resources API at pinepaper://docs/agent-guide — clients that support resources should pull it that way rather than calling this tool. Per-domain references live at pinepaper://docs/{generators,relations,masks,diagrams,maps,effects-and-filters,fonts,custom-paths,paperjs-in-pinepaper,templates,customization,getting-started}. Use this tool when the client doesn't support resources or when you want a specific tool's verbose description.
|
|
9484
9588
|
|
|
9589
|
+
THE AGENT LANE: for a scene built from shapes, text, keyframes and relations and exported to a file, a five-tool lane carries the whole contract in its descriptions (no guide, no lessons file): start the server with PINEPAPER_TOOLKIT=lane, or pinepaper_set_toolkit {toolkit: "lane"}.
|
|
9590
|
+
|
|
9485
9591
|
MODES:
|
|
9486
9592
|
- No args → returns the full AI Agent Guide (same content as pinepaper://docs/agent-guide)
|
|
9487
9593
|
- tool: "pinepaper_agent_batch_execute" → returns that tool's full verbose description
|
|
@@ -9528,6 +9634,7 @@ PROFILES:
|
|
|
9528
9634
|
- map: Map/choropleth tools
|
|
9529
9635
|
- font: Font creation tools
|
|
9530
9636
|
- minimal: Bare essentials
|
|
9637
|
+
- lane: the agent lane — five tools (batch_execute, keyframe_animate, pattern, agent_export, lint_scene) whose descriptions carry everything needed to build and export a shape/text/keyframe scene; set it for a scripted build that needs nothing else. It lists no way back: set it last.
|
|
9531
9638
|
|
|
9532
9639
|
VERBOSITY:
|
|
9533
9640
|
- verbose: Full descriptions
|
|
@@ -9538,8 +9645,8 @@ VERBOSITY:
|
|
|
9538
9645
|
properties: {
|
|
9539
9646
|
toolkit: {
|
|
9540
9647
|
type: 'string',
|
|
9541
|
-
description: 'Toolkit profile: full, agent, diagram, map, font, minimal',
|
|
9542
|
-
enum: ['full', 'agent', 'diagram', 'map', 'font', 'minimal'],
|
|
9648
|
+
description: 'Toolkit profile: full, agent, diagram, map, font, minimal, lane',
|
|
9649
|
+
enum: ['full', 'agent', 'diagram', 'map', 'font', 'minimal', 'lane'],
|
|
9543
9650
|
},
|
|
9544
9651
|
verbosity: {
|
|
9545
9652
|
type: 'string',
|