The calculator calculates outputs using averages, so day to day in-game results might differ a bit.
There are no hidden assumptions, whatever is inputted is used as inputted.
Some inputs are conditional on other inputs like in-game, some inputs are unconditional while they should be.
This means that this calculator can calculate setups that are not possible in-game. More information on these below.
Setup ID
A Setup ID is a string of characters representing the minion setup in the calculator.
The first part of an ID is the version of the calculator. The calculator will only accept IDs from calculators of the same version.
The rest is all the inputs represented by one character if there are a limited amount of options.
For real number variables it adds the whole number between exclamation marks.
When sharing results from the calculator, please include the setup ID.
Inputs
Inputs are on the left side of the calculator. Input methods are option lists, text boxes or check boxes.
Some inputs are hidden until they become relevant, like Inferno Minion Fuel inputs.
Inputs are split into 6 categories: Template, Minion, Island, Player, Time and Market.
Template
Relevant inputs: Templates, Load ID
A template is a list of automatic inputs.
For example, the template Corrupt automatically selects Corrupt Soil, Enchanted Hopper, Diamond Spreading as internal upgrades and Hopper as Sell Location.
The list of templates is at the top of the main file and can be edited by the user.
There are two special templates named ID and Clean.
The template ID takes the inputted setup ID from Load ID.
The template Clean resets all inputs to their standard values.
Minion
Relevant inputs: Minion, Tier, Amount, Fuel, Upgrade 1, Upgrade 2, Chest, Infusion, Free Will
Inputs for the basic upgrades of the minions.
Order of Upgrade 1 and Upgrade 2 does not matter.
There are no conditions on Fuel, Upgrade 1 and Upgrade 2.
When selecting Inferno Minion Fuel as Fuel, Inferno Minion options will appear.
Setting Free Will to True will make the optimal tier to apply the Free Wills to and Free Will cost appear in the output.
Inferno Minion
Relevant inputs: Grade, Distillate, Eyedrops
These inputs are hidden unless the selected Fuel is Inferno Minion Fuel.
Inputs for Inferno minions.
Island
Relevant inputs: Beacon, Crystal, Postcard
Inputs for upgrades placed on the private island that work on all minions at once.
If the inputted Crystal will apply is conditional on the inputted Minion.
When selecting a non-zero tier for Beacon, Beacon option will appear.
Beacon
Relevant inputs: Scorched, Free Fuel Beacon, Aquired Beacon
These inputs are hidden if Beacon is set to 0. Scorched toggles using Scorched Power Crystals instead of normal Power Crystals. Free Fuel Beacon is a toggle for the fuel cost of the beacon. If set to True, the beacon fuel cost will be set to 0. This is useful if you have your beacon fuel coming from somewhere else. Aquired Beacon is a toggle for the buy cost of the beacon. If set to True, the cost to buy the beacon will not be added to the setup cost. This is useful if you already have a beacon.
Player
Revevant inputs: AFK, Wisdom, Mayor, Leveling Pet
Inputs relavent to the player.
When selecting True for AFK, AFK options will show.
When selecting Diana as Mayor, extra pet exp share slots will show.
When selecting any Leveling Pet, Pet Leveling options will show.
AFK
Relevant inputs: AFK Pet, AFK Pet Rarity, AFK Pet level, Enchanted Clock, Special layout, Player Harvests, Looting, Potato Talisman
To specify, AFKing minions is the act of leaving an account online 24/7 to keep the private island loaded. AFK Pet and related inputs are for pets that give speed boosts to minions. This is conditional on Minion. Enchanted Clock is a toggle for using the Enchanted Clock while on the island, which will do offline calculations while online. Special Layout is a toggle for using a layout that changes how the minion behaves. Player Harvests and Looting are inputs for when the player is doing the harvests instead of the minion.
The input for Potato Talisman will remain hidden until Minion is set to Potato and is conditional on this.
Available special layouts and other changes in behaviour while AFK can be found in several places:
As notes in the output of a calculation with that minion
As notes in the minion list in the file HSB_minion_data.py
In the Minion Mechanic spreadsheet (will be linked later)
Wisdom
Relevant inputs: Combat, Mining, Farming, Fishing, Foraging, Alchemy
All the types of wisdom are bunched into one list variable. This list can be edited by pressing the edit button next to the list box.
This will overlay a new frame over the calculator with text input boxes for each main skill and a close button to close that frame.
Input wisdom values as the same value as the in-game stat.
Pet Leveling
Relevant inputs: Taming, Battle Experience, Pet XP boost, Beastmaster, Exp Share pet, Exp Share pet 2, Exp Share pet 3, Why Not More, Exp Share pet item
These inputs are hidden when Leveling Pet is set to None. Exp Share pet 2 and Exp Share pet 3 will remain hidden until Mayor is set to Diana.
For Taming input the skill level and for Beastmaster input the percentage as seen on a beastmaster crest (so if a beastmaster crest shows 5%, input 5). Battle Experience and Why Not More are the attributes given by the Falcon and Toucan shards, respectively, inputted as attribute level.
The profits of pets can be edited in the Settings.
Time
Relevant inputs: Total Time span, Empty Often, Empty Time span
Inputs for controlling time span and scaling.
Total Time span and Empty Time span both are time inputs, which consist of a number input and a choice for unit of time.
Alongside standard units of time there is Harvests, which sets the time span to the time it takes for one minion to perform the specified number of harvests.
If Empty Often is turned on, Empty Time span will appear and the setup will be calculated as if it was emptied every Empty Time span and all outputs will be scaled to match Total Time span.
This affects non-linear things like compacting or Golden Dragon leveling.
If Empty Often is turned off, Total Time span will be the only used time span so the time bewteen empties will be Total Time span.
Market
Relevant inputs: Sell Location, Bazaar sell type, Bazaar buy type, Bazaar taxes, Bazaar Flipper
There are 4 sell options for Sell Location: Best (NPC/Bazaar), Bazaar, Hopper and NPC. NPC sells to npc at full price. Hopper. Bazaar sells to bazaar. Best (NPC/Bazaar) compares NPC and bazaar prices and sells to the best option.
Bazaar data is pulled from Hypixel's API. The item price for each category (buy and sell) is determined from the top 10% of total volume of that item.
The calculator has a safety net for bazaar prices that recently crashed, if the supply for an item is very concentrated towards the bottom of the price range, then the calculator takes the top order.
When selling items, taxes are applied if Bazaar taxes is set to True.
This tax can be lowered with Bazaar Flipper, which is inputted as the level of the Bazaar Flipper account upgrade (see Hypixel Wiki).
Bazaar sell type and Bazaar buy type are used to choose insta sell/buy or sell offer/buy order.
There is also a third option for both sell and buy types called Custom, this option takes the manual inputted price. This option is currently not great to work with and will be updated later.
Users can freely change this price at the variable itemList in the file HSB_minion_data.py. When sharing results that used custom prices, please include the custom prices.
If a price of an item is not available it will fall back to different sell methods in this order: Original method -> NPC -> Custom.
If all backup methods fail, it will give 0 as the price and will print an error to the terminal which can then be reported.
For items only available the auction house it will always fall back to Custom price, and because the calculator is not connected to the auction house API, the auction house prices have to be updated manually.
Instructions on how to find and edit the auction house only items can be found at the top of the file HSB_minion_data.py
Outputs
Outputs are located at the right side of the calculator.
Each output has a checkbox next to it, this toggles if the corresponding output value will be included in the output of the output buttons in the controls menu.
Outputs are split into 2 columns, Setup Outputs and Profit Outputs.
All numbers outputs are not shortened in the calculator, but they will be shortened and rounded in the printed outputs.
Setup
Relevant outputs: Setup ID, Time, Empty Time, Action Time (s), Notes
These outputs are about the general setup.
See Setup ID for an explanation of the setup ID. Action Time (s) is shown as seconds.
Notes
Relevant outputs: Notes Notes is a location for smaller details about the setup.
This includes but is not limited to the following list of things:
Special Layout behaviour
Over-compacting warnings
Extra setup costs
Optimal tier for applying Free Will
AFK behaviour of minions
Minion
Relevant outputs: Harvests, Item amounts, Used Storage, XP amounts, Pets levelled
These outputs are what the minions make directly. Harvests is the combined amount of harvests in the inputed time span by all minions in the setup. Used Storage is the amount of storage slots needed to storage all the items from Item amounts. Wisdom is already applied to the shown XP amounts. Pets levelled gives the (possibly fractional) amount of pets levelled based on total pet XP. The fractional amounts are not based on pet level.
Profit
Relevant outputs: Bazaar data, Setup cost, Free Will cost, Sell locations, Itemtype profits, Total item profit, Pet profit, Fuel cost, Total profit Bazaar data shows the date and time of the used bazaar data. It is recommended to always print this with the output. Free Will cost is the average cost to succesfully apply Free Will to all the minions, this is an average because Free Will successes are random. Sell locations will appear when Best (NPC/bazaar) is selected as Sell Location, it will show per item where the best price is.
Controls
Relevant buttons: Calculate, Short Output, Share Output, Update Bazaar, Add-ons Menu, Stop
The controls menu is the bar at the bottom of the calculator. Calculate runs the calculation for the inputted values and shows the outputs in the calculator. Short Output and Share Output print the selected outputs to the terminal. Short Output outputs plain and compact text. Share Output outputs markdown text suitable for sharing over Discord. Update Bazaar updates the bazaar data. This is mostly useful when the setting bazaar_auto_update is False. Add-ons Menu toggles the Add-ons menu, in this menu the buttons to run the add-ons and the Add-on Outputs are visible. Stop stops the calculator correctly, please use the stop button to close the calculator as the calculator still has some functions to run before closing.
Also in the controls menu are a link to this website and the version number.
Settings
Relevant variables: external_add_ons, bazaar_auto_update, bazaar_cooldown, compact_tolerance, output_to_clipboard, color_palette, templateList, pet_data
Calculator settings are near the top of the main file under #%% Settings. external_add_ons is a dictionary to import add-on functions, inputted as {"display name": function_reference, ...}. bazaar_auto_update is a toggle for automatically updating bazaar when a calculation is started and the cooldown has passed. bazaar_cooldown, inputted in seconds, limits how quickly bazaar can be updated, this is to prevent spamming Hypixel's API. compact_tolerance is the minimum amount of coins lost per compacting action before the calculator warns of over-compacting. output_to_clipboard is a toggle to let the calculator add the output text to your clipboard. color_palette is an input for which color palette the calculator uses. The available color palettes are in the Hkinter.py file. templateList is the list of templates (see Template). The structure for this is the name of the template as the first key with a dictionary as value.
This dictionary consists of the inputs that the template changes with self.variables keys as keys and the input value as value. pet_data holds the costs of pets for pet leveling, inputted as "Pet Name": {"min": ..., "max": ...}.
Where min is for the price of a level 1, max is for the price of a max lvl (either 100 or 200).
All pets are assumed to be Legendary or Mythic, except Rift Ferret, which is stuck at Epic.
The calculator is not connected to the auction house, so these costs need to be updated by hand.
Add-ons
Add-ons are functions that use the results of the main calculation.
The functions will be run with calculator=self as only function argument, where self is the root of the calculator class.
Add-ons can send output to the calculator through calculator.collect_addon_output(output_name="...", output_str="..."). This function puts the output into Add-on Outputs.
Add-ons can be activated with the button in the Add-ons Menu. There is also a toggle for every add-on that makes the add-on run automatically after every Calculate press.
Add-on support is limited and will be improved later.
Official Add-ons
The Official Add-ons are made by Herodirk and are released with the calculator.
This is the current list of them:
Days to Repay Setup: Calculates how many days until you made your money back, please do not rely on this statistic when choosing a setup.
Basic Minion Loop: For the chosen inputs, loop through all minions and show the top 10 for profit to the terminal.
Bad Luck Inferno: Calculates the profit without Inferno Vertexes, Inferno Apexes and Reaper Peppers, as those vary a lot from day to day. Good for getting the minimum daily profit.
Rising Celsius Override: Forces the Rising Celsius boost to max and runs the calculate function (does not automatically run other Add-ons that were selected for auto-run). Good for Inferno setups that do not sure at least 10 high tier minions.
Inferno Minion Loop: For the chosen inputs, loops through every combination of tier and amount, then filtered on the setup cost shows the top 10 for Bad Luck Inferno profit to the terminal. Minion, Fuel and Chest are forced to Inferno, Inferno Minion Fuel and XX-Large respectively.
The setup cost filter can be editted in the source code of the add-on as the variable cost_filter.
Be careful when downloading add-ons from other places, they are python programs and technically have full access to your computer.