search

ao-data / albiondata-client

Distributed client for the Albion Online Data project.
https://www.albion-online-data.com/
MIT License
106 stars 32 forks source link

readme

Albion Data - Client

Distributed client for the Albion Online Data project.

A quick note on the legality of this application and if it violates the Terms and Conditions for Albion Online. Here is the response from SBI when asked if we are allowed to do monitor network packets relating to Albion Online:

Our position is quite simple. As long as you just look and analyze we are ok with it. The moment you modify or manipulate something or somehow interfere with our services we will react (e.g. perma-ban, take legal action, whatever).

~ MadDave - Technical Lead for Albion Online

Source: https://forum.albiononline.com/index.php/Thread/51604-Is-it-allowed-to-scan-your-internet-trafic-and-pick-up-logs/?postID=512670#post512670

This client monitors local network traffic, identifies UDP packets that contain relevant data for Albion Online, and ships the information off to a central NATS server that anyone can subscribe to.

Contributions

Many thanks to the original developers:

Many thanks also to broderickhyman for picking up development and funding for the the last few years of the project!

As of 2023-01-01, Stanx is the primary maintainer and provides funding of the related projects.

Walkynn has been a long time maintainer of different aspets of the project as well.

Downloads

Downloads can be found here: https://github.com/ao-data/albiondata-client/releases

Stats for the client releases can be viewed here.

Running on Mac

Running from the Finder

  1. Download the latest albiondata-client-amd64-mac.zip file from the Releases page
  2. Unzip that file from the Finder
  3. Enter the albiondata-client folder.
  4. Double click the run.command file. It will ask for your password for permissions reasons.

Running from the Terminal

  1. Download the latest update-darwin-amd64.gz file from the Releases page
  2. Unzip that file from the Finder or with gunzip update-darwin-amd64.gz
  3. The unzipped albiondata-client file is a Golang binary file. You'll need to make this file executable so it can be run directly. You can do this from your Terminal with: chmod +x albiondata-client
  4. Run the client from your Terminal with ./albiondata-client

Related Projects

Contact Us

The best way to get in touch with us is on the Albion Online Fansites Discord server in either the #proj-albiondata or the #developers channel. A permanent invite link can be found here: https://discord.gg/TjWdq24

Developer Setup

Mac/Linux Setup

Windows Setup

Windows Setup Guide

License

This project, and all contributed code, are licensed under the MIT License. A copy of the MIT License may be found in the repository.