Skip to content
AtsuraeDownload

Development sign-in

Only on a local server with DEV_AUTH. Enter any account name.

Format versions

Every widget declares the format it’s written in with formatVersion. Atsurae reads every format up to the newest it knows, and refuses newer ones with a message asking to update Atsurae.

Old formats keep working: a format 1 widget is a valid format 2 widget.

The current format.

  • Element types: type can be image, shape or progress, alongside text (the default).
    • Images: src, size, tint, cornerRadius
    • Shapes: shape, size, fill, stroke, strokeWidth, cornerRadius
    • Progress: style, value, size, lineWidth, track
  • Packages: .atsuraewidget folders with widget.json, a script, images/ and fonts/.
  • Scripts: script with file and updateEvery; {script.*} tokens.
  • Tokens: lastTrack, lastArtist, battery.level, cpu.level, memory.level, memory.total, day.progress, week.progress, month.progress, year.progress, and weather.*.
  • Modifiers: percent and round, alongside upper and lower.
  • visibleWhen also accepts a token ("{track}").
  • Colors accept #RRGGBBAA.
  • Fields: author, version, $schema.
  • text is optional for non-text elements, and font is optional for text (system font, size 0.02).

The first format, used by the built-in widgets.

  • Text elements with tokens, font (family, weight, size), tracking, color, opacity, shadow, offset, alignment, visibleWhen (option=value) and hideWhenEmpty.
  • Options: toggle, text and choice.
  • Tokens: dates and times, date:pattern, battery, batteryState, cpu, memory, track, artist, text; modifiers upper and lower.