Launchers + new README

This commit is contained in:
Wiktor Mazur
2021-07-24 14:07:43 +02:00
parent a34bd72d54
commit f76516c8b1
4 changed files with 21 additions and 13 deletions
+1
View File
@@ -4,6 +4,7 @@
*.spec *.spec
env env
venv venv
launchers/python_env
**/build **/build
**/dist **/dist
**/*.egg-info **/*.egg-info
+9 -13
View File
@@ -32,7 +32,8 @@ Albion online stats is an extension to MMORPG game - Albion Online. It tracks ne
## Installation ## 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"** 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) 2. Install python https://docs.python.org/3/using/
3. Download latest launcher from https://github.com/mazurwiktor/albion-online-stats/releases/latest (albion-online-stats.bat for windows albion-online-stats.sh for linux and mac)
3. Enjoy :) 3. Enjoy :)
## Configuration ## Configuration
@@ -60,7 +61,7 @@ After first execution the app is going to create default configuration file name
## Prerequisites ## Prerequisites
- Python installed (python3.6 / python3.7 / python3.8) - Python installed (python3.6+)
- *Windows only prerequisites* https://github.com/libpnet/libpnet#windows - *Windows only prerequisites* https://github.com/libpnet/libpnet#windows
@@ -74,25 +75,20 @@ After first execution the app is going to create default configuration file name
```shell ```shell
python -m venv env python -m venv env
[linux/mac] . env/bin/activate [linux/mac] . env/bin/activate
[windows] .\env\Scripts\activate.ps1 [windows powershell] .\env\Scripts\activate.ps1
[windows cmd.exe] .\env\Scripts\activate.bat
``` ```
or alternatively using conda and skip installing requirements step
3. Install package
```shell ```shell
conda env create --file environment.yml python setup.py install
conda activate albion
```
3. Install requirements
```shell
pip install -v -r requirements.txt
``` ```
4. Run the application 4. Run the application
```shell ```shell
[sudo on linux] python albion-online-stats.py aostats
``` ```
# Contribution # Contribution
+5
View File
@@ -0,0 +1,5 @@
python -m venv python_env
call .\python_env\Scripts\activate.bat
python -m pip install aostats
start aostats
+6
View File
@@ -0,0 +1,6 @@
#!/bin/bash
python -m venv python_env
source python_env/bin/activate
python -m pip install aostats
start aostats