Finally managed to update the README
This commit is contained in:
parent
64379d647d
commit
60ab5a55d2
58
README.md
58
README.md
@ -7,59 +7,44 @@ server page at [Byond](https://www.byond.com/games/exadv1/spacestation13).
|
||||
Status
|
||||
--------------------------------------------------------------------------------
|
||||
|
||||
***In the cloner***
|
||||
***Beta mode live at [www.ss13.se](https://www.ss13.se/)***
|
||||
|
||||
Please note that the code is still in a **experimental stage** at this time and
|
||||
there is still a lot of work to be done before it's ready for production use.
|
||||
The code has ben run in production for some months now and seems to be stable
|
||||
enough. I guess we're now back in beta?
|
||||
|
||||
Features For Players
|
||||
--------------------------------------------------------------------------------
|
||||
|
||||
- A friendlier server list.
|
||||
|
||||
- Detailed pages for most public servers.
|
||||
|
||||
- Player count stats and graphs.
|
||||
|
||||
- Dedicated pages for each public server, with more detailed info.
|
||||
|
||||
- Pages for private servers too, upon request.
|
||||
|
||||
Features for server Owners
|
||||
--------------------------------------------------------------------------------
|
||||
|
||||
TODO
|
||||
- Predict when it's a "good" time for you to play.
|
||||
|
||||
Data Source
|
||||
--------------------------------------------------------------------------------
|
||||
|
||||
The data used for most of the **public** servers is scraped from the [Byond](http://www.byond.com/games/exadv1/spacestation13) page.
|
||||
The data used for 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).
|
||||
Since bad hosts and owners can spoof a server's reported player count, there's
|
||||
no way to guarantee that the calculated stats and graphs are 100% correct.
|
||||
|
||||
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 game.
|
||||
|
||||
But then again it's just some silly numbers for a bunch of games.
|
||||
|
||||
Add new private server
|
||||
Missing a server?
|
||||
--------------------------------------------------------------------------------
|
||||
|
||||
If you would like to add your server to the private list, and accept being polled
|
||||
about 4 times an hour, please open a [new ticket](https://github.com/lmas/ss13_se/issues/new)
|
||||
on the issue tracker on github.
|
||||
Since we're scraping only **public** servers, we're missing any **private** that's
|
||||
hidden from the Byond page (I also discarded the poller, so no more polling
|
||||
**private** servers from a VIP list).
|
||||
|
||||
Please provide the following info for your server and write it in your new ticket:
|
||||
|
||||
Title - The public title of your server.
|
||||
Game URL - The publicly open address to the game server.
|
||||
Site URL - The address to your server's web page, if you have one.
|
||||
|
||||
See the file `TODO` for examples.
|
||||
We also see a lot of **public** servers coming and going, or merely changing
|
||||
names a lot. So any servers that hasn't been seen for 3 days, or more, will be
|
||||
automagically removed from the list.
|
||||
|
||||
License
|
||||
--------------------------------------------------------------------------------
|
||||
@ -78,7 +63,14 @@ Credits
|
||||
Todo
|
||||
--------------------------------------------------------------------------------
|
||||
|
||||
- Missing tests (a must have for the scraper and poller).
|
||||
- Missing tests.
|
||||
|
||||
- Missign the favicon.
|
||||
|
||||
- Add about page (redirect to github).
|
||||
|
||||
- Add graph showing next week's predicted player count for all servers?
|
||||
|
||||
- Investigate more options for prediction.
|
||||
|
||||
- Investigate community approval of tracking public members (visited servers, play time, predictions)?
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user