Docs Contribute
Known Gaps
What does not work yet, so you do not have to find out the hard way.
Format
- Rich text is limited to bold, italic and inline icons (
markup); there are no mixed sizes or colors inside one text layer, and italic needs an italic font. - SVG images are drawn by a small renderer: filters, masks, clip paths,
<use>, embedded images and text on a path inside an SVG are not supported. Text is drawn with a font the design declares or the default font, never a system font; see Fonts for SVG text. - Shared components (
include) are included more than once per design with anid_prefix, but they take no arguments: every copy uses the design's params. The builder does not show live values inside component files. - Per-card layer overrides are not in the format; cards change params only. (Single items of a default list can be changed, see Params.)
- The layer limit is 500 visible layers per card unless it is raised with
YOSHIDA_MAX_LAYERS(Limits); a project cannot raise it from its own files.yoshida checkfinds cards over it. See Repeat. - A layer inside two nested repeats cannot be referenced from outside both (error 3005); an index picks one level only. See Repeat.
- Functions cannot read layers or loop names (pass them as arguments) and cannot call themselves. See Constants and functions.
- A typo in a word compared with an enum value inside an expression (
t.kind == 'saef') is not reported; card values of enum params and enum item fields are checked. - Percentages are always of the canvas:
%,vwandvhinside a group moved withtranslatestill refer to the canvas, so a group cannot be laid out in its own percentages. - Functions cannot build lists. There are no
map,filterorsort; lists come only from list params andrepeat. See List functions.
Drawing
- Emoji and color fonts are not drawn; characters without a glyph in the font, the default font and the bundled symbol font are boxes (warning 4003).
- Polygon strokes always have round joins and ends; there are no miter or bevel joins and no square caps.
- Text outlines cannot be dashed.
Output
- Image PDFs hold the card as an 8-bit image (no 16-bit). For sharper print or zoom, export at a higher resolution (2x to 4x; see Resolution) or as a vector file. Vector PDFs and SVG files draw the card as vectors, except:
- A layer with a
gradient, or an image withradiusorclip, is embedded as pixels at the export resolution. - A layer or group with a
sharpen,detail,edge_enhance,find_edges,blurorshadoweffect is embedded as pixels, at the export resolution (the export dialog's Resolution,--scaleor"scale"; 2x when not given). - Text becomes the outlines of its letters; it cannot be selected, searched or edited in the file.
- Images are embedded with the pixels they have, and the viewer scales them, so a small image looks as soft (or as blocky, with
"smoothing": "nearest") as in the PNG.
- A layer with a
- The viewer anti-aliases a vector file, so edges, thin lines and small text differ slightly from the PNG, and a
fadeis a smooth ramp where the PNG has one step per pixel. - SVG files have no crop marks and no trim box; use a PDF for print. Crop marks are drawn in a white margin; there are no color bars or registration marks.
Dates and times
- Named time zones such as
Europe/Berlinare not supported. A project has one fixed offset from UTC (utc_offset, in hours), and it does not follow daylight saving time. See Time zone. - Month and day names are English only:
MMMM,MMM,ddddanddddindate_fmtwrite English names, and there is no locale setting.
Wishes
Not planned or implemented yet:
- A layer limit set in the project's files (it is set with an environment variable).
- Checking words compared with enum values in expressions.
- Emoji and color font support.
- Miter and bevel line joins.
- Mixed sizes and colors in text.
- Arguments for an
include(a component that takes values from the including group). - Card import and merge: adding cards from another file (
"import": "cards/extra.cards.json"in a card file, oryoshida import), with a rule for cards that have the same id. The open questions are whether the later file wins or the clash is error 2004, and how the editor writes a change back to the file it came from. - Output templates: naming the written files and folders (
"output": "{set}/{card.id}-{rarity}.png") instead of the fixed<out>/<set>/<card id>.png. Card ids are checked to be safe as file names for this reason, so a template would have to keep every part safe and unique, and report a clash as an error before anything is written. - Named time zones and month and day names in other languages.
These are candidates for a later 1.x or 2 format. See Limits and Versioning.
Images
- In the browser,
https://images only load when the remote server sends CORS headers. - The server does not download images at all; upload them with the project.
- The CLI downloads images; behind a TLS-intercepting proxy the download can fail. Use
--offlineand local files then.
Builder
- Layers inside a rotated group show unrotated selection boxes on the canvas.
- Groups have no resize handles; their size comes from their layers.
- Repeated layers are moved as a whole: the offset applies to every iteration. A repeated group with a
translateis moved by changing the translate. - Polygons rotate around their bounds centre, which moves when points change.
See Builder: Canvas.
Distribution
- The macOS binaries are unsigned.
start.shclears the quarantine flag; if that is not possible, Gatekeeper may ask once (right-click, Open). - On Windows, only x86_64 is prebuilt.
zig build -Dtarget=aarch64-windowsworks from source.
CLI
yoshida migrateis not implemented (there is only format 1).- There is no option to pick a design for CSV card data on the command line; list the file in a set of
yoshida.json. See Project Layout and Manifest.