Configuration map¶
Item Rarity separates global switches from item data. Back up the config folder before a large change and edit files while the server is stopped when possible.
File locations¶
config/solsitemrarity-common.tomlMaster enable, tooltip and border options, stat multipliers, automatic equipment pool, equipment-only mode, weapon stats for tools, connected-tool compatibility.config/solsitemrarity/rarity_chances.jsonExplicit per-item random rarity pools.config/solsitemrarity/custom_rarities.jsonFixed-rarity additions and overrides.config/solsitemrarity/rarity_attributes.jsonPer-item base stat packages and custom lore.config/solsitemrarity/utility_buffs.jsonTool perk counts, selection weights, perk-tier odds, and effect values.config/solsitemrarity/setid_raritychances.jsonRandom pools for tagged item variants.config/solsitemrarity/setid_fixed-rarities.jsonFixed tiers for tagged item variants.config/solsitemrarity/setid_attributes.jsonStat packages for tagged item variants.config/solsitemrarity/config_version.jsonAutomatically managed schema marker. Do not edit it.Main TOML settings¶
[general]¶
| Key | Default | Values / range | Effect |
|---|---|---|---|
enabled |
true |
Boolean | Master rarity and UI switch |
showRarityInTooltip |
true |
Boolean | Shows the rarity line |
showAttributeBonuses |
true |
Boolean | Shows stat and Utility Perk sections |
showCustomBorders |
true |
Boolean | Enables rarity borders |
disableHotbarRarityBorders |
false |
Boolean | Hides only hotbar rarity borders; inventory and container borders remain enabled |
enableChromaTextEffects |
true |
Boolean | Animates item names and rarity-colored text |
enableAnimatedBorders |
true |
Boolean | Enables full decorative border animation |
borderRenderMode |
"FULL" |
FULL, SIMPLE, STATIC, OFF | Sets border complexity |
colorItemNames |
true |
Boolean | Colors tooltip and held-item names |
applyAttributeModifiers |
true |
Boolean | Applies equipment stats and gates Break Efficiency/custom mining speed |
disableConnectedToolPerks |
false |
Boolean | Disables only Vein Miner, Timber, Excavation |
treatAllToolsAsWeapons |
false |
Boolean | Allows detected utility tools to receive weapon bonuses and compatible Relic System stats while keeping tool perks |
equipmentOnlyRarities |
false |
Boolean | Restricts rarity display, rolls, and buffs to recognized weapons, tools, armor, and shields, including for JSON-listed items |
rainbowSpeed |
1500.0 |
100–10000; lower is faster | Chroma cycle duration |
defaultRarity |
"COMMON" |
Any tier name | Fallback for otherwise unmatched items |
An invalid border mode falls back to FULL. An invalid rarity name becomes Common.
[multipliers]¶
| Key | Default | Range |
|---|---|---|
common |
1.00 | 0.1–10 |
uncommon |
1.15 | 0.1–10 |
rare |
1.25 | 0.1–10 |
epic |
1.50 | 0.1–10 |
legendary |
2.00 | 0.1–10 |
mythical |
3.00 | 0.1–10 |
supreme |
5.00 | 0.1–20 |
Common remains skipped even if its multiplier is changed.
[defaultPool]¶
| Key | Default | Range |
|---|---|---|
common |
30 | 0–10000 |
uncommon |
28 | 0–10000 |
rare |
22 | 0–10000 |
epic |
12 | 0–10000 |
legendary |
5 | 0–10000 |
mythical |
2 | 0–10000 |
supreme |
1 | 0–10000 |
This pool affects only auto-detected equipment absent from rarity_chances.json. Edit the JSON to change listed vanilla gear.
Optional gameplay modes in v1.7.2¶
These settings belong in config/solsitemrarity-common.toml under [general]. Both gameplay modes are off by default; enable only the behavior your server wants.
Weapon bonuses on tools¶
Detected utility tools can receive weapon bonuses and become eligible for weapon stats in compatible Sol's Relic System builds. Their normal utility perks still work. With no applicable item or SetID stat package, the automatic tool package is +0.5 Attack Damage and +0.05 Attack Speed before rarity scaling. Explicit packages take priority.
This does not bypass applyAttributeModifiers, Relic System's crossMod.disableRarityStatBonuses, disableConnectedToolPerks, or the tool compatibility blacklist. See Stat attributes and Compatibility.
Equipment-only rarities¶
Only recognized weapons, utility tools, armor, and shields receive rarity display, rolls, and rarity buffs. Other items, such as diamonds and Nether Stars, stop displaying rarity even if they have fixed rules, random pools, or SetID entries. This eligibility check happens before the rule priority below; JSON rules cannot opt an excluded item back in.
The option does not erase saved rolls or config entries. Turning it off restores the normal rules for those items. The item lookup lists built-in defaults; it does not read your server's active settings.
Restart after changing either gameplay setting, then re-equip affected gear or relog to refresh active stats. For a visual-only hotbar switch, see Visuals and performance.
Rule priority¶
- SetID fixed rarity
- Item fixed rarity
- SetID random pool
- Item random pool
- Automatic equipment pool
- Default rarity
Attribute packages have their own priority:
- SetID attributes
- Item attributes
- Automatic package
Attribute packages replace lower-priority packages instead of merging with them.
Safe editing workflow¶
- Stop the server or make a backup.
- Edit one file at a time with a plain-text editor.
- Keep JSON keys and strings in double quotes.
- Validate commas and braces.
- Use
/sol itemrarity reloadfor JSON edits. - Re-equip changed gear or relog when active modifiers need to refresh.
- Restart after changing the common TOML.
Reload and existing items¶
| Change | Existing item rarity | Existing perk identity/tier | Existing effect values |
|---|---|---|---|
| Random pool weights | Unchanged | Unchanged | Unchanged |
| Perk count or selection weights | Unchanged | Unchanged | Unchanged |
| Perk-tier weights | Unchanged | Unchanged | Unchanged |
| Numerical perk effect arrays | Unchanged | Same tier | Updated value for that tier |
| Fixed rarity override | Effective displayed tier changes | Stored perks remain | Stat multiplier can change after refresh |
| Attribute package | Same rarity | Same perks | New package after re-equip/relog |
Client synchronization¶
The server sends JSON mappings, utility settings, and the disableConnectedToolPerks, treatAllToolsAsWeapons, and equipmentOnlyRarities flags to clients on join and reload. Most other TOML values are not included in that custom packet. Keep client and server TOML aligned for consistent presentation and tooltip calculations.
The serialized configuration limit is 262,144 characters.