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> |
||
|---|---|---|
| buildSrc | ||
| docs | ||
| gradle | ||
| gradle-plugins | ||
| modules | ||
| .gitignore | ||
| build.gradle.kts | ||
| gradle.properties | ||
| gradlew | ||
| gradlew.bat | ||
| kt52647.gradle.kts | ||
| LICENSE | ||
| README.md | ||
| settings.gradle.kts | ||
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
- 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. - 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. events-processorsuses Kafka Streams to turn the packets into map tiles, buildings, resource patches, and so on.events-server-webserves the tiles and the other data over a REST API, and pushes live updates (such as players moving) over a WebSocket.web-mapis the website (Kotlin/JS, with Leaflet for the map). Its nginx also forwards/kafkatorio/toevents-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.