> ## Documentation Index
> Fetch the complete documentation index at: https://docs.atlasscripts.net/llms.txt
> Use this file to discover all available pages before exploring further.

# Items & Icons

> The item keys atlasFishing expects, how to register them per inventory, and where icons go.

`atlasFishing` uses real inventory items for the rod, bait, and catches. If an item is missing, players may be unable to buy supplies, use bait, receive a catch, or sell it. The keys must match between `config.lua`, your inventory definitions, and (for some inventories) the icon filenames.

## Definition files

The resource ships ready-to-copy item files in `items/`, generated to match `config.lua` exactly:

```text theme={null}
atlasFishing/items/ox_inventory.lua
atlasFishing/items/qb-core.lua
```

<Tabs>
  <Tab title="ox_inventory">
    Paste the block from `items/ox_inventory.lua` inside the returned items table in `ox_inventory/data/items.lua`, then drop the icons into `ox_inventory/web/images/`.
  </Tab>

  <Tab title="qb-core">
    Paste the block from `items/qb-core.lua` inside `QBShared.Items` in `qb-core/shared/items.lua`, then drop the icons into your inventory's image folder.
  </Tab>

  <Tab title="Other inventory">
    Recreate the same keys and labels in whatever format your inventory expects. The keys matter more than the labels.
  </Tab>
</Tabs>

See [Installation → Inventory items](/atlas-fishing/installation#inventory-items) for the full step-by-step.

## Required item keys

Labels can change freely; **keys must match** the config and your inventory.

### Rod

```text theme={null}
fishing_rod
```

The rod is registered usable automatically by the script (`Bridge.Inventory.RegisterUsableItem(Config.rod.item)`) — no extra wiring. Just make sure the item exists.

### Baits

```text theme={null}
bait_worms
bait_dough
bait_minnow
bait_shrimp
bait_squid
bait_lure
```

### Catches (24 fish)

```text theme={null}
fish_anchovy   fish_sardine   fish_bluegill  fish_mackerel  fish_crab
fish_trout     fish_bass      fish_mullet    fish_catfish
fish_snapper   fish_barracuda fish_mahi      fish_salmon    fish_lobster  fish_octopus
fish_tuna      fish_sailfish  fish_sword     fish_sturgeon
fish_marlin    fish_hammer    fish_white     fish_turtle    fish_koi
```

<Note>
  **Junk** catches in the default config (conch, scallop, clam, oyster, starfish, sea urchin) are **not** inventory items. They have no `item` key — they only produce a "you pulled up junk" result with a prop, so they need no definition. You can disable them entirely with `Config.junk = { enabled = false }`.
</Note>

## Icons

Icons ship in both formats:

```text theme={null}
atlasFishing/items/icons/png
atlasFishing/items/icons/webp
```

Copy the format your inventory supports into its image folder. **PNG is the safest choice** — many inventory UIs still expect PNG filenames. Use WebP only if you know your UI supports it.

<Note>
  These inventory icons are separate from the **shop / bait-radial / sell-radial** art, which loads from the resource's own `images/` folder by default. See [`Config.Images`](/atlas-fishing/configuration#artwork-config-images) for the artwork system (local PNGs, missing-file fallback, and switching to a CDN).
</Note>

## Renaming an item

If you rename an item, update every reference:

<Steps>
  <Step title="Inventory definition">
    Change the key in your inventory item file.
  </Step>

  <Step title="Config">
    Update the matching key in `Config.rod.item`, `Config.baits`, `Config.fish`, or `Config.shop.items`.
  </Step>

  <Step title="Icon filename">
    Rename the icon file if your inventory expects filenames to match item keys.
  </Step>

  <Step title="Restart">
    Restart the inventory resource, `atlasBridge`, and `atlasFishing`.
  </Step>
</Steps>

## Common mistakes

<AccordionGroup>
  <Accordion title="The shop opens but buying fails">
    The item key may not exist in your inventory, or the payment account in `Config.shop.payments` may not be supported by your framework.
  </Accordion>

  <Accordion title="Fish catches do not appear in inventory">
    Confirm every fish key from `Config.fish` exists in your inventory item definitions, and that the inventory has room.
  </Accordion>

  <Accordion title="Icons are blank">
    Your inventory image folder may use a different path or extension rule. Copy the PNG set first and confirm the filenames match the item keys.
  </Accordion>
</AccordionGroup>