README
¶
EVE Buddy
A companion app for Eve Online players available on Windows, Linux and macOS.
Contents
Description
EVE Buddy is a companion app for Eve Online players. It has three key features:
- Give you access to your characters without having to log into the Eve client or switching your current Eve character
- Provide you with helpful functions, that the Eve client is lacking, like asset search across all your characters
- Notify you about important game events (e.g. structure attacked) and new Eve mails
[!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:
- Information about each character:
- Assets: Full asset browser
- Character: Curren clone, jump clones, and more...
- Mails: Full mail client for receiving and sending Eve mails
- Skills: Training queue, catalogue of all trained skills and what ships can be flown
- Wallet: Wallet and Wallet Transactions
- Overview of all your characters (e.g. wallet, skill points, location)
- Wealth: Charts showing wealth distribution across all characters
- Assets search: Full asset search across all your characters
- Can minimize to system tray and show indicator for new mail
- Receive desktop notifications about new communications (e.g. Structure gets attacked) and mails
- Single executable file, no installation required
- Desktop app that runs on Windows, Linux and macOS
- Automatic dark and light theme
- Offline mode
Screenshot
Install
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.
- Download the latest AppImage file from the releases page and make it executable.
- 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
- Download the windows zip file from the latest release on Github.
- Unzip the file into a directory of your choice and run the .exe file to start the app.
Mac OS
- Download the darwin zip file from the latest release on Github for your respective platform (arm or intel).
- Unzip the file into a directory of your choice
- 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
Update
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.
Uninstall
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:
-
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.
-
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. -
EVE Buddy is fully compliant with the requirements for OAuth 2.0 for Mobile or Desktop Applications from CCP.
-
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:
- Wallet journal: 30 days, 2.500 entries
- Wallet transaction: 2.500 entries
However, EVE Buddy will keep all historic data once retrieved. For example: If you allow EVE Buddy to update on a regular basis, it will be able to keep a record of your wallet transactions over many months and years.
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.
Documentation
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
internal
|
|
|
app
Package app is the root package of all domain related packages.
|
Package app is the root package of all domain related packages. |
|
app/assetcollection
Package assetcollection provides data structures to analyze and process asset data.
|
Package assetcollection provides data structures to analyze and process asset data. |
|
app/character
package goesi contains helpers used in conjunction with the goesi package
|
package goesi contains helpers used in conjunction with the goesi package |
|
app/chartbuilder
Package chartbuilder provides a chart builder for rending themed Fyne charts.
|
Package chartbuilder provides a chart builder for rending themed Fyne charts. |
|
app/esistatus
Package esistatus contains the ESI status service.
|
Package esistatus contains the ESI status service. |
|
app/evenotification
Package evenotification contains the business logic for dealing with Eve Online notifications.
|
Package evenotification contains the business logic for dealing with Eve Online notifications. |
|
app/evenotification/notification2
Package notification2 contains type definitions to unmarshal Eve notifications from ESI.
|
Package notification2 contains type definitions to unmarshal Eve notifications from ESI. |
|
app/eveuniverse
Package eveuniverse contains the Eve universe service.
|
Package eveuniverse contains the Eve universe service. |
|
app/humanize
Package humanize transforms values into more user friendly representations.
|
Package humanize transforms values into more user friendly representations. |
|
app/statuscache
Package characterstatus is a service which provides cached access to the current update status of general and character sections.
|
Package characterstatus is a service which provides cached access to the current update status of general and character sections. |
|
app/storage
Package sqlite contains the logic for storing application data into a local SQLite database.
|
Package sqlite contains the logic for storing application data into a local SQLite database. |
|
app/storage/testutil
Package factory contains factories for creating test objects in the repository
|
Package factory contains factories for creating test objects in the repository |
|
app/ui
Package ui contains the code for rendering the UI.
|
Package ui contains the code for rendering the UI. |
|
app/widgets
Package widgets contains custom widgets for this app.
|
Package widgets contains custom widgets for this app. |
|
cache
Package cache implements a simple in-memory cache.
|
Package cache implements a simple in-memory cache. |
|
deleteapp
Package deleteapp contains the Fyne app for deleting the current users's data.
|
Package deleteapp contains the Fyne app for deleting the current users's data. |
|
evehtml
Package evehtml provides converters to deal with Eve Online HTML.
|
Package evehtml provides converters to deal with Eve Online HTML. |
|
eveimage
Package eveimage provides cached access to images from the Eve Online image server.
|
Package eveimage provides cached access to images from the Eve Online image server. |
|
fynetree
Package fynetree contains a type that makes using Fyne tree widgets easier.
|
Package fynetree contains a type that makes using Fyne tree widgets easier. |
|
github
package github contains features for accessing repos on Github.
|
package github contains features for accessing repos on Github. |
|
httptransport
Package http provides custom http transport implementations.
|
Package http provides custom http transport implementations. |
|
migrate
Package migrate provides a simple mechanism for dealing with migrations of a SQLite database.
|
Package migrate provides a simple mechanism for dealing with migrations of a SQLite database. |
|
optional
Package optional provides the generic type Optional, which represents an optional value.
|
Package optional provides the generic type Optional, which represents an optional value. |
|
set
Package set implements a generic set container type.
|
Package set implements a generic set container type. |
|
sso
Package sso provides the ability to authenticate characters with the Eve Online SSO API for desktop apps.
|
Package sso provides the ability to authenticate characters with the Eve Online SSO API for desktop apps. |
|
tools
|
|