53 lines
1.5 KiB
Markdown
53 lines
1.5 KiB
Markdown
# ChaChaGameStats
|
|
|
|
## Overview
|
|
This library aim to make games's statistics reading easier.
|
|
It allow dev to declare games list and stats interfaces.
|
|
|
|
**Supported games are (atm) :**
|
|
|
|
| Game family | shortname |
|
|
| --- | --- |
|
|
| CallOfDuty serie: | *cod4, cod5, codmw3, codbo2* |
|
|
| Quake serie: | *q2, q3a* |
|
|
| Unreal Tournament serie: | *ut99, ut2k4, ut3* |
|
|
| Crysis serie: | *cry1* |
|
|
| Minecraft: | *mc* |
|
|
|
|
|
|
**Statistics interfaces are:**
|
|
1. QuakeStat: for every supported games (atm)
|
|
2. RCON:
|
|
- source RCON: quake and CallOfDuty serie
|
|
- http/web: Unreal Tournament serie
|
|
- xmlrpc: Crysis serie
|
|
- minecraft tcp rcon
|
|
|
|
## History
|
|
This lib was created for my game service: https://chacha.ddns.net.
|
|
I am sharing it in case it help other people doing the same.
|
|
|
|
## License
|
|
License is **Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International (CC BY-NC-SA 4.0)**
|
|
Refer to License file in this repository or https://creativecommons.org/licenses/by-nc-sa/4.0/
|
|
|
|
## State
|
|
This library is still in beta-developpment and will be upgraded.
|
|
It might gain some other functionnality like game cmd/ctrl (changemap, say ..etc)
|
|
It also might gain a remote parser feature to allow more game stats
|
|
|
|
## Installation
|
|
`pip install git+https://github.com/cclecle/ChaChaGameStats`
|
|
|
|
## Usage
|
|
see [Sample.py](https://github.com/cclecle/ChaChaGameStats/blob/master/sample.py)
|
|
|
|
## TODO before V1
|
|
- [ ] Unitary Test
|
|
- [ ] better log (logr)
|
|
- [ ] API doc
|
|
- [X] rework imports
|
|
- [X] write Setup.py
|
|
|
|
More comming, to see how to use check sample.py
|