purry03/wh-buddy

WH Buddy is a third-party tool for Eve Online that makes wormhole exploration painless

WH Buddy 🌌

WH Buddy is a third-party tool for Eve Online that makes wormhole exploration painless. It provides a transparent overlay on your screen, tracks the current system you're in and displays information about the system's static and wormhole class. With WH Buddy, you no longer need to manually check websites like Anoikis for this information. Additionally, the tool offers convenient buttons to directly open Dotlan, Anoikis, and Zkillboard for the current system.

Features ✨

• Transparent overlay displaying system information
• Tracks current system and lists static and wormhole class
• Quick access buttons to Dotlan, Anoikis, and Zkillboard

Installation 💻

To use WH Buddy, you can download the zip file from the Releases section. Choose the appropriate version for your operating system.

Usage 🚀

1. Extract the zip file to somewhere convenient.
2. Open the extracted folder and double click on wh-buddy.exe
3. Click on the "LOG IN with EVE Online" button and auth the character that you wish to track
4. You can move the overlay around by clicking and dragging the character name at the top left
5. Compact mode can be enabled by pressing the "-" button at the top right.

Development 🛠️

If you wish to run WH Buddy locally for development purposes, follow the steps below:

Prerequisites

• Node.js (version 12 or higher) installed on your machine

Clone the repository

git clone https://github.com/purry03/WH-Buddy

Navigate to the project directory

cd wh-buddy

Install dependencies

npm install

Start the application

npm start

This will launch WH Buddy in development mode.

Build 🚀

To build the application for distribution, you can use the following command:

npm run build

This command will package the application using Electron Packager and create an executable file for your platform in the build directory. The resulting file will include the specified icon.

Contributing 🤝

Contributions to WH Buddy are welcome! If you find a bug or have an idea for an improvement, feel free to open an issue or submit a pull request on the GitHub repository.

When contributing, please follow the existing code style and provide clear and concise descriptions of your changes.

License 📄

This project is licensed under the MIT License.

Disclaimer ❗️

WH Buddy is a third-party tool and is not affiliated with or endorsed by Eve Online or its developers. Use of this tool is not against the EVE Online EULA.

Happy wormhole exploring with WH Buddy! 🚀🌌