Files
aostats-custom/README.md
T
2020-03-31 20:27:11 +02:00

103 lines
3.4 KiB
Markdown

<p align="center">
<img src="assets/albion-stats-icon.png" width="100">
</p>
Linux and OS X Build Status: [![Linux and OS X Build Status](https://api.travis-ci.org/mazurwiktor/albion-online-stats.svg)](https://travis-ci.org/mazurwiktor/albion-online-stats)
Windows Build Status: [![Windows Build Status](https://ci.appveyor.com/api/projects/status/jx445p7q0eow95sk/branch/master?svg=true)](https://ci.appveyor.com/project/mazurwiktor/albion-online-stats)
[![Discord](https://discordapp.com/api/guilds/639922572368150552/widget.png?style=banner2)](https://discord.gg/3U2rpyV)
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.
![0.7.0](https://user-images.githubusercontent.com/11301109/71000581-d9124000-20db-11ea-8c19-4d7f69a2c155.png)
# How to use this app
> **Note** this section does not require any coding knowledge. Those simple two steps are required to use this software :)
## Installation
1. On windows make sure that WinPcap is installed in your system. [Npcap 0.9983 installer for Windows Vista/2008, 7/2008R2, 8/2012, 8.1/2012R2, 10/2016 (x86 and x64)](https://nmap.org/npcap/dist/npcap-0.9983.exe) **Make sure to install with the "Install Npcap in WinPcap API-compatible Mode"**
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.
## Is This Allowed
<p align="center">
<img src="assets/sbistatement.png">
</p>
- [x] Only monitors your own party
- [x] Does not modify our game client
- [x] Does not track players that are not within the player's view
- [x] Does not have an overlay to the game
> **Note** this traits of the application are true from version 0.9.0+.
## Donate
[![Become a patron](https://c5.patreon.com/external/logo/become_a_patron_button.png)](https://www.patreon.com/wiktormazur)
# Getting started
## Prerequisites
- Rust installed (https://www.rust-lang.org/tools/install)
- Python installed (python3.5 / python3.6 / python3.7)
- *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. [optional] Create and activate python virtualenv
```shell
python -m venv env
[linux/mac] . env/bin/activate
[windows] .\env\Scripts\activate.ps1
```
or alternatively using conda and skip installing requirements step
```shell
conda env create --file application/environment.yml
conda activate albion
```
3. Install requirements (backend will be compiled during requirements installation)
```shell
pip install -v -r application/requirements.txt
```
4. Run the application
```shell
[sudo on linux] python application/albion-online-stats.py
```
# Contribution
Check out [wiki page](https://github.com/mazurwiktor/albion-online-stats/wiki)
# 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.