ErikKalkoken / evebuddy

EVE Buddy is a desktop companion app for Eve Online players available on Windows, Linux and macOS.
MIT License
8 stars 2 forks source link
darwin eveonline fyne go linux windows

EVE Buddy

A companion app for Eve Online players available on Windows, Linux and macOS.

GitHub Release build status GitHub License chat

Contents

Description

EVE Buddy is a companion app for Eve Online players. It has three key features:

[!IMPORTANT] This is an early version and not yet considered fully stable. We would very much appreciate your feedback, so we can find and squash remaining bugs. If you encounter any problems please feel free to open an issue or chat with us on our Discord server in the support channel #evebuddy.
Some features may not be fully implemented yet (e.g. some notification types). Our current focus is on bug fixing, rather then adding more features. But if you are missing anything important, please feel free to open a feature request.
We very much welcome any contributions. If you like to provide a fix or add a feature please feel free top open a PR.

Features

A more detailed overview of the provided features:

Highlights

Asset browser for each character

You can browse the assets of a character by location. The view by location is similar to the in-game view when docked.

Screenshot from 2024-11-10 16-53-30

Full mail client

You can receive, send and delete eve mails. Similar to the in-game mail client.

Screenshot from 2024-11-10 16-52-55

Overview of all characters

The overview pages gives you key information about all you characters at a glance.

Screenshot from 2024-11-10 16-54-22

Asset search across all characters

You can search for assets across all characters.

Screenshot from 2024-11-10 16-52-07

Wealth charts across all characters

The wealth page gives you a graphical overview of your total wealth (= wallets + asset value) and contains breakdowns that help you better understand the structure of your wealth.

Screenshot from 2024-11-10 16-54-56

Desktop notifications

EVE Buddy can send your desktop notifications to inform you about new communications and mails.

Screenshot from 2024-11-10 17-18-27

Installing

To install EVE buddy just download and unzip the latest release from the releases page to your computer. The app ships as a single executable file that can be run directly. When you run the app for the first time it will automatically install itself for the current user (i.e. by creating folders in the home folder for the current user).

You find the latest packages for download on the releases page.

Linux

[!NOTE] The app is shipped in the AppImage format, so it can be used without requiring installation and run on many different Linux distributions.

  1. Download the latest AppImage file from the releases page and make it executable.
  2. Execute it to start the app.

[!TIP] Should you get the following error: AppImages require FUSE to run., you need to first install FUSE on your system. Thi s is a library required by all AppImages to function. Please see this page for details.

Windows

  1. Download the windows zip file from the latest release on Github.
  2. Unzip the file into a directory of your choice and run the .exe file to start the app.

Mac OS

  1. Download the darwin zip file from the latest release on Github for your respective platform (arm or intel).
  2. Unzip the file into a directory of your choice
  3. Run the .app file to start the app.

[!TIP] MacOS may report this app incorrectly as "damaged", because it is not signed with an Apple certificate. You can remove this error by opening a terminal and running the following command. For more information please see Fyne Troubleshooting:

sudo xattr -r -d com.apple.quarantine "EVE Buddy.app"

Build and run from repository

You can also build and run the app directly from the repository. For that your system needs to be able to build Fyne apps, which requires you to have installed the Go tools, a C compiler and a systems graphics driver. For details please see Fyne - Getting started.

When you have all necessary tools installed, you can build and run this app direct from the repository with:

go run github.com/ErikKalkoken/evebuddy@latest

Updating

The app will inform you when there is a new version available for download. To update your app just download and unzip the newest version for your platform from the releases page. Then overwrite the old executable file with the new one.

Uninstalling

If you no longer want to use the app you can uninstall it.

First start the delete app for removing your user data:

./evebuddy --delete-data

This command will ask for confirmation and then delete user data from your computer like characters, log files, etc.

Then delete the file itself:

rm evebuddy

FAQ

Where can I get support?

Fo bugs and feature requests please open an issue in the GitHub repository.

For support and any other questions please join us on in our channel #eve-buddy on this Discord server.

What safety measures are taken to protect my character data and token?

EVE Buddy is designed to protect your character data and token and has implemented the following safety measures:

  1. All character data and tokens retrieved from CCP's servers are stored on your local computer only. Your data is therefore safe as long as you prevent any unauthorized access to the data on your computer.

  2. EVE Buddy also does not log any tokens (they are replaced with the text REDACTED). It is therefore safe to share your logs with maintainers for troubleshooting.

  3. EVE Buddy is fully compliant with the requirements for OAuth 2.0 for Mobile or Desktop Applications from CCP.

  4. In case you need to switch computers you can remove your data with the delete app.

Why do I not see all of my character's data in the app?

Server limitations

CCP's servers have limitations on how far back some character data can be retrieved.

Here is an overview of some limitations:

Structures

A special case are Upwell structures. Access to structures depends on in-game docking rights. Unfortunately, it is not possible to later retrieve the name or location of a structure, which the character no longer has access to. For example character assets might be displayed in an "unknown structure".

Credits

"EVE", "EVE Online", "CCP", and all related logos and images are trademarks or registered trademarks of CCP hf.