Skip to content
AtsuraeDownload

Development sign-in

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

Wallpaper packages

A wallpaper shared in the community is one .atsuraewallpaper file: a zip holding its background, its widgets and where they sit. Atsurae makes it for you when you upload a wallpaper; you never need to build one by hand. This page describes what’s inside.

manifest.json
background.mov ← or .mp4, .jpg, .png, .heic, .webp
widgets/1/widget.json ← one folder per widget, numbered
widgets/1/script.js
widgets/1/images/…
widgets/2/widget.json
…

Each widgets/<n>/ folder is a complete widget package, the same files as an .atsuraewidget folder.

{
"formatVersion": 1,
"background": {
"file": "background.mov",
"kind": "video",
"contentType": "video/quicktime",
"width": 3840,
"height": 2160,
"durationSeconds": 20
},
"widgets": [
{
"id": "time",
"folder": "widgets/1",
"placement": { "enabled": true, "x": 0.62, "y": 0.578, "scale": 1, "color": "#FFFFFF", "options": {} }
}
]
}
Field Meaning
formatVersion Always 1.
background.file background. plus the file’s extension.
background.kind video or image.
background.contentType video/quicktime (.mov), video/mp4 (.mp4), image/jpeg (.jpg, .jpeg), image/png, image/heic or image/webp.
background.width, height, durationSeconds Optional. The video’s length is shown in Discover.
widgets[].id The id in that folder’s widget.json.
widgets[].folder widgets/<n>.
widgets[].placement Where the widget sits, as in Customize Widgets: x and y are fractions of the screen’s width and height (0 to 1, measured from the top left), scale multiplies its size (0.1 to 10), color is #RRGGBB or null for the widget’s own colors, options holds values for its options, and enabled says whether it’s on.
  • The background must be stored in the zip, not compressed. (Videos and pictures are already compressed, and it lets Discover stream previews straight from the package.)
  • Backgrounds can be up to 100 MB for videos and 25 MB for pictures. All widget files together can be up to 10 MB, with at most 12 widgets.
  • Only manifest.json, the background and widgets/ folders listed in the manifest can be in the package. No other files, no __MACOSX folders, no zip64.