Skip to content

Commit

Permalink
Readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
Zeldruck committed Jan 3, 2024
1 parent 085e7b5 commit e8304f2
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 71 deletions.
120 changes: 49 additions & 71 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,78 +1,56 @@
## ✨ Join Discord
- Link: https://discord.gg/rKKVqUdP3p
[![Discord](https://img.shields.io/discord/1191823969167352039?style=for-the-badge&logo=discord&label=Discord)](https://discord.gg/XAWjmzeaD3)
![GitHub last commit (branch)](https://img.shields.io/github/last-commit/Zeldruck/Albion-Online-ZQRadar/main?style=for-the-badge&label=Last%20Commit)
[![GitHub issues](https://img.shields.io/github/issues-raw/Zeldruck/Albion-Online-ZQRadar?style=for-the-badge&label=Issue)](https://github.com/Zeldruck/Albion-Online-ZQRadar/issues)
![GitHub Repo stars](https://img.shields.io/github/stars/Zeldruck/Albion-Online-ZQRadar?style=for-the-badge)

---
## ❓ What is ZQRadar?
ZQRadar is a radar type tool for the game Albion Online.
\
Albion ZQRadar provides a real-time map, helping players detect other players, creatures, resources and more, nearby.

## ❓ What is QRadar?
Albion QRadar provide a real-time map, aiding players in detecting other players, creatures, and resources nearby.

---
## ❓ If you want to use in game items

- Link: https://www.mediafire.com/file/fa96b300q7ompjb/Items.rar/file

### Video Tutorial
### Link: https://www.youtube.com/watch?v=_luNHJXrD5o

---
## ❓ Usage (Windows)
## 🔰 How to run (Windows)

1. Download Node.js v18.18.2:
- [Node.js v18.18.2 (64-bit)](https://nodejs.org/dist/v18.18.2/node-v18.18.2-x64.msi)
2. Download Npcap:
- [Npcap 1.72](https://npcap.com/dist/npcap-1.72.exe)
3. Download Python 3.10.2:
- [Python 3.10.2 (64-bit)](https://www.python.org/ftp/python/3.10.2/python-3.10.2-amd64.exe)
4. Install Windows Build Tools:
```
npm install --global windows-build-tools
```
5. Install Node.js packages:
```
npm install
```
6. Run the application:
```
node app.js
```
---
## ❓ Usage (Linux)

1. Switch to root user:
```
sudo su
```
2. Install Node Version Manager (NVM):
```
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.5/install.sh | bash
```
3. Close the terminal.
4. Install Node.js version 18:
```
nvm install 18
nvm use 18
```
5. Install required libraries:
```
sudo apt-get install libpcap0.8 libpcap0.8-dev
```
6. Install Python 3.10:
```
sudo apt install python3.10
```
7. Install build essentials:
```
sudo apt-get install build-essential
```
8. Install Node.js dependencies:
```
npm install
```
9. Navigate to the project directory and run the application:
```
node app.js
```
10. Open http://localhost:5001 in your browser.
---
Utilized the parser from https://github.com/0xN0x/photon-packet-parser for efficient packet parsing.
---
3. Download the source code of the latest release
- [Releases](https://github.com/Zeldruck/Albion-Online-ZQRadar/releases)
4. Open the file `_INSTALL` and wait for the line:
```
Press any key to continue . . .
```
5. Open the file `_APP` and wait for the line:
```
Server is running on http://localhost:5001
```
6. You can now access the radar features by going to `http://localhost:5001` in your browser.

## ✨ Image Packs
**⚠️(This is not mandatory for the radar to work)⚠️**
\
You can download the Image Packs to enhance the radar.
\
\
**Packs:**
- **Ressource Pack v1.0**: Installed by default
- **Items Pack v0.0**: [Link](https://github.com/Zeldruck/Albion-Online-ZQRadar/releases/tag/item-pack-v0.0)
- **Animals & Harvestables Pack v0.0**: [Link](https://github.com/Zeldruck/Albion-Online-ZQRadar/releases/)
- **Enemies Pack v0.0**: [Link](https://github.com/Zeldruck/Albion-Online-ZQRadar/releases/)
- **Maps Pack v0.0**: [Link](https://github.com/Zeldruck/Albion-Online-ZQRadar/releases/tag/map-pack-v0.0)

\
Once downloaded, exitract the folder into `Albion-Online-ZQRadar/images/`.
\
\
Example:
\
If you have downloaded the Map Pack, you should have `Albion-Online-ZQRadar/images/Maps/*.png`.


## Credits
[@Zeldruck](https://github.com/Zeldruck)
\
Based on [QRadar](https://github.com/FashionFlora/Albion-Online-Radar-QRadar) by [@FashionFlora](https://github.com/FashionFlora?)
\
Use of [photon-packet-parser](https://github.com/0xN0x/photon-packet-parser) to parse packets.
Binary file added git-images/zqradar.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit e8304f2

Please sign in to comment.