# hamburger helper v1.1
by: md5oogle



## What this is

Hamburger Helper is the 2026 replacement for previous tools like Pirates Little Helper. It allows you to copy/paste your clients local list (or chat window line), and receive a
statistics list for the pilots in system (or linked in the chat). It is a detached window, that can be moved anywhere you want with options for transparency and always on top.

For anything not covered by this document, please see the FAQ, website at https://honorablethird.com/tools/ or Discord, #honorable-tools channel at https://discord.gg/TkdWcrUwGz  

Donations can be sent to character md5oogle

Got a suggestion or feature request? Attach it as a note in the step above :D

## Features

* Fast, native based applications written in Rust using the  egui library.
* Quick access to zkill information in-app.
* Quick access to zkill page for pilots.
* Ability to set app-scoped standings based on pilot, corp, or alliance, with the ability to ignore any given standing (in the list for filtering, aka blues)
* Local storage of previous data for longer term tracking in a readable format (you break your data files, thats on you!)
* Caching of api data to help prevent service hammering (Hi Squizz <3) - zkill defaults to 2 hours to be safe. You CAN force premature re-syncs if you don't care about your pilot data (delete pilots.json) but try not to be abusive.
* On-the-fly caching of id to name types means new ship names will automatically resolve when CCP releases them, without needing to update the software.
* Choosable data columns.

## Getting started

* This program should be cross-platform. Other options are available at https://honorablethird.com/tools/threat/ should you require alternative binaries.
* Windows: Extract the archive into a folder that the application will have write access to. It will store its local databases in this directory.
* MacOS: Extract the archive into a folder. It will store its data in macos's Library/Application Support/com.honorablethird.hamburgerhelper/ directory.
* Linux: 
* Run the program.

## Configuration and dropped files.

* The program will drop a configuration on first run, if not already available. You may want to edit it, but ensure the application is not running. Changes are saved on exit.
* On exit, the program will drop the follow databases, as necessary. Files with .json extensions can be modified, but if you break it, it WILL BE OVERWRITTEN--BACKUP YO SHIT!
* alliance_map.dat -> alliance id to name mappings; standard json, but no you should have no reason to modify it.
* corporation_map.dat -> corporation id to name mappings; again, standard json, but you should leave it alone.
* ship_map.dat -> ship id to name mappings; .... yea. you know... messing up any of these will cause the cache to be rebuilt for that item (not the end of the world)
* pilots.json -> known pilot information -- you CAN edit this, but ANY mistake will cause it to be overwritten, BACKUP YO SHIT!
* standings.json -> manual standings for ease of filtering. This is not automatic.. Right click on the boxes. You CAN edit this but this is probably the MOST IMPORTANT file.


## Removal

* There is no install necessary. To remove, simply delete the extracted folder.

# Configuration information

## The following is a description of the available configuration settings. Some are changeable inside the application.

* Multithreading: Please be kind when using multi-threading in the configuration. If you have a large list and a moment, consider turning off threading to be nice on the Api
services. Multithreading enabled will cause the system to fetch as many requests as possible which will lead to incredible performance, but rougher on api bursts. All data is cached.

* Show Ignored: Any pilots that have been ignored due to your settings will appear in the list with a @ beside them. This is useful if you wish to remove the ignore label.
