No description
Find a file
Lazzexus a6be36df2e Rewrite the README and setup guide, and fix the example Compose setup
The README describes what Kafkatorio does now (the live map, production
and research pages), that this is a Factorio 2.0 fork, and how the
services fit together.

The guide is rewritten as numbered steps, from building the images to a
public website: configuration, creating the server's token locally
(instead of typing the secret into jwt.io), connecting the Factorio
server's log, sending the existing map, exporting icons and names, and
the reverse proxy. Also: the Unraid setup, updating, and troubleshooting.

It warns that the mod portal's kafkatorio-events is the original, for
Factorio 1.1, with overlapping version numbers, so players must install
the mod zip by hand.

The example docker-compose.yml lost all data when containers were
recreated (e.g. on every update), and exposed Kafka, which has no
authentication, on all interfaces. It's now based on the Unraid setup:
Kafka data, map tiles, state and icons are kept next to it, only the
website is exposed, and the optional Factorio server (--profile factorio)
starts after the syslog server.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-22 10:36:01 +01:00
buildSrc Gradle 7.6 2022-12-05 23:18:00 +01:00
docs Rewrite the README and setup guide, and fix the example Compose setup 2026-11-22 10:36:01 +01:00
gradle Remove dead kotlinx-nodejs dependency from web-map 2026-10-12 15:46:04 +02:00
gradle-plugins Fix Docker image builds and local platform setup 2026-10-12 17:27:11 +02:00
modules Make browsers check for a new web map on every load 2026-11-22 10:26:40 +01:00
.gitignore migrate buildSrc plugins to includedBuild plugins 2022-09-18 20:49:32 +02:00
build.gradle.kts Gradle 7.6 2022-12-05 23:18:00 +01:00
gradle.properties set org.gradle.jvmargs 2022-10-15 23:53:33 +02:00
gradlew Gradle 7.6 2022-12-05 23:18:00 +01:00
gradlew.bat Gradle 7.6 2022-12-05 23:18:00 +01:00
kt52647.gradle.kts add 'skip worktree' example command 2022-12-05 23:21:29 +01:00
LICENSE update license to be gpl-3.0 2022-10-30 18:58:50 +01:00
README.md Rewrite the README and setup guide, and fix the example Compose setup 2026-11-22 10:36:01 +01:00
settings.gradle.kts big ol' refactor of the Gradle Factorio Mod 2022-12-18 01:41:14 +01:00

Kafkatorio

Kafkatorio streams what happens on a Factorio server to Apache Kafka, and turns it into a live website for the server:

  • Map – a live map of every surface, with terrain, resource patches (with their size or number of wells), buildings (with their direction and recipe), belts, and players moving in real time.
  • Production – what's produced and consumed per minute, and science packs used, over the last 10 minutes up to the last 7 days, for all surfaces or one.
  • Research – what's researched, the current research and queue, and how many science packs are left. Shown as a filterable list, or as a tree like the game's technology screen.

It's built for Factorio 2.0, and works with large mod packs (it's used with Space Exploration and Krastorio 2).

This is a fork of adamko-dev/kafkatorio, updated for Factorio 2.0, with the production and research pages and many fixes.

Running it yourself

You need a Factorio server running in Docker, and a machine to build the images on. The guide covers building, configuring, connecting the Factorio server, and putting the website behind a reverse proxy, with a ready-made setup for Unraid.

How it works

flowchart LR
  factorio["Factorio server<br/>+ kafkatorio-events mod"]
  syslog[events-server-syslog]
  kafka[(Kafka)]
  processors[events-processors]
  web[events-server-web]
  map["web-map<br/>(nginx)"]
  browser([Browser])

  factorio -- "packets in the server log<br/>(Docker syslog log driver)" --> syslog
  syslog -- "checks the server's token" --> kafka
  kafka <--> processors
  kafka --> web
  web -- "REST + WebSocket" --> map
  map --> browser
  1. The mod, events-mod (written in TypeScript, compiled to Lua), listens to in-game events, groups and de-bounces them, and prints them as JSON packets to the server log.
  2. Docker's syslog log driver forwards the Factorio container's log to events-server-syslog. Each server's log is tagged with a token (a JWT), so only known servers are accepted. The packets go to a Kafka topic.
  3. events-processors uses Kafka Streams to turn the packets into map tiles, buildings, resource patches, and so on.
  4. events-server-web serves the tiles and the other data over a REST API, and pushes live updates (such as players moving) over a WebSocket.
  5. web-map is the website (Kotlin/JS, with Leaflet for the map). Its nginx also forwards /kafkatorio/ to events-server-web, so the whole site is on a single port.

The packet format is defined once in events-library (Kotlin), which also generates the mod's TypeScript types.

Building

./gradlew build                 # build and test
./gradlew :modules:events-mod:distZip
                                # the mod: modules/events-mod/build/distributions/

See the guide for building the Docker images.

License

Kafkatorio is licensed under the GNU General Public License v3.0.