From a0127ea21efc19c9c3a59dfedf29dc4eefd1371d Mon Sep 17 00:00:00 2001 From: Wiktor Mazur Date: Sun, 25 Aug 2019 16:53:01 +0200 Subject: [PATCH] + Getting started --- README.md | 55 ++++++++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 52 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index cec8d68..0a541c8 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,11 @@

-Albion Online Stats -===================

-Albion online stats is an extention to MMORPG game. It tracks network traffic and displays various statistics calculated from in-game actions. +Albion Online Stats +=================== + +Albion online stats is an extention to MMORPG game - Albion Online. It tracks network traffic and displays various statistics calculated from in-game actions. ## Is This Allowed @@ -14,6 +15,54 @@ Albion online stats is an extention to MMORPG game. It tracks network traffic an * copied from [Albion Online Data](https://www.albion-online-data.com/) +## Getting started + +## Prerequisites + +- Rust installed (https://www.rust-lang.org/tools/install) +- Python installed +- *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. Copy library to GUI directory + + 3.1 on Linux + + ```shell + cp target/release/libmeter.so gui/ + ``` + + 3.1 on Windows + + ```shell + cp target/release/meter.dll gui/libmeter.pyd + ``` + +4. 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