tunefish92/factoriomaprenderer repository overview

⁠Factorio Map Renderer

An interactive map of your Factorio save game, from a file, your server's saves folder or over SSH.

Every planet and space platform on a zoomable map: zoomed out in the colours of the game's map view, zoomed in in the game's own graphics and ground textures, plus the solar system with every planet and platform. The factory (buildings, belts, pipes, rails, power), resources and patches, enemy bases, players, train stops, map tags and production statistics, with search and click-to-inspect and the game's alt mode. One container renders the map and serves it.

Source, full documentation and issues: https://github.com/Tunefish92/FactorioMapRenderer⁠

⁠Quick start with Docker Compose

Save this as docker-compose.yml, set a password, and run docker compose up -d:

services:
  map:
    image: tunefish92/factoriomaprenderer:latest
    restart: unless-stopped
    environment:
      # Required, at least 8 characters. A "$" in the password must be written as "$$" here.
      FMR_ADMIN_PASSWORD: change-me-please
    ports:
      - "8080:8080"
    volumes:
      - ./map-data:/data
      # Optional, read-only: your Factorio server's saves, for the "Folder" source.
      # - /path/to/factorio/saves:/saves:ro

Open http://localhost:8080/, click Admin login in the Save game tab of the side panel, and choose the save game:

• Browse / drag and drop a save .zip.
• Folder: the newest save in a folder, e.g. your server's saves mounted at /saves.
• SSH: user@host and the path of the save file or save folder. Put the private key into map-data/home/.ssh/.
• Game server (RCON), together with a folder or SSH: the running game is saved first, and a Server tab shows the server's state.

For the folder and SSH sources a Refresh snapshot button fetches and renders the current state again. Visitors who are not logged in only see the map.

⁠Game data and your own game

The image works out of the box: it brings Factorio's free headless server, which reads the saves, and the game's icons, names, map colours, sprites, ground textures and star map, exported from Factorio 2.1.23 with Space Age. For a save newer than that, a newer headless server is downloaded from factorio.com once per version (switch it off with FMR_DOWNLOAD_HEADLESS=false). Mods from the mod portal go into map-data/mods/ as zip files. The headless server in the image is x86-64 only; on ARM machines, mount a Factorio for ARM at /game.

Reads saves from Factorio 1.0 on; tested up to 2.1.24. Saves of newer versions most likely work and are marked as untested on the map.

⁠Settings

The container speaks plain HTTP on port 8080. To reach it from the internet, put it behind a reverse proxy that adds HTTPS, so the admin password is not sent unencrypted.

Not affiliated with or endorsed by Wube Software; the game's icons and graphics included in the image are their property.