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

add/update docs

Browse source
This commit is contained in:
Adam 2022-10-30 17:21:32 +01:00
parent b9ad7e2466
commit 5bb8cc789c
7 changed files with 361 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

33
README.md
View file

@ -15,21 +15,8 @@ inter-server communication.
### Overview
```mermaid
sequenceDiagram
Factorio multiplayer server->>events-mod: in-game events
Note over events-mod: converts events to packets
events-mod->>logs processor: packets logged to console
logs processor->>Kafka: publishes packets<br/>(Requires API key!)
Kafka->>events-server:
Note over events-server: Packets are processed
events-server->>web-map: Web map tiles (REST API)
events-server-)web-map: WebSocket updates<br/>(e.g. player movement)
```
This is a brief overview of how Kafkatorio gathers data, processes it, and uses it to create the
live web-map.
1. The Kafkatorio game mod, [`events-mod`](./modules/events-mod), collects event data, de-bouncing
and grouping events, and converts them to JSON packets
@ -47,6 +34,22 @@ events-server-)web-map: WebSocket updates<br/>(e.g. player movement)
5. The `web-map` uses Leaflet/JS to display the map, using the tiles and WebSocket messages from
`events-server`
```mermaid
sequenceDiagram
Factorio multiplayer server->>events-mod: in-game events
Note over events-mod: converts events to packets
events-mod->>logs processor: packets logged to console
logs processor->>Kafka: publishes packets<br/>(Requires API key!)
Kafka->>events-server:
Note over events-server: Packets are processed
events-server->>web-map: Web map tiles (REST API)
events-server-)web-map: WebSocket updates<br/>(e.g. player movement)
```
## License
While this project is under development, [no license](https://choosealicense.com/no-permission/)