Skip to content

Commit 16d7a91

Browse files
added readme
1 parent f451acf commit 16d7a91

1 file changed

Lines changed: 14 additions & 6 deletions

File tree

README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,35 @@
11
# Apothic Tooltip Cleanup
22

3-
A client-side NeoForge 1.21.1 mod that cleans up the affix and gem tooltips Apotheosis adds to weapons, armor, and raw gems. Compatible with Apotheosis, Apotheotic Additions, and Apothic Attributes out of the box. Everything is configurable, every feature can be turned off.
3+
A NeoForge 1.21.1 mod that cleans up the affix and gem tooltips Apotheosis adds to weapons, armor, and raw gems. Compatible with Apotheosis, Apotheotic Additions, and Apothic Attributes out of the box. Everything is configurable, every feature can be turned off.
44

55
## features
66

77
- Truncate affix lists, hold Alt to expand. Configurable to show all, show top N (default 3), or hide all unless Alt is held.
88
- Compact gem tooltips on raw gems. Configurable modes: full, compact, ultra, hidden.
9+
- Hide individual gem categories from "Fits In" lists, useful on packs that disable certain weapon types.
910
- Merge empty sockets on socketed items into one summary line. Mixed sockets are supported: filled gems still render, with the empty count shown below.
1011
- Hide the bonus durability line.
1112
- Hide the Apotheosis affix summary block (Cold/Fire/HP%/Spell Resistance lines).
1213
- Hide the affix source line.
13-
- Custom rarity color overrides for all five tiers (Common, Uncommon, Rare, Epic, Mythic) plus an Ancient fallback color used for unknown rarities such as Apotheotic Additions's Esoteric.
14+
- Hide the `[⌛ MM:SS]` cooldown markers and `[Stacking]` tags on affix lines without touching the affix text. Hold Alt to reveal.
15+
- Custom rarity color overrides for the five built-in Apotheosis 8.x tiers (Common, Uncommon, Rare, Epic, Mythic), plus an Ancient color used as fallback for unknown rarities such as Apotheotic Additions's Esoteric.
1416
- Strip prefixes from affix names.
1517
- Sort affix lines by rarity, alphabetical, type, or default.
1618
- Hide individual affixes by translation key prefix.
1719
- Hide potion-style affix descriptions.
1820

1921
## configuration
2022

21-
All toggles are in `config/apothic_tooltip_cleanup-client.toml`. The file regenerates from defaults if deleted.
23+
Settings live in `config/apothic_tooltip_cleanup-client.toml`. The file regenerates from defaults if deleted.
2224

2325
## config reference
2426

2527
### affix display
2628

2729
`affix_display_mode` controls how affixes show on tooltips. Three options: `all` shows every affix, `top_n` shows the first N with Alt to expand the rest (default), `alt_only` hides every affix unless Alt is held.
2830

31+
The "Hold Alt for full details" prompt also appears when other handlers hide content. With `hide_durability_bonus` enabled, the prompt shows on durable items even when no affixes were truncated; pressing Alt reveals the durability line.
32+
2933
`affix_visible_count` is the N for `top_n` mode. Default 3.
3034

3135
`affix_sort_order` is one of `default`, `rarity`, `alphabetical`, `type`.
@@ -44,23 +48,27 @@ All toggles are in `config/apothic_tooltip_cleanup-client.toml`. The file regene
4448

4549
`disable_potion_descriptions` hides potion-style affix descriptions.
4650

51+
`hide_affix_extras` hides the `[⌛ MM:SS]` cooldown markers and `[Stacking]` modifier tags on affix lines. The affix text itself stays intact; only the bracketed annotations are stripped. Holding Alt while the item is hovered reveals the full line including the hidden markers.
52+
4753
### gem display
4854

4955
`gem_tooltip_mode` controls raw gem tooltips. `full` keeps Apotheosis's original layout. `compact` (default) strips headers and the Unique tag, keeps the bullets, and removes "level to existing" wording. `ultra` puts categories on one line and bonuses on one line. `hidden` removes all gem info.
5056

57+
`hidden_gem_categories` is a list of category names to hide from "Fits In" lists. Case-insensitive. Works in `full`, `compact`, and `ultra` modes; no effect when `gem_tooltip_mode` is `hidden` since that mode strips all gem info anyway. If every category is hidden, the "Fits In:" header is also dropped. Example: `["Bows", "Crossbows"]` on a pack that disables ranged weapons.
58+
5159
### sockets
5260

5361
`merge_empty_sockets` collapses empty sockets into one summary line. Filled gems still render normally; only the empty rows get merged. Default on.
5462

55-
`hide_apoth_marker` hides the `APOTH_SOCKET_MARKER` literal if Apotheosis leaks it through. Don't enable this unless you actually see it, since it can hide the socket UI on socketed items.
63+
`hide_apoth_marker` hides the `APOTH_SOCKET_MARKER` literal if Apotheosis lets it leak through. Don't enable this unless you actually see it, since it can hide the socket UI on socketed items.
5664

5765
### rarity colors
5866

59-
`rarity_colors_enabled` toggles custom rarity colors. When off (default), vanilla Apotheosis colors are used. The six color values use hex format `0xRRGGBB`. In Apotheosis 8.x, Ancient is no longer a built-in rarity tier, but the Ancient color still applies to unknown rarities such as Apotheotic Additions's Esoteric via namespace fallback.
67+
`rarity_colors_enabled` toggles custom rarity colors. When off (default), vanilla Apotheosis colors are used. The color values use hex format `0xRRGGBB`. Apotheosis 8.x has five built-in tiers (Common, Uncommon, Rare, Epic, Mythic); the Ancient color still applies as a fallback for unknown rarities such as Apotheotic Additions's Esoteric.
6068

6169
## compatibility
6270

63-
- Apotheosis (soft dependency, the mod does nothing without it)
71+
- Apotheosis 8.x (soft dependency, the mod does nothing without it)
6472
- Apotheotic Additions (optional, supported)
6573
- Apothic Attributes (optional, supported)
6674
- Fallen Gems & Affixes (tested compatible)

0 commit comments

Comments
 (0)