<aside> 💡 This document is public!

</aside>

See first for API usage: Gather HTTP API Gather Websocket API

The best way to learn this is to make some stuff in the mapmaker and inspect that map data that comes out of the API. But here's some incomplete documentation that might help:

objects

Images drawn over the background and below the characters. Can change appearance (i.e. glow) when you get close. Press x to interact with them when close enough. This can trigger a variety of effects (see various types below).

Currently, they are rendered in sorted order by key, but we hope to upgrade this soon.

fields required for all objects

normal: a link to an img src for how the object should show up when you're not within interaction range

highlighted: a link to an img src for how the object should show up when you are within range (and this is the closest object)

width: the width of the image (pixels wide / 32)

height: the height of the image (pixels tall / 32)

x: the x coordinate of the top left corner

y: the y coordinate of the top left corner

type: 0-7. see below

additional optional fields

TODO

object types and their properties

type 0 - non-interactive

Highlighted image not required