Skip to content

Webpage for showing various stats from the Apollo Station game database

License

Notifications You must be signed in to change notification settings

Artemis-Community/ApolloStats

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ApolloStats

Webpage for showing various stats from the Apollo Station SS13 game database. With heavy inspiration from other servers' webpages such as Goon and /vg/station.

Requires a running Mysql/MariaDB server with the game's database.

Installation

Compile time dependencies

Build tool for embedding assets:

Compilation

Download the source code

go get -u github.com/Apollo-Community/ApolloStats

Or from a zipped archive.

Go to the directory with the unpacked source code and run make build to compile the code to a stand alone binary, called ApolloStats64.

See the Makefile for more options.

Usage

$ ApolloStats -h
NAME:
   main - Run a web server, serving stats for Apollo.

USAGE:
   main [global options] command [command options] [arguments...]
   
VERSION:
   0.3
   
COMMANDS:
   run          Run the web server
   help, h      Shows a list of commands or help for one command
   
GLOBAL OPTIONS:
   --addr, -a "127.0.0.1:8000"                  serve web pages on this address [$APOLLOSTATS_ADDR]
   --database, -d "user:password@/database"     database authentication string [$APOLLOSTATS_DBAUTH]
   --debug                                      run in debug mode
   --help, -h                                   show help
   --version, -v                                print the version

Environment variables

You can set some environment variables instead of using the command line flags.

$ export APOLLOSTATS_ADDR="127.0.0.1:8000"
$ export APOLLOSTATS_DBAUTH="user:password@/database"
$ ./ApolloStats --debug run

License

MIT License, see the LICENSE file for details.

TODO

Info:

  • Clarify that there are never info from a currently running round.
  • Clarify total deaths.

Templates:

  • Need to remake the custom CSS and make the pages prettier.
  • Change the colors used in css.

Rounds:

  • Show player death graph over round's duration.

Heat maps:

  • Really nice if we could show a heatmap of deaths.
  • Ask @HiddenKn how he made his python version.

Game map:

  • Huge, zoomable map of the main station (only).
  • Store the map as picture tiles?
  • Investigate how goon made their map.
  • Need to rebuild the map after any new map changes from a commit.

Tests:

  • Must do unit tests.

About

Webpage for showing various stats from the Apollo Station game database

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Go 70.2%
  • HTML 23.6%
  • CSS 5.4%
  • Makefile 0.8%