+ Getting started
This commit is contained in:
@@ -1,10 +1,11 @@
|
||||
<p align="center">
|
||||
<img src="assets/albion-stats-icon.png" width="100">
|
||||
Albion Online Stats
|
||||
===================
|
||||
</p>
|
||||
|
||||
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
|
||||
|
||||
Reference in New Issue
Block a user