================================================================================
                    SOL'S ITEM RARITY MOD - v1.4.0
                         Configuration Guide
================================================================================

This mod assigns rarity tiers to items. Configuration is split across
several JSON files in this folder. After editing any file, run:
  /sol itemrarity reload


================================================================================
                           RARITY TIERS
================================================================================

  COMMON      White text                   (1.0x stat multiplier)
  UNCOMMON    Green & White chroma          (1.15x)
  RARE        Cyan & White chroma           (1.25x)
  EPIC        Blue & White chroma           (1.5x)
  LEGENDARY   Rainbow chroma                (2.0x)
  MYTHICAL    Black & White chroma          (3.0x)
  SUPREME     Red & Black chroma            (5.0x)


================================================================================
                        PRIORITY ORDER
================================================================================

When the mod decides an item's rarity, it checks in this order:

  1. SetID fixed rarity      (setid_fixed-rarities.json)
  2. Fixed rarity             custom_rarities.json overrides,
                              then internal hardcoded vanilla rarities
  3. SetID rarity pool        (setid_raritychances.json)
  4. Rarity chance pool        (rarity_chances.json)
  5. Auto-detect               weapons/armor get a random rarity
                              from the defaultPool (see TOML config)
  6. Default                  COMMON

The first match wins. For example, if an item is in both
custom_rarities.json AND rarity_chances.json, the fixed rarity
from custom_rarities.json is used.


================================================================================
                  FILE 1: rarity_chances.json
                       (Rarity Pools)
================================================================================

Items listed here roll a RANDOM rarity when first picked up.
Weights are relative â€” bigger number = more likely.

FORMAT:
  "modid:item_name": {
    "TIER": weight,
    "TIER": weight
  }

EXAMPLE:
  "minecraft:diamond_sword": {
    "COMMON": 40,
    "UNCOMMON": 30,
    "RARE": 20,
    "EPIC": 8,
    "LEGENDARY": 2
  }

  40+30+20+8+2 = 100 total  =>  40% Common, 2% Legendary, etc.

Omit a tier to exclude it from the pool entirely.

NOTE: Vanilla weapons/armor are already listed here by default.
      Items NOT listed here and not in custom_rarities.json will
      fall through to auto-detection (priority 5).


================================================================================
                  FILE 2: custom_rarities.json
                  (Player-Defined Fixed Rarities)
================================================================================

Items listed here always have the SAME rarity â€” no randomness.
Use this for collectibles, blocks, materials, or to override
the mod's built-in vanilla rarities.

FORMAT:
  "modid:item_name": "TIER"

EXAMPLES:
  {
    "someMod:custom_gem": "LEGENDARY",
    "minecraft:nether_star": "SUPREME"
  }

The second example overrides the built-in MYTHICAL rarity for
Nether Stars with SUPREME instead.

Most vanilla items already have built-in rarities (dragon egg,
nether star, emeralds, etc.). You only need this file for:
  - Modded items you want a fixed rarity on
  - Vanilla items where you want to CHANGE the built-in rarity


================================================================================
                  FILE 3: rarity_attributes.json
                       (Stat Bonuses)
================================================================================

Items listed here gain bonus stats based on their rarity.
The base value is multiplied by the rarity multiplier.

AVAILABLE ATTRIBUTES:
  attackDamageBonus           Extra attack damage
  attackSpeedBonus            Faster attacks
  armorBonus                  Extra armor points
  armorToughnessBonus         Extra toughness
  maxHealthBonus              Extra HP (2.0 = +1 heart)
  movementSpeedBonus          Faster movement
  knockbackResistanceBonus    Resist knockback (0.0-1.0)
  luckBonus                   Better loot
  miningSpeedBonus            Legacy/custom tool mining speed (0.03 = 3% before rarity scaling)

Utility tools ignore combat attributes. Default tools now roll Utility Perks from utility_buffs.json.

EXAMPLE:
  "minecraft:diamond_sword": {
    "attackDamageBonus": 0.8,
    "attackSpeedBonus": 0.08
  }

  If the sword rolls EPIC (1.5x):
    +0.8 x 1.5 = +1.2 Attack Damage
    +0.08 x 1.5 = +0.12 Attack Speed


================================================================================
                     SETID CONFIGS
              (Unique / Custom Item Variants)
================================================================================

Give any item a {SetID:"value"} NBT tag, then configure it:

  /give @p minecraft:diamond_sword{SetID:"boss_drop"} 1

FILES:
  setid_fixed-rarities.json   Fixed rarity for SetID items
  setid_raritychances.json    Rarity pool for SetID items
  setid_attributes.json       Stat bonuses for SetID items

CONFIG KEY FORMAT:
  "modid:item{SetID:value}"

EXAMPLE (setid_fixed-rarities.json):
  {
    "minecraft:diamond_sword{SetID:boss_drop}": "SUPREME"
  }

EXAMPLE (setid_raritychances.json):
  {
    "minecraft:diamond_sword{SetID:boss_drop}": {
      "EPIC": 40, "LEGENDARY": 35, "MYTHICAL": 20, "SUPREME": 5
    }
  }

EXAMPLE (setid_attributes.json):
  {
    "minecraft:diamond_sword{SetID:boss_drop}": {
      "attackDamageBonus": 2.0, "attackSpeedBonus": 0.15
    }
  }

SetID configs have the HIGHEST priority. A SetID fixed rarity
will always override everything else for that specific item+tag.


================================================================================
                       AUTO-DETECTION
================================================================================

Any weapon or armor (vanilla or modded) NOT listed in any config
file will automatically roll a rarity from the "defaultPool"
weights defined in the TOML config (itemrarity-common.toml).

Auto-detected item types:
  Swords, Axes, Pickaxes, Shovels, Hoes, Bows, Crossbows,
  Tridents, Shields, all Armor pieces

Everything else defaults to COMMON (no random roll).

To override auto-detection for a specific item, add it to
rarity_chances.json (for a custom pool) or custom_rarities.json
(for a fixed rarity).


================================================================================
                           TIPS
================================================================================

  - Press F3+H to see item IDs in tooltips
  - Use /sol itemrarity reload after editing ANY config file
  - Modded items: "modid:item_name"
  - General settings are in: config/itemrarity-common.toml
  - Priority: SetID Fixed > Custom/Internal Fixed > SetID Pool
              > Item Pool > Auto-detect > Default COMMON

================================================================================
                    Made by solmochi - Enjoy!
================================================================================
