PlanetSide 2 Map API

Unofficial PlanetSide 2 API for map-oriented applications.

For information on the PlanetSide 2 map system and details on how to utilise the provided data, please refer to the repository Wiki.

This project has no affiliation with the PlanetSide 2 development team or Daybreak Game Company LLC.

Overview

The following section provides a brief overview of its components and their uses.

• data/  A static collection of map data for development purposes. Only to be used for development purposes; does not contain lattice link data of any sort.

  Note: This endpoint is tentative and will be removed/reworked in future releases.

• public/  Static game assets hosted by the API server. This includes facility outline polygons in SVG format (hex subdirectory), full-continent minimap textures (minimap subdirectory), as well as map tiles for all zones (tiles subdirectory).

• server/  A Python FastAPI server for hosting the development data stored in this repository.

• tests/  Unit tests for the FastAPI server.

• tools/  Assorted scripts and utilities used for maintenance of the repository and associated apps. See the directory's README for details on the available scripts.

Local Dev Version

This version runs locally with no database or other setup needed. Clone this repo and run the following command to host the frontend testing data:

python -m server

In the local dev version, the API will be hosted at http://127.0.0.1:5000.

Documentation

After launching the API host, a ReDoc documentation site will be hosted alongside the API at http://127.0.0.1:5000/docs.

Static File Endpoint

In addition to the REST API, the API server also hosts a number of static assets used to display the game map. These are not covered by the REST API and are instead listed below.

API consumers are also expected to aggressively cache these items due to their large size and frequent access.

Map Tiles

The map is broken up into tiles of different qualities. This is referred to as the LOD (level-of-detail), with 0 being the highest quality available (8192 px) and higher LOD values halving resolution with each increment; currently the lowest resolution is LOD level 3 (1024 px).

For additional information on the map tile format used by the game and implementation examples, please refer to the repository Wiki page on this topic: Map Tile Format

Map Hexes

The map hexes are stored in a single SVG file with all base outlines having their own path. The SVG view box has no offset and a size of 8192 pixels.

Each base outline is stored as a polygon whose id matches that of the base it represents.

The path syntax for accessing map hexes is as follows:

/static/hex/<code>.svg

Example:

/static/hex/amerish.svg

Map hexes are provided in two formats. The regular files use standard W3 SVG v1.1 headers, the -minimal variants only contain geometry data. The latter are to be used for automatic inlining into HTML documents.