Skip to content

Latest commit

 

History

History
229 lines (180 loc) · 8.89 KB

README.md

File metadata and controls

229 lines (180 loc) · 8.89 KB
Raw

Easy Access

Provides easier access to machines and producers in the game.

Contents

Features

Collect Outputs

Hit a configurable key to instantly collect output items from nearby producers.1

Config Option Description Default Value Other Value(s)
CollectOutputs Enables the Collect Outputs feature. "Location" "Disabled", "Default", "Location", "World" 2
CollectItems Assigns the keybind for collecting items. "Delete" Any valid button code.3
CollectOutputDistance Limits the distance that a producer can be collected from. 15 Any positive integer or -1.4
CollectOutputItems A list of context tags used to select allowed items. [] The tags to allow.5
  1. Included producers are determined by config options.
  2. See Range Values.
  3. See Button Codes.
  4. Measured in tiles away from the player. Use -1 for "unlimited" distance.
  5. See Item Tags.

Configurator

Use a Config Tool1 on a producer to bring up a menu to configure that producer.

Config Option Description Default Value Other Value(s)
Configurator Enables the Configurator feature. true true, false
  1. Use the command furycore_config_tool to get the Config Tool.

Dispense Inputs

Hit a configurable key to instantly dispense input items into nearby producers.1

Config Option Description Default Value Other Value(s)
DispenseInputs Enables the Dispense Inputs feature. "Location" "Disabled", "Default", "Location", "World" 2
DispenseItems Assigns the keybind for dispensing items. "Insert" Any valid button code.3
DispenseInputDistance Limits the distance that a producer can be dispensed into. 15 Any positive integer or -1.4
DispenseInputItems A list of context tags used to select allowed items. [] The tags to allow.5
DispenseInputPriority Prioritize certain producers over others. 0 Any integer value.
  1. Included producers are determined by config options.
  2. See Range Values.
  3. See Button Codes.
  4. Measured in tiles away from the player. Use -1 for "unlimited" distance.
  5. See Item Tags.

Supported Objects

  • Auto-Grabber
  • Bee House
  • Bone Mill
  • Cask1
  • Charcoal Kiln
  • Cheese Press
  • Coffee Maker
  • Crab Pots2
  • Crystalarium
  • Furnace
  • Geode Crusher
  • Heavy Tapper
  • Incubator
  • Keg
  • Lightning Rod
  • Loom
  • Mayonnaise Machine
  • Mushroom Box
  • Oil Maker
  • Ostrich Incubator
  • Preserves Jar
  • Recycling Machine
  • Seed Maker
  • Slime Egg Press
  • Slime Incubator
  • Soda Machine
  • Solar Panel
  • Statue of Endless Fortune
  • Statue of Perfection
  • Statue of True Perfection
  • Tapper
  • Wood Chipper
  • Worm Bin

Default Config:

  1. Only items of iridium quality will be extracted out of casks.
  2. Crab pots will only dispense regular bait into them.

Configurations

Item Tags

The game adds various Context Tags to each item which are used throughout this mod.

There are a few ways to see what context tags each item contains:

  • Enter the console command debug listtags to show all tags for the currently held item.
  • Refer to the Modding Docs for some tags (note may be outdated).
  • Install Lookup Anything, enable ShowDataMiningField in its config and hit F1 while hovering over any item.

Here are examples of some useful tags:

Description Tags
Category category_clothing, category_boots, category_hats, ...
Color color_red, color_blue, ...
Name item_sap, item_wood, ...
Type wood_item, trash_item, ...
Quality quality_none, quality_gold, ...
Season season_spring, season_fall, ...
Index id_o_709, id_r_529, ...

Range Values

The Range value limits which chests will be selected for a feature relative to the player.

  • Default - The value will be inherited from a parent config.1
  • Disabled - The feature will be disabled.
  • Location - Only chests in the players current location.
  • World - Any chest accessible to the player in the world.
  1. If parent value is unspecified, Location will be the default value.

Customization

Custom Producers

The config for producer types are stored in the producers.json in the assets folder.

If producers.json is not found, a default one for vanilla producers is automatically generated with all default settings.

furyx639.EasyAccess\\Producers
Add/replace producer settings by editing entries1.

Sample content.json:

{
  "Format": "1.24.0",
  "Changes": [
    {
      "Action": "EditData",
      "Target": "furyx639.EasyAccess\\Producers",
      "Entries": {
        "example.ModId_CustomCask": {
          "CollectOutputItems": "quality_iridium",
          "DispenseInputItems": "category_artisan_goods,!quality_iridium",
        }
      }
    }
  ]
}
  1. See the Edit Data docs for Content Patcher.

Other Assets

Icons

Replace any or all of the icons for the Collect Output or Dispense Input buttons by editing the image1:

furyx639.EasyAccess\\Icons.

Sample content.json:

{
  "Format": "1.24.0",
  "Changes": [
    {
      "Action": "EditImage",
      "Target": "furyx639.EasyAccess\\Icons",
      "FromFile": "assets/MyDispenseItemsButton.png",
      "FromArea": {"X": 0, "Y": 0, "Width": 16, "Height": 16},
      "ToArea": {"X": 16, "Y": 0, "Width": 16, "Height": 16}
    },
  ]
}
  1. See the Edit Image docs for Content Patcher.

Translations

See here for the base translation file.

Language Status Credits
Chinese ❌️ Not Translated
French ❌️ Not Translated
German ❌️ Not Translated
Hungarian ❌️ Not Translated
Italian ❔ Incomplete zomboide
Japanese ❌️ Not Translated
Korean ✔️ Complete wally232
Portuguese ✔️ Complete Aulberon
Russian ❌️ Not Translated
Spanish ❌️ Not Translated
Turkish ❌️ Not Translated