diff --git a/README.md b/README.md index cdaf0d0..870330e 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,6 @@ -Space Station 13 Hub +[Space Station 13 Hub](http://www.ss13.se/) ================================================================================ -http://www.ss13.se/ - A server hub dedicated to SS13 and possibly a better replacement for the default server page at [Byond](http://www.byond.com/games/exadv1/spacestation13). @@ -17,6 +15,25 @@ Features - Player count stats and graphs. +Data Source +-------------------------------------------------------------------------------- +The data used for most of the **public** servers is scraped from the [Byond](http://www.byond.com/games/exadv1/spacestation13) page. +Relying on Byond means we're affected by their server downtime (no page, no data), +but we will automatically discover any new public servers. + +All **private** servers, and some public ones, are being polled directly for data. +That means a list of private servers have to be maintained manually, but we're +not affected by any downtimes (as long as the game servers themselves are up +and running). This is usually a more reliable method, but it's more expensive to +run since we have to send multiple network requests (instead of one to Byond). + +Both methods can be affected by spoofing attacks, done by bad servers, and so +there's no way to guarantee that the calculated stats and graphs are 100% correct. + +But then again it's just some silly numbers for a bunch of games. + + + License -------------------------------------------------------------------------------- MIT License, see the LICENSE file. @@ -36,28 +53,29 @@ Todo **Bugs** -- better colors for warn/offline servers +- Better colors for the warning/offline server notices. **New features** -- page to send in requests to add new private servers? +- Show note about data source for each server (scraped/polled). -- show note about data source for each server (byond, server poll) +- Rewrite the whole update script to go. -- summary page showing total stats for all servers: - - # online/warn/offline servers + graphs - - total/average # of online players + graphs - - log of recently added/removed servers - - the # of data points since start - - age of oldest data point +- Summary page showing overall stats for all servers: - time since since latest update - time to run update + - no. of online/warn/offline servers + graphs + - total/average no. of online players + graphs + - log of recently added/removed servers + - the no. of data points since start + - age of oldest data point? -- player growth rate for each server? +**Suggestions** -- frontpage of some sort +- Frontpage of some sort? -- about page and move notices about byond etc. to that page +- Page to send in requests to add new private servers? -- logo? +- Player growth rate for each server (+/- compared to avg.)? +- Use some kind of banner/logo?