jmhobbs / vigrid-server-listing Goto Github PK

View Code? Open in Web Editor NEW

Alternative server listing for VIGRID DayZ Battle Royale, with notifications on server restart.

License: MIT License

Go 29.93% HTML 3.87% JavaScript 59.73% Makefile 0.22% CSS 1.83% Shell 4.41%

vigrid-server-listing's Introduction

VIGRID Server Monitor

This is a setup to add notifications when VIGRID Battle Royale servers restart.

It is vastly over architected, because that is half the fun.

Design

     ┌────────────┐        ┌──────────────┐
     │            │        │              │
┌────│   Poller   │◀───────│  vigrid.ovh  │
│    │            │        │              │
│    └────────────┘        └──────────────┘
│           │
│           │                     ┌────────────────────────────────────────┐
│           │                     │                Browser                 │
│           ▼                     │                                        │
│  ┌─────────────────┐            │                   ┌──────────────────┐ │
│  │                 │            │                   │                  │ │
│  │      nchan      │───────┐    │                ┌─▶│   Server List    │ │
│  │                 │  Websocket │                │  │                  │ │
│  └─────────────────┘       │    │  ┌───────────┐ │  └──────────────────┘ │
│                            ├────┼─▶│  Monitor  │─┤                       │
│  ┌─────────────────┐       │    │  └───────────┘ │  ┌──────────────────┐ │
│  │                 │    fetch   │                │  │                  │ │
└─▶│  servers.json   │───────┘    │                └─▶│  Notifications   │ │
   │                 │            │                   │                  │ │
   └─────────────────┘            │                   └──────────────────┘ │
                                  │                                        │
                                  └────────────────────────────────────────┘

Poller

Poller fetches the server information from vigrid.ovh every 5 seconds. It does some work to convert to the format we use, then writes it to a file, servers.json. It takes the previous state and diffs it with the new state, generating update messages. These are published to nchan, which sends them out over websocket to browsers.

In the browser we get initial state from servers.json, then begin watching for updates over the websocket connection.