About the API

The API provides a few simple yet powerful features that allow you to request an image and make any changes to that image such as rotation, size, filter effects, or combine it with other images.

The API was designed for use with Tabletop Simulator as there is currently no way to edit the assets in-game. It was created to power the Battle Atlas mod.

Current API Features

Working features:

  • Fuse: Present a single or composite tileset image.
  • single-img: Modify and display a single tileset image
  • cover-img: Generate a cover view for the BattleAtlas in-game object.

In-development features:

  • data-img: Generate a punchcard-style image of a string.

Planned features:

  • edit-img: Retrieve, manipulate and present an image to the user



Server Upgrade
Dec 21, 2017
ChangeLog API In-Game Mod Website Announcements

Battle Atlas has been moved to a new server with more resources. This should fix the recent outtages caused by the increased number of users! We have served over 100,000 maps and tiles to our users so far and the user base is ever expanding.

Devnotes 4
May 27, 2017
ChangeLog API Website

  • Improved image caching
  • Improved documentation and added {cms_selflink page="faq" text="FAQ"}
  • Added gallery of {cms_selflink page="view-playermade-creations" text="user creations"}
  • Various minor tweaks to templates for cover-img and stitch images, improved load times somewhat.
  • Adding rudimentary logging. Expect to see statistics in the future!

Devnotes 3
May 7, 2017
ChangeLog API Website

A small list of changes to the Website and API.

  • Cover images now being generated 100% automagically!
  • Tiles now cached at 100, 150, 200, 400, 800 and 1600 pixel resolutions
  • Moved all API content to GCBs for easier management
  • Tidied up Private tilesets and some misc templating

Devnotes 2
May 1, 2017
ChangeLog Website

  • Website moved to new domain
  • Website moved to new dedicated EC2 instance.
  • Fusing images now works

Devnotes 1
Apr 26, 2017
ChangeLog API Website

The first working version of the API has been released. Documentation can be found in the API section. It currently supports:

  • Drafted first version of the API.
  • Added the Tileset indexing module, see it in action on the {cms_selflink page="tilesets" text="Tilesets page"}.
  • API calls for single-image now working

API Parameters

Image IDs

An image ID consists of a two-lettter Tileset code, a 2-digit tile code, and a single-digit rotational value.

Example: i = wl1 012 03

  1. Tileset Code
    A unique two-letter, alpha-numeric, case-sensitive ID of the desired tileset (see list).
  2. Image ID
    The ID of the image in the tileset. Starting at 00, up to as many tiles as are in that Tileset (see list).
  3. Rotation
    Single-digit integer specifying the rotation value. 0-3 are 0°->270° counter-clockwise rotation, 4-7 are a mirrored version.

Stitch image arrays

The stitch function takes an array of images to be combined, in the format of image ID's separated by an underscore _

Example: a=wl010_wl020_wl030

X-Axis