Configuration Instructions - AHilyard/LegendaryTooltips GitHub Wiki
By default, this mod does not apply special borders to most items. It was designed to work well with mod packs where the available selection of items can vary widely, so it is up to the user or mod pack designer to customize as needed.
If you'd rather just use a standard configuration that works well with vanilla and some mods, I highly recommend just using one of the noconfig versions of Eclectic Trove, found here: https://www.curseforge.com/minecraft/texture-packs/eclectic-trove-legendary-tooltips/files
These versions have configuration built-in so you don't need to change anything for it to work.
For additional customization of which items have which borders, you'll need to edit the config file (I recommend you not use a noconfig version of Eclectic Trove, as it will apply before changes in the config file, and likely cause confusion). The config file is located in your minecraft config
directory, which is next to the mods
directory where you've installed Legendary Tooltips. Within this directory you will find a file with "legendarytooltips" in the name, for example legendarytooltips-common.toml
for all recent versions.
You will need to use a text editor to modify this file--if you don't know what to use, Notepad is included on Windows and works well. Open the file with your text editor and then read the following section to understand how to configure:
There are many options available for setting up which custom borders (also called frames) apply to which items. Follow these steps:
- Decide which items you want to have custom borders, and which borders. Note that each custom border has a number associated with it (starting at 0).
- For each custom border you want to use, fill out the associated list in the "definitions" section. This will be filled out with a list of "selectors", each of which tell the mod what items have that border. A selector generally has a special symbol followed by text. See the selector reference below for information on all supported selectors.
- Selectors for borders are checked in the order provided in the "priorities" section. Once a match is found, that border is displayed. For example, if border 0 had the selector "%Diamond" and border 1 had the selector "diamond_sword", they would both match for diamond swords. In this case, whichever border number came first in the priority list would be the border that would get drawn in-game.
- Optionally, border colors associated with custom borders can be set in the "colors" section. The start color is the color at the top of the tooltip, and the end color is the bottom, with a smooth transition between. Please read the information above the color section for specifics.
Setting up entries to determine which items will have which borders:
[client.custom_borders.definitions]
level0_entries = ["!epic"]
level1_entries = ["!rare"]
level2_entries = ["!uncommon"]
level3_entries = ["%nether", "%Nether"]
level4_entries = []
level5_entries = []
level6_entries = []
level7_entries = ["$minecraft:music_discs"]
level8_entries = ["&Enchantments"]
level9_entries = []
level10_entries = []
level11_entries = []
level12_entries = []
level13_entries = []
level14_entries = []
level15_entries = []
The above will apply border 0 to all epic rarity items, border 1 to all rare items, border 2 to all uncommon items.
It will also apply border 3 to any items with "nether" or "Nether" in the name (this is case sensitive so you need to include both capitalized and uncapitalized to catch both), border 7 to all music discs, and border 8 to all enchanted items.
Setting up border colors:
Legendary Tooltips versions before 1.3.0
[client.colors]
level0_start_color = 0x996922
level0_end_color = 0x5A3A1D
level0_bg_color = 0xF0160A00
level1_start_color = "#996922"
level1_end_color = "#5A3A1D"
level1_bg_color = "#F0160A00"
level2_start_color = -6723294
level2_end_color = -10864099
level2_bg_color = -266991104
level3_start_color = 4288244002
level3_end_color = 4284103197
level3_bg_color = 4027976192
level4_start_color = "red"
level4_end_color = "dark_red"
level4_bg_color = "black"
The above partial examples show the five different color formats accepted. The first four borders (border 0 - 3) are all different representations of the same colors. The colors used for border 4 are different, and show some of the accepted color names. The colors accepted for this format are all the built-in Minecraft colors (see below for reference).
Legendary Tooltips versions 1.3.0+
[client.colors]
level0_colors = [0x996922, 0x5A3A1D, 0xF0160A00, 0xF0160A00]
level1_colors = ["#996922", "#5A3A1D", "#F0160A00", "#F0160A00"]
level2_colors = [-6723294, -10864099, -266991104, -266991104]
level3_colors = [4288244002, 4284103197, 4027976192, 4027976192]
level4_colors = ["red", "dark_red", "black", "black"]
level5_colors = ["chartreuse", "darkorange", "deeppink", "transparent"]
level6_colors = ["red+h15", "saddlebrown-v20+s5", "aqua=a220", "turquoise=a235-v20"]
level7_colors = ["10_black_gold_orange", "10_orange_black_gold", "20_red_green", "20_red-v20_green-v25"]
level8_colors = ["auto", "auto", "auto", "auto"]
As of Legendary Tooltips 1.3, colors are now organized in a more compact form, with one line per border. Up to four colors can be specified in each list, which represents the border start color, border end color, background start color, and background end color. Any colors not specified will be replaced with a default automatic color.
As of 1.3, the Prism library is used to handle all color definitions, so detailed information can be found on the Prism documentation wiki. In addition to the available definitions provided by Prism, you can also specify "auto", which will automatically grab matching colors from the border image to provide a nice-looking tooltip.
dark_red
red
gold
yellow
dark_green
green
dark_aqua
aqua
dark_blue
blue
dark_purple
light_purple
black
dark_gray
gray
white
Note: Legendary Tooltips uses the Iceberg library to handle selectors, the full documentation can be found here. The following is a truncated list of options.
-
Item name - Use item name for vanilla items or include mod name for modded items. Matches only the item(s) with this exact internal name.
Examples: "minecraft:stick", "iron_ore"
-
Tag - $ followed by tag name. Matches all items with the specified tag.
Examples: "$forge:stone" or "$planks"
-
Mod name - @ followed by mod identifier. Matches all items from the specified mod.
Examples: "@spoiledeggs"
-
Rarity - ! followed by item's rarity. This is ONLY vanilla rarities. Matches all items with the specified rarity.
Examples: "!uncommon", "!rare", "!epic"
-
Display name - % followed by any text. Will match any item with this text in its tooltip display name. Matches all items where the tooltip's first line contains the specified text. This is case-sensitive.
Examples: "%Uncommon"
-
Tooltip text - ^ followed by any text. Will match any item with this text anywhere in the tooltip text (besides the name). Matches all items where the tooltip's text (not including the first line) contains the specified text. This is case-sensitive.
Examples: "^Legendary"
-
NBT tag - & followed by tag name and optional comparator (=, >, <, or !=) and value, in the format or just . Matches all items that have NBT tags that match the specified name and/or value comparison.
Examples: "&Damage=0", "&Tier>1", "&map!=128", "&Enchantments"
If something isn't working right or you have a question not covered above, consult the following table for potential solutions:
Problem | Try This |
---|---|
How do I know which number to use for a border from Eclectic Trove? | The border numbers are listed on the CurseForge page. Here they are for convenience: 0. Gold frame 1. Silver frame 2. Copper frame 3. Smoke and flames 4. Water / Ice 5. Rose and vines 6. Bones / death 7. Iron plating / machinery 8. Purple geometric motif 9. Holy (halo / wings) 10. Deep Dark (version 1.3+) |
After installing Legendary Tooltips, the game crashes or the mod doesn't appear to be installed. | Make sure you have installed the correct version. The mod is available for both Forge and Fabric, and they are easy to mix up. Forge version: https://www.curseforge.com/minecraft/mc-mods/legendary-tooltips Fabric version: https://www.curseforge.com/minecraft/mc-mods/legendary-tooltips-fabric |
After changing the config file, the game crashes. | You've made a typo or mistake in the config file. Make sure you are entering everything in the correct format. All selectors on the border entries lines must be surrounded in quotes. |
The changes I made in the config file aren't reflected in-game unless I restart Minecraft. | Since Legendary Tooltips 1.2.0, all changes to the config file should be automatically reloaded without closing the game. Unfortunately, this doesn't always happen due to a bug in Forge's config system. (Yes, even the Fabric version of Legendary Tooltips uses Forge's config system.) If you find that your changes aren't being updated in-game immediately, try re-saving your config file a few times waiting a few seconds between each save. |
Some items have borders that shouldn't or some items have the wrong borders. | You likely have installed a noconfig version of Eclectic Trove, which has its own configuration built-in. The changes you make in the config file will take priority, but if you'd rather configure everything from scratch you should use a standard version of Eclectic Trove instead. |