q3stats

README

Quake 3 Stats Server

Building

Clone the code somewhere (go get .. works too):

go get github.com/bboozzoo/q3stats

Unfortunately the code will not be built during go get as the default build process is limited.

Fetch all dependencies and required tools (esc) by running make get-deps. Make sure that your GOPATH is set properly before running the command.

The main server binary and helper tools are built by running make. The server binary (q3stats) is self contained, all static data is embedded directly into the binary itself during the built.

You can also run make packed to pack the binaries with UPX (make sure that upx is available).

Usage

Server

First start the server process:

q3stats [--help]

The daemon will open port 9090, use your browser to access http://localhost:9090 The listen address can be changed by settin --listen in command line.

The deamon exports an API and provides a nice web view of your stats.

The DB is saved to q3stat.db file in local directory by default. Use --db switch to override its location. Daemon uses a SQLite database, feel free to explore the data manually.

Data Import

Match data from CPMA is imported using q3simport command. The command will upload the match statistics to the server. If server is running on another host/port, the address can be passed by adding -t <host>:<port> in command line.

Example:

./q3simport matchdata/stats/2016/02/29/14_18_42.xml

The import tool is intentionally built as a separate program (and lives under cmd/q3simport in the source tree). The for that is the tool has very little (no) dependencies outside of Go's stdlib, especially does not use cgo or link with external C libraries. This allows for cross compiling q3simport to other architectures with ease.

License

MIT

Documentation

Overview

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.