An open API service indexing awesome lists of open source software.

https://github.com/imjangkar/albibong

A cross-platform Albion Online damage, fame, and dungeon tracker
https://github.com/imjangkar/albibong

albion albion-damage-meter albion-dps-meter albion-online albiononline damage dps-meter dungeon dungeon-tracker game game-albiononline heal-meter tracker

Last synced: 2 months ago
JSON representation

A cross-platform Albion Online damage, fame, and dungeon tracker

Awesome Lists containing this project

README

          

# Albibong

[![Discord](https://img.shields.io/discord/772406813438115891?logo=discord&logoColor=7289da&label=discord&labelColor=1E2126&color=7289da)](https://discord.gg/tHztGJ2QYT)
[![PyPI - Downloads](https://img.shields.io/pypi/dm/albibong)](https://pypi.org/project/albibong/)
[![PyPI - Version](https://img.shields.io/pypi/v/albibong?label=pypi%20version)](https://pypi.org/project/albibong/)

### Optimized for Mac

❗️ Untested in Windows and Linux, I don't have those machines :( ❗️

## 🎯 Features

1. Damage (and Heal) Meter
![Damage (and Heal) Meter](readme_screenshots/damage_meter.png)
- Pause and Resume damage and heal logging
- Copy damage rank to clipboard
- Reset damage, heal, and player stats
2. Dungeon Tracker
![Dungeon Tracker](readme_screenshots/dungeon_tracker.png)
- Automatically track dungeon name, fame gained, silver gained, respec points gained, start time, dungeon duration and dps meter snapshot.
- Change recorded dungeon name
- Add dungeon tier/level
- Filter dungeon by dungeon types
3. Farming Tracker
![Farming Tracker](readme_screenshots/farming_tracker.png)
- Automatically track harvested crops and animals in an island
- See farming recap of a specific day

## How to Install

### Prerequisites

- You need Python 3.10 and above
- Ability to type or copy paste in your computer's Terminal or Command Line

### 🔰 Casual Users

1. Install Albibong through pip

```
pip install albibong
```

### 👨‍💻 Devs

**It is recommended to use virtualenv**

1. Install the Backend inside `src/albibong`

```
cd src && pip install -r albibong/requirements.txt
```

2. Install the Frontend inside `gui`

```
cd gui && npm install
```

## How to Run The Program

### ‼️ Important Note ‼️

- For better party member detection, turn on Albibong first before joining a party. If you are already in a party, you can leave the party then join again.

- You need to change location (zone to another map) to initialize your character
- Character Not Yet Initialized
![Character Not Yet Initialized](readme_screenshots/not_initialized.png)
- Successfully Initialized Character
![Successfully Initialized Character](readme_screenshots/initialized.png)

### 🔰 Casual Users

1. Run Albibong by typing `albibong` on your terminal

```
albibong
```

2. A window will pop out and you're good to go!

**Can't run the program?** Refer to [FAQ](#-faq)

### 👨‍💻 Devs

1. Clone this repository

2. Run the Backend inside `src`

```
cd src && python -m albibong
```

3. Run the Frontend inside `gui`

```
cd gui && npm run dev
```

4. You can now access the GUI by going to http://localhost:5173/
5. See logs and saved dungeon data on `~/Albibong/`

## ❓ FAQ

### _"I can't run Albibong by typing Albibong"_

#### Common Mac Problems

If you encounter this problem

```
scapy.error.Scapy_Exception: Permission denied: could not open /dev/bpf0. Make sure to be running Scapy as root ! (sudo)
```

Use `sudo albibong` to start Albibong.

#### Common Windows Problems

If you encounter this problem

```
'albibong' is not recognized as an internal or external command, operable program or batch file.
```

Add PIP package to path by following this guide https://youtu.be/9_WyyV_66rU?si=0shXXv59MBeQBHiH

### _"Can I use the tool with ExitLag, 1.1.1.1 or VPN?"_

No, this is not possible. If Albion is blocked in your country, I suggest to add Albion's servers to your hosts file.

## 🤝🏼 Credits

- Event and Operation Codes based on [AlbionOnline-StatisticsAnalysis](https://github.com/Triky313/AlbionOnline-StatisticsAnalysis) with modifications
- Map and Item Codes based on [ao-bin-dumps](https://github.com/ao-data/ao-bin-dumps) with modifications
- Use of [photon-packet-parser](https://github.com/santiac89/photon-packet-parser) with modifications