ad.ari.lt/docs/image-index-format.md
Arija A. 4c560d1490
Add docs image format example
Signed-off-by: Arija A. <ari@ari.lt>
2026-05-11 00:28:34 +03:00

1.3 KiB

Image index format

If you don't want to use the upstream images for Arivertisements and want to spin up your own instance, you can build your own image index for your own uses. The image index should include:

  • An index.json file.
  • An img/ directory.

The index.json file includes a JSON array of objects following values:

  • filename: the filename of the image.
  • alt: alternative text of the image.
  • to: where to take users on click (optional).
  • author: name/id/etc. of the author.
  • contact: base85-encoded email of the author.
  • bg: background colour of the banner embed (optional).
  • fg: foreground colour of the banner embed (optional).
  • timestamp: the first UNIX epoch timestamp (float) when the image was added to the index.
  • license: the license of the image (SPDX license ID or alike).

For example:

 {
  "filename": "horse.png",
  "alt": "Horsing around",
  "to": "https://meow.local/",
  "author": "Silly Kitty",
  "contact": "VRC68VR...",
  "bg": "#0c0a0b",
  "fg": "#ea7405",
  "timestamp": 1756739056.0,
  "license": "CC BY-NC-SA 4.0"
 },
 {
  "filename": "mewomoemwoew.jpg",
  "to": "https://example.com/",
  "alt": "Silly kitty",
  "author": "Jonathan Horse",
  "contact": "Zeet2V...",
  "fg": "#000000",
  "bg": "#ffdbf0",
  "timestamp": 1763142152.0,
  "license": "All Rights Reserved"
 },
 ...
]