Overriding Data Tables

Introducing Data Overriding

Data File Reference

adventures.txt, bounty.txt, buffbots.txt, classskils.txt, coinmasters.txt, combats.txt, concoctions.txt, consequences.txt, encounters.txt, equipment.txt, familiars.txt, faxbots.txt, foldgroups.txt, fullness.txt, inebriety.txt, items.txt, modifiers.txt, monsters.txt, nonfilling.txt, npcstores.txt, outfits.txt, packages.txt, pulverize.txt, restores.txt, spleenhit.txt, statuseffects.txt, zapgroups.txt, zonelist.txt.

Introducing Data Overriding

KoLmafia uses a combination of data files in order to determine what is listed on the various lists throughout KoLmafia. In general, these data files are packaged within the JAR and are therefore never actually seen. However, users are permitted to override any/all of the data files they wish -- all you have to do is follow these steps:

1. Download the data file which you wish to override
2. Copy the file to the "data" folder. If you don't have one, you will need to create one.
3. Restart KoLmafia -- the data files you downloaded will now override the ones inside the JAR

Note, however, that overriding data files means that you will not get any updates to these data files that are packaged with the JAR, and you have to remember to delete all override files to use the packaged updates.

Data File Reference

The following section outlines the structure of each line in the data files available to users of KoLmafia. Note that whitespace between elements in angle brackets are actually meant to be tabstops.

adventures.txt: <zone_name> <phpfile>=<action_id> <attributes> <areaname> <goals>

This file contains data used by KoLmafia to determine where to adventure and the prime stat requirements before the area can be visited. This file can be modified so that users can clear out areas which they never visit to condense the list displayed on the adventure pane. Note that direct modification of the file in this fashion may cause KoLmafia to no longer load properly after login.

bounty.txt: <bounty item name> <pluralname> <type> <image> <number> <monster> <best location>

This file contains data used by KoLmafia to track progress toward completing a Bounty Hunter Hunter quest.

buffbots.txt: <bot_name> <bot_id> <xml_file>

This file contains data used by KoLmafia to determine which buffbots should be checked when invoking the buffbot request panel. These buffbots are assumed to have a dynamic pricing model and are assumed to document all of their buffs in the specified XML file.

classskills.txt: <skill_id> <skillname> <skillimage> <skilltype> <mpcost> <duration_per_cast> <level (optional)>

This file contains data used by KoLmafia to determine what skills are available. This file can be modified so that users can define new skills which are added, or can be used to forcibly cause a skill to not appear on the buff list if you're attempting to streamline the buffbot interface (by designating it as not a buff). Note that changing this file also affects the command-line interface and removing the skill will make it unrecognizable.

coinmasters.txt: <shopname> <buy/sell> <currency gained/lost> <item bought or sold> <ROW, quantity sold>

This file contains data used by KoLmafia to track items available in NPC shops that use a currency other than meat.

combats.txt: <area_name> <combat_rate> <monster_distribution>

This file contains data used by KoLmafia to determine what the combat distribution is for the areas included in KoLmafia's adventure database. The monster distribution strictly only includes the weighted distribution of monster appearance probability.

concoctions.txt: <itemname> <creationmethod> <ingredients>

This file contains data used by KoLmafia to determine what can be created. The order of ingredients does not matter; however, due to limitations in the current engine an item can only be created through one set of ingredients and one creation method, no matter how many methods are listed in this file. Note that there are comment lines scattered throughout the concoctions database for organizational purposes.

consequences.txt: <type> <spec> <regex> <action>

This file contains data used by KoLmafia to update tracked values when looking at items/skills/effects, and also for recognizing monsters when the name provided by KoL is not immediately distinct.

encounters.txt: <areaname> <type> <encounter_title>

This file contains data used by KoLmafia to recognize various special encounters.

equipment.txt: <itemname> <power> <requirement> [handedness]

This file contains data used by KoLmafia to determine the power of equippable items and the basic stat requirement for equipping the item. The equipment power is as listed on the item description page, but may fall out of date pending on changes to the KoL item database. The handedness field is used for weapons and is used to determine how many hands are used by the given weapon, which determines the availability of the hand for an off-hand item.

familiars.txt: <familiar_id> <name> <image> <type> <larva_name> <main_eq> <skill1> <skill2> <skill3> <skill4>

This file contains a list of all the familiars and information relating to each familiar.

faxbots.txt: <botname> <xml_url>

This file contains data used by KoLmafia to determine which faxbots should be checked when invoking the faxbot request panel. These faxbots are assumed to have a dynamic monster list and are assumed to document all of their monsters in the specified XML file.

foldgroups.txt: <damage> <item1> <item2> ...

This file lists the damage dealt by folding an item (as a percent of maximum HP) and all items in the group, in the order they will cycle through.

fullness.txt: <itemname> <fullness> <level_req> <quality> <adv_gain> <mus_gain> <mys_gain> <mox_gain> <notes (optional)>

This file indicates how much fullness a given food item has, with additional information provided courtesy of the Garden of Earthly Delights' mixologist (here). It really serves no other purpose, but as with all other data files, it's accessible to the advanced script handler, and therefore it might be useful to know about it.

inebriety.txt: <itemname> <inebriety> <level_req> <quality> <adv_gain> <mus_gain> <mys_gain> <mox_gain> <notes (optional)>

This file indicates how much drunkenness a given booze item has, with additional information provided courtesy of the Garden of Earthly Delights' epicure (here). It really serves no other purpose, but as with all other data files, it's accessible to the advanced script handler, and therefore it might be useful to know about it.

items.txt: <itemid> <itemname> <descriptionid> <image> <usetype> <access> <autosell> <plural (optional)>

This file lists information for handling and recognizing every item.

modifiers.txt: <itemname> <modifiers>

This file shows you all the modifiers for a piece of equipment or for a status effect and it is used by KoLmafia to generate the bonus summary that's available in the left hand side of the main interface.

monsters.txt: <monster_name> <monster_image> <monster_stats> <drop_rates>

This file contains data used by KoLmafia to indicate the stats and drop rates for many of the mobile creatures located in the Kingdom of Loathing.

nonfilling.txt: <itemname> <level>

This file lists the level required to use items that do not fill stomach/liver/spleen, and therefore would not normally have a level requirement.

npcstores.txt: <storename> <store_id> <itemname> <price>

This file contains a list of all the items which are available from the non-class stores hosted by NPCs, as opposed to PCs. Items and stores in this list will turn up in KoLmafia mall searches. Because the contents of NPC stores are rarely updated, there should be no reason to modify this file unless one doesn't plan on purchasing the specified items from NPC stores and wishes to have a picture of what the mall looks like, without factoring in NPC stores. Quantities for items in these stores are assumed to be near-infinite.

outfits.txt: <outfit_id> <outfit_name> <item_list>

This file contains a list of all the outfits which are available to all players. Modifying this file to add custom outfits will not work.

packages.txt: <package_name> <package_id> <capacity> <price>

This file contains a list of all the package types which currently can be sent from the gift shop back room in the Market Square. This file is used to determine how packages should be split on sending when items are above capacity, and also which packages can be selected in the drop-down menu. Note that this file is rarely up-to-date due to the slow speed at which my ascensions take place, but it will be updated whenever sufficient data is acquired for this purpose.

pulverize.txt: <itemname> <result>

This file lists the results of pulverizing items that have nonstandard yields. It is used in the Pulverize section of the Item Manager, among other places.

restores.txt: <name> <type> <hp_min> <hp_max> <mp_min> <mp_max> <adv_cost> <uses_left (optional)> <notes (optional)>

This file lists the yields from HP and MP restoring sources.

spleenhit.txt: <itemname> <spleenhit> <level_req> <quality> <adv_gain> <mus_gain> <mys_gain> <mox_gain> <notes (optional)>

This file indicates how much spleen uses a given spleen item has.

statuseffects.txt: <effect_id> <effect_name> <image_url> <description_id> <acquire_command (optional)>

This file contains data used by KoLmafia to recognize status effects. It also allows more of an effect to be easily gained.

zapgroups.txt

This file lists groups of items that can be zapped. It is used for filtering the list of items to try zapping, among other things.

zonelist.txt: <zone_id> <parent_zone> <zone_name>

This file contains data used by KoLmafia to determine the names of the zones listed in the adventure table. Those who wish to use a different grouping and/or categorization scheme (either for sorting or for the hide-zones feature) are invited to modify this table as well as the adventure table -- note that if there are fewer zones listed in this file than the zones used for the adventure table in KoLmafia, KoLmafia is likely to crash.