lazzexus/Kafkatorio
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

readme tweaks

Browse source
This commit is contained in:
Adam 2022-10-30 18:53:21 +01:00
parent 76a661e444
commit c54481010a
1 changed files with 16 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

24
README.md
View file

@ -2,22 +2,30 @@
[Kafkatorio](https://github.com/adamko-dev/kafkatorio) is a platform used for creating [Kafkatorio](https://github.com/adamko-dev/kafkatorio) is a platform used for creating
[Factorio](https://www.factorio.com/) mods that require communication with an external server. [Factorio](https://www.factorio.com/) mods that require communication with an external server.
It was created to explore the possibilities of using [Apache Kafka](https://kafka.apache.org/)
to process updates from a Factorio server.
Kafkatorio receives updates from a Factorio server, processes them, and exposes them over a REST Development is ongoing.
and WebSocket APIs.
Development is ongoing. At present the only application is a At present Kafkatorio is used to create a [live-view web map](https://factorio.adamko.dev), that
[live-view web map](https://factorio.adamko.dev), that shows the current status of a Factorio shows the current status of a Factorio server, and any connected players.
server, and any connected players. Other usage possibilities include exposing live metrics, and
inter-server communication. However, Kafkatorio can be used for more than this. It has the potential to export metrics, and
allow for inter-server communication.
Kafkatorio was created to explore the possibilities of using
[Apache Kafka](https://kafka.apache.org/) to process updates from a Factorio server.
### Running
[Instructions for running a Kafkatorio instance are available in the docs](./docs/guide.md).
### Overview ### Overview
This is a brief overview of how Kafkatorio gathers data, processes it, and uses it to create the This is a brief overview of how Kafkatorio gathers data, processes it, and uses it to create the
live web-map. live web-map.
Kafkatorio receives updates from a Factorio server, processes them, and exposes them over a REST
and WebSocket APIs.
1. The Kafkatorio game mod, [`events-mod`](./modules/events-mod), collects event data, de-bouncing 1. The Kafkatorio game mod, [`events-mod`](./modules/events-mod), collects event data, de-bouncing
and grouping events, and converts them to JSON packets and grouping events, and converts them to JSON packets
2. `events-mod` prints the packets to the Factorio game server logs 2. `events-mod` prints the packets to the Factorio game server logs