67 lines
2.3 KiB
Markdown
67 lines
2.3 KiB
Markdown
# TeamspeakStats [](https://travis-ci.org/Thor77/TeamspeakStats) [](https://coveralls.io/github/Thor77/TeamspeakStats?branch=master) [](https://landscape.io/github/Thor77/TeamspeakStats/master) [](https://requires.io/github/Thor77/TeamspeakStats/requirements/?branch=master)
|
|
A simple Teamspeak stat-generator - based on server-logs
|
|
|
|
|
|
|
|
# Installation
|
|
- Install a supported [Python](https://python.org)-version (`2.7`, `3.x`)
|
|
- Clone this repo `git clone https://github.com/Thor77/TeamspeakStats`
|
|
- Install requirements `pip3 install -r requirements.txt`
|
|
|
|
# Usage
|
|
- Create a config (see [Configuration](https://github.com/Thor77/TeamspeakStats#configuration))
|
|
- Run the module `python -m tsstats`
|
|
|
|
# Tests
|
|
- Install testing-requirements `pip install -r testing_requirements.txt`
|
|
- Run `py.test tsstats/`
|
|
|
|
# CMD-Arguments
|
|
```
|
|
usage: python -m tsstats [-h] [--config CONFIG] [--idmap IDMAP] [--debug]
|
|
|
|
A simple Teamspeak stats-generator - based on server-logs
|
|
|
|
optional arguments:
|
|
-h, --help show this help message and exit
|
|
--config CONFIG path to config
|
|
--idmap IDMAP path to id_map
|
|
--debug debug mode
|
|
```
|
|
|
|
# Configuration
|
|
|
|
#### [General]
|
|
| Key | Description |
|
|
|-----|-------------|
|
|
| log | Path to TS3Server-logfile(s) (supports [globbing](https://docs.python.org/3/library/glob.html)) |
|
|
| output | Path to the location, where the generator will put the generated `.html`-file |
|
|
|
|
#### [HTML]
|
|
| Key | Description |
|
|
|-----|-------------|
|
|
| title | HTML-Title of the generated `.html`-file
|
|
|
|
|
|
## Example
|
|
```
|
|
[General]
|
|
log = /usr/local/bin/teamspeak-server/logs/ts3server*_1.log
|
|
output = /var/www/html/stats.html
|
|
```
|
|
|
|
# ID-Mapping
|
|
`id_map.json`
|
|
You can map multiple ID's to one (for example, when an user creates a new identity)
|
|
## Example
|
|
```json
|
|
{
|
|
"1": "2",
|
|
"3": "2"
|
|
}
|
|
```
|
|
The online-time of `1` and `3` will be added to the online-time of `2`
|
|
|
|
# TODO
|
|
- Localization
|