Files
aostats-custom/README.md
T
Wiktor Mazur f8e1dd0ec3 + cargo make
2019-10-06 17:09:38 +02:00

77 lines
2.3 KiB
Markdown

<p align="center">
<img src="assets/albion-stats-icon.png" width="100">
</p>
Albion Online Stats
===================
Albion online stats is an extension to MMORPG game - Albion Online. It tracks network traffic and displays various statistics, such as damage and DPS meter calculated from in-game actions.
## Donate
[![Become a patron](https://c5.patreon.com/external/logo/become_a_patron_button.png)](https://www.patreon.com/wiktormazur)
## Is This Allowed
```Our position is quite simple. As long as you just look and analyze we are ok with it. The moment you modify or manipulate something or somehow interfere with our services we will react (e.g. perma-ban, take legal action, whatever```
~MadDave, Technical Lead at Sandbox Interactive for Albion Online, [source](https://forum.albiononline.com/index.php/Thread/51604-Is-it-allowed-to-scan-your-internet-trafic-and-pick-up-logs/?postID=512670#post512670)
* copied from [Albion Online Data](https://www.albion-online-data.com/)
# Usage of built release
## Installation
1. On windows https://www.winpcap.org/ is required to be able to listen to network interface
2. Download latest release from https://github.com/mazurwiktor/albion-online-stats/releases/latest (.exe for windows .tar for linux and mac)
3. Enjoy :)
## Configuration
After first execution the app is going to create default configuration file named `albion-online-stats.cfg`. Feel free to edit it according to your needs.
# Getting started
## Prerequisites
- Rust installed (https://www.rust-lang.org/tools/install)
- Python installed
- cargo make installed https://github.com/sagiegurari/cargo-make#installation
- *Windows only prerequisites* https://github.com/libpnet/libpnet#windows
## All platforms
1. Clone repository:
```shell
git clone https://github.com/mazurwiktor/albion-online-stats.git
```
2. Build rust library
```shell
cargo build --release
```
3. Run GUI
3.1 on Linux
```shell
sudo python gui/meter.py
```
3.1 on Windows
```shell
python gui/meter.py
```
# License
Licensed under either of
* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
* MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
at your option.