D2RMM-Loot-Filter-Extended

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

D2RMM-Loot-Filter-Extended

★ 17 Open GitHub ↗

A Diablo II: Resurrected loot filter mod for D2RMM

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Caedendi's Extended Loot Filter for D2RMM

_See also: [Caedendi's Simple Loot Filter for D2RMM](https://github.com/Caedendi/D2RMM-Loot-Filter-Simple)_

Adds an expansive customizable loot filter with a shitload of presets to Diablo II: Resurrected using D2RMM. 
Hide junk, clean up tooltips to remove clutter and emphasize important items in various ways. For the full feature list, see below.

Recommended for those who prefer toggling presets to reach their desired functionality. 
If you'd rather have a compact list to act as a template for your own naming schemes, see the Simple version at the bottom of the page.

## Table of Contents

- [Screenshots](#screenshots)
- [Changelog](#changelog)
  - [3.0.0 (work in progress)](#300-work-in-progress)
  - [2.1.1](#211)
  - [2.1.0](#210)
  - [2.0.1](#201)
  - [2.0.0](#200)
  - [1.0.0](#100)
- [How to Install](#how-to-install)
- [Features](#features)
- [Presets Overview](#presets-overview)
  - [Text Colors](#text-colors)
- [Roadmap](#roadmap)
  - [Fix known bugs](#fix-known-bugs)
  - [Add features](#add-features)
- [Recommended Mods](#recommended-mods)
- [License/Permissions](#licensepermissions)
- [Credits](#credits)
  - [Code](#code)
  - [Filter Style](#filter-style)
- [My Mods + Source](#my-mods--source)
  - [Diablo II: Resurrected](#diablo-ii-resurrected)

## Screenshots

## Changelog

### 3.0.0 (work in progress)

- Introducing Drop Sounds! Configure new sound effects for when select item types drop so you'll never miss a drop again!
- For those running custom filter options: all colors have been renamed to the standardized name they most closely resemble (see [/docs/colors.md](https://github.com/Caedendi/D2RMM-Loot-Filter-Extended/blob/master/Docs/colors.md) for details)
- Added multi-line tooltips! Enable for select items to increase the height of the tooltips of items on the ground and optionally add a purple "Pick Up" message above the name. If you prefer to have a big transparent box instead of highlight characters, enable highlighting and set the highlight character to _space_
- Added personal filter list for all items! Supports _all_ (base) items, sets and uniques in item-names.json. Search for _[CSTM-CFL]_ in the code and add whatever you'd like
- Added option to customize the tooltip color for Ethereal items when on the ground (recommended: light teal)
- Added option to disable _all_ Light Pillars
- Added customization of the Gold amount color _(in addition to the existing suffix customization)_
- Added customization of the highlight color _(can now be set to colors other than tomato red)_
- Added customization of the alternate rune color scheme _(can now be set to colors other than dark violet)_
- Added _space_ as a highlight character option
- Split runes into 4 tiers, each of which you can individually enable/disable visibility, Light Pillars, Drop Sounds and big tooltips for
- Changed the Light Pillars setting for Quest Weapons from "exclude" to "include" 
- Mod settings have been overhauled. Delete your config.json to start from scratch to prevent issues.

### 2.1.1

- Fixed tooltip mods (broken since 2.0.0)

### 2.1.0

- Added option to disable light pillars for hidden items

### 2.0.1

- Removed light pillar support for circlets

### 2.0.0

- The mod settings menu is now divided into sections. Make sure to use D2RMM 1.4.6 or higher!
- Fixed high rune numbers incorrectly being highlighted in red when number is enabled and highlighting is disabled
- Fixed half of the quest items not having highlighting patterns
- Fixed the cube window's title being all messy when highlighting quest items is enabled by adding an option to exclude the cube
- Fixed Hell Forge Hammer incorrectly displaying as "Hellforge Hammer" when highlighting is enabled
- Fixed some gem names not being filtered correctly
- Fixed bugged support for charms and added highlighting of id'd uniques
- Removed bugged support for jewels, rings and amulets as they can't be fixed
- Changed Small/Full Rejuvenation Potion name from +SRP/+FRP to +RPS/+RPF
- Improved highlight patterns
- Added highlighting to Rainbow Facets
- Added built-in ilvl support and fixed indentation being all messy for highlighted items when ilvl is enabled
- Added built-in short superior/inferior prefixes mod
- Added built-in item quality (normal/exceptional/elite) tags
- Added built-in expanded light pillar support (for a lot more item types than currently available in other mods)
- Added alternate color schemes for runes, facets and sunder charms
- Added customization of the highlight character (can now be set to characters other than *)
- Custom sections in the code are now pre-filled with examples, making it more intuitive for those who want to add their own custom naming

### 1.0.0

First official release!

## How to Install

- Download and install [D2RMM](https://www.nexusmods.com/diablo2resurrected/mods/169), then run it.
- Download and extract this mod folder to /D2RMM/mods/.
- See D2RMM instructions on how to configure and enable.
- Play the game!

## Features

For a full list of features, see [Presets Overview](#presets-overview) below.
  
- **Customize to your liking:**
  - Alter or hide each item type to your preference using the presets in the D2RMM settings.
  - Shorten or hide junk.
  - Emphasize the good/important stuff (runes, flawless gems, essences, uber keys/organs, quest items, etc).
- **Completely optional:** 
  - Disabling everything means no modding will be applied.
- **Integrated mods:**
  - Show the item level on all items that have one.
  - Shorten superior/inferior prefixes to + and -.
  - Show the item quality (normal/exceptional/elite) on all equipment with short (n), (x) and (e) tags.
  - Shine light pillars on those special drops! Mod functionality expanded to support runes, rings/amulets, gems, jewels, quest items and endgame items.
- **Apply your own custom naming schemes**:
  - Set the item type to "Custom", open the mod.js file in Notepad or VSCodium and add your personalized naming schemes on the lines mentioned in the item type's setting description.
  - To hide an item, change its name to HIDDEN (without quotes). The value of HIDDEN (amount of spaces) can be changed in the D2RMM settings.
  - Don't forget to reload and apply in D2RMM!
- **Item tooltip customization:**
  - Modify the size and background opacity of the tooltip for items on the ground and in the inventory.

## Presets Overview

| Section | Setting | Default | Options |
|:--------------------------:|:--------------------------------------:|:-------:|:----------------------------------------------------------------|
| **Gold & Runes** | **Gold: Color** | | No change |
| | | | All gold |
| | | | Gold G |
| | | x | White amount, gold suffix |
| | | | Gold amount, white suffix |
| | | | Custom |
| | **Gold: Suffix** | | No change |
| | | x | G |
| | | | Hide suffix |
| | | | Custom |
| | **Runes** | | No change |
| | | x | Add rune numbers + highlights + remove affix |
| | | | Add rune numbers + highlights |
| | | | Add rune numbers + remove affix |
| | | | Add highlights + remove affix |
| | | | Add rune numbers |
| | | | Add highlights |
| | | | Remove affix |
| | | | Custom |
| | **Show Runes: Low** | On | On/Off |
| | **Show Runes: Low-Mid** | On | On/Off |
| | **Show Runes: Mid** | On | On/Off |
| | **Show Runes: High** | On | On/Off |
| **Junk** | **Healing Potions** | | No change |
| | | x | All |
| | | | Hide lvl 3 |
| | | | Hide lvl 4 |
| | | | Hide lvl 3 + small rejuvs |
| | | | Hide lvl 4 + small rejuvs |
| | | | Show only rejuvs |
| | | | Show only full rejuvs |
| | | | Hide all |
| | | | Custom |
| | **Buff Potions** | | No change |
| | | x | All |
| | | | Hide |
| | | | Custom |
| | **Throwing Potions** | | No change |
| | | x | All |
| | | | Hide |
| | | | Custom |
| | **Scrolls & Tomes** | | No change |
| | | x | All |
| | | | Hide scrolls |
| | | | Custom |
| | **Arrows & Bolts** | | No change |
| | | x | Highlight |
| | | | Hide |
| | | | Custom |
| | **Keys** | x | No change |
| | | | Hide |
| | | | Custom |
| **Jewelry** | **Gems** | | No change |
| | | x | Highlight all |
| | | | Highlight, show only flawless & perfect |
| | | | Highlight, show only perfect |
| | | | Hide all |
| | | | Custom |
| | **Jewels** | | No change |
| | | x | Highlight Facets |
| | | | Custom |
| | **Charms** | | No change |
| | | x | Highlight all |
| | | | Highlight unique charms only |
| | | | Highlight non-unique charms only |
| | | | Custom |
| **Quest & Endgame** | **Quest items** | | No change |
| | | | Highlight |
| | | x | Highlight, exclude Cube |
| | | | Custom |
| | **Endgame Items** | | No change |
| | | x | Highlight |
| | | | Highlight, exclude Standard of Heroes |
| | | | Highlight, hide Standard of Heroes |
| | | | Custom |
| **Weapons & Armor** | **Use Custom Weapon Filter** | Off | On/Off |
| | **Use Custom Armor Filter** | Off | On/Off |
| **Item Stats & Modifiers** | **Item Level** | | No change |
| | | x | Enable, fix indentation |
| | | | Enable |
| | **Item Quality** | x | No change |
| | | | Suffix, parentheses |
| | | | Suffix, square brackets |
| | | | Prefix, parentheses |
| | | | Prefix, square brackets |
| | | | Custom |
| | **Short Superior/Inferior Prefixes** | | No change |
| | | x | Enable |
| | | | Enable, gray inferior items |
| | | | Custom |
| | **Ethereal Items Tooltip Color** | x | No change |
| | | | Beige |
| | | | Black |
| | | | Dark Green |
| | | | Green |
| | | | Light Blue |
| | | | Light Gray |
| | | | Light Purple |
| | | | Light Red |
| | | | Light Teal |
| | | | Red |
| | | | Very Light Gray |
| | | | White |
| | | | Custom |
| **Light Pillars** | **Enable** | On | On/Off |
| | **Disable for Hidden Items** | On | On/Off |
| | **Runes: Low** | On | On/Off |
| | **Runes: Low-Mid** | On | On/Off |
| | **Runes: Mid** | On | On/Off |
| | **Runes: High** | On | On/Off |
| | **Rings & Amulets** | On | On/Off |
| | **Gems & Jewels** | On | On/Off |
| | **Charms** | On | On/Off |
| | **Quest: Items** | On | On/Off |
| | **Quest: Weapons** | On | On/Off |
| | **Essences** | On | On/Off |
| | **Token of Absolution** | On | On/Off |
| | **Pandemonium Keys** | On | On/Off |
| | **Pandemonium Organs** | On | On/Off |
| | **Standard of Heroes** | On | On/Off |
| **Drop Sounds** | **Enable** | On | On/Off |
| | **Disable for Hidden Items** | On | On/Off |
| | **Runes: Low** | x | Default |
| | | | Hostile (PVP) |
| | | | Hell Forge Place |
| | | | Hell Forge Smash |
| | | | Cairn Stones Success |
| | | | Town Portal Open |
| | | | Quest Done |
| | | | Custom |
| | **Runes: Low-Mid** | | See "Runes: Low" (default: Default) |
| | **Runes: Mid** | | See "Runes: Low" (default: Hell Forge Place) |
| | **Runes: High** | | See "Runes: Low" (default: Hell Forge Place) |
| | **Quest Items** | | See "Runes: Low" (default: Hell Forge Smash) |
| | **Essences** | | See "Runes: Low" (default: Default) |
| | **Token of Absolution** | | See "Runes: Low" (default: Default) |
| | **Pandemonium Keys** | | See "Runes: Low" (default: Hell Forge Smash) |
| | **Pandemonium Organs** | | See "Runes: Low" (default: Hell Forge Smash) |
| | **Standard of Heroes** | | See "Runes: Low" (default: Quest Done) |
| **Misc** | **Alternate Color Schemes** | | No change |
| | | | Facets, Sunder Charms, Runes |
| | | x | Facets, Sunder Charms |
| | | | Facets, Runes |
| | | | Sunder Charms, Runes |
| | | | Facets |
| | | | Sunder Charms |
| | | | Runes |
| | **Highlight Character** | | (space) |
| | | x | \* (asterisk) |
| | | | = (equals) |
| | | | + (plus) |
| | | | - (hyphen/dash/minus) |
| | | | x (small letter x) |
| | | | X (capital letter x) |
| | | | o (small letter o) |
| | | | O (capital letter o) |
| | | | 0 (zero) |
| | | | ~ (tilde) |
| | | | ! (exclamation mark) |
| | | | @ (at) |
| | | | # (number/pound/hash) |
| | | | $ (dollar) |
| | | | % (percent) |
| | | | & (ampersand) |
| | | | Custom |
| | **Highlight Color** | | White |
| | | | White Smoke |
| | | | Dim Gray |
| | | | Dimmer Gray |
| | | | Black |
| | | | Red |
| | | x | Tomato |
| | | | Crimson |
| | | | Lime |
| | | | Lime v2 |
| | | | Lime Green |
| | | | Green |
| | | | Deep Sky Blue |
| | | | Light Sky Blue |
| | | | Medium Slate Blue |
| | | | Corn Flower Blue |
| | | | Yellow |
| | | | Light Yellow |
| | | | Orange |
| | | | Violet |
| | | | Dark Violet |
| | | | Tan |
| | | | Tan v2 |
| | | | Wheat |
| | | | Custom |
| | **Highlight Color: Runes (alternate)** | | See "Highlight Color" (default: Dark Violet) |
| | **Tooltip width for hidden items** | 0 | 0 - 25 spaces |
| **Tooltip Mods** | **Tooltip mods** | x | No change |
| | | | Opacity & Size |
| | | | Opactiy |
| | | | Size |
| | **Tooltip: opacity** | 0.75 | 0.00 - 1.00 (unmodded = 0.60) |
| | **Tooltip: font size** | 33 | 20 - 50 (unmodded = 36) |

### Text Colors

See [here](https://github.com/Caedendi/D2RMM-Loot-Filter-Extended/blob/master/Docs/colors.md) for an overview of all the colors in the game that I know of and their RGB decimal codes.

## Known Issues

### Enabling Show Item Level online messes up socketed items
Do not enable Show Item Level if you are playing online. It does not work (all items display as ilvl 1) and the amount of sockets in items will be incorrectly displayed. This is not an issue for offline single player.

## Roadmap

- [ ] Multi-line tooltips:
  - [ ] whitespace only
  - [ ] highlight pattern + whitespace above/below
  - [ ] colored "Pick Up" text above item name
  - [ ] custom
- [ ] Drop Sounds extras:
  - [ ] LoD uniques: theme sounds 
    - [ ] anni: todo
    - [ ] torch: fireball/hell forge smash
    - [ ] Gheed's: gold drop
  - [ ] Sunder Charms: theme sounds (fireball, lightning, etc)
- [ ] ProfileHD mods
  - [ ] Also apply to ProfileLV and controller ProfileHD
  - [ ] Remove Ethereal Color as it's already provided by olegbl's Custom Item Colors mod

### Fix known bugs

- [x] Regular Ruby, Sapphire, Emerald and Diamond not working
- [x] Certain quest item customization not working
- [x] Enabling quest item highlighting screws up the Horadric Cube's displayed name when the cube menu is open.
- [x] Enabling jewelry turns crafted/rare/set/unique jewelry blue
- [x] Item name alignment out of place when [Show Item Level](https://www.nexusmods.com/diablo2resurrected/mods/174) is enabled
- [x] Tooltip mods not working

### Add features

- [x] Integrate [Show Item Level](https://www.nexusmods.com/diablo2resurrected/mods/174) by [olegbl](https://github.com/olegbl)
- [x] Integrate [Short Quality Prefixes for D2RMM](https://www.nexusmods.com/diablo2resurrected/mods/214) by [Jobus](https://www.nexusmods.com/diablo2resurrected/users/3107665)
- [x] Integrate [Show Item Quality for D2RMM](https://www.nexusmods.com/diablo2resurrected/mods/351) by [minseoksuh](https://www.nexusmods.com/diablo2resurrected/users/176581440)
- [x] Integrate [LightPillar for D2RMM](https://www.nexusmods.com/diablo2resurrected/mods/197) by [qhu91it](https://github.com/qhu91it) and [buzh](https://www.nexusmods.com/diablo2resurrected/users/2596633)
- [x] Rework alternate color schemes into optional setting as a drop-down menu
  - [x] Alternate color scheme for Facets (rainbow highlights)
  - [x] Alternate color scheme for Sunder Charms (element-colored highlights)
  - [x] Alternate color scheme for mid/high runes (purple names)
- [x] Only show Light Pillars on non-hidden items
- [x] Option to disable _all_ light pillars
- [x] Highlight color customization
- [x] Runes alternate color scheme customization
- [x] Split runes into 4 tiers for visibility, highlighting, light pillars and drop sounds
- [x] Invert light pillars for quest weapons option (exclude => include)
- [x] Rename colors to standardized names and document them better
- [x] Custom drop sounds
- [x] Gold mods (gold amount coloring + variations)
- [x] Ethereal tooltip customization
- [x] Custom weapon/armor filter list (as suggested by [Stealan88](https://www.nexusmods.com/diablo2resurrected/mods/361?tab=posts&jump_to_comment=128549685))

## Recommended Mods

Visit [this GitHub page](https://github.com/Caedendi/D2RMM-Mod-List) for the list of D2RMM mods that I use, you might like some of 'em!

A list of the other mods I created/ported can also be found there, as well as directly on [my Nexus Mods page](https://www.nexusmods.com/diablo2resurrected/users/179695179?tab=user+files).

## Credits

This loot filter mod is based on code from existing mods and inspired by existing styles. I have added code optimizations, a shit-ton of toggles, expanded some features and gave it my own personal flair and preference. 
Remnants of other people's codes remain, so I have tried to list the credits as accurately as I can. If you see any of your own code in this mod and it isn't credited, please send me a message.

Many thanks to:

### Code
- [salzgaard](https://www.nexusmods.com/diablo2resurrected/users/6397569) for his [Practical Item Filter for D2RMM](https://www.nexusmods.com/diablo2resurrected/mods/317), which acted as a base for this mod and the tooltip customization features.
- [olegbl](https://github.com/olegbl) for
  - Creating [D2RMM](https://www.nexusmods.com/diablo2resurrected/mods/169)
  - His [example mods](https://github.com/olegbl/d2rmm.mods) in general
  - His [Short Potion Names](https://www.nexusmods.com/diablo2resurrected/mods/177) mod for the list of colors
  - His [Show Item Level](https://www.nexusmods.com/diablo2resurrected/mods/174) mod, which I integrated
  - His [Custom Item Colors](https://www.nexusmods.com/diablo2resurrected/mods/190 ) mod, which I used for Ethereal tooltip customization
- [Jobus](https://www.nexusmods.com/diablo2resurrected/users/3107665) for his [Short Quality Prefixes for D2RMM](https://www.nexusmods.com/diablo2resurrected/mods/214) mod, which I integrated
- [minseoksuh](https://www.nexusmods.com/diablo2resurrected/users/176581440) for his [Show Item Quality for D2RMM](https://www.nexusmods.com/diablo2resurrected/mods/351) mod, which I integrated
- [seunggil](https://www.nexusmods.com/diablo2resurrected/users/3948946), [qhu91it](https://github.com/qhu91it) and [buzh](https://www.nexusmods.com/diablo2resurrected/users/2596633) for the [lightpillar](https://www.nexusmods.com/diablo2resurrected/mods/112) and [LightPillar for D2RMM](https://www.nexusmods.com/diablo2resurrected/mods/197) mods, which I integrated and expanded
- [AlexisEvo](https://github.com/AlexisEvo) and [flppyflip3](https://www.nexusmods.com/diablo2resurrected/users/8753980) for the idea of Drop Sounds, as displayed in [AlexisEvo's Loot Filter](https://github.com/AlexisEvo/d2r-loot-filter) and [flppyflip3's updated version](https://www.nexusmods.com/diablo2resurrected/mods/408).

### Filter Style
- [Path of Diablo filters](https://pathofdiablo.com/wiki/index.php?title=List_of_Loot_Filters) for removing all that clutter on Path of Diablo and inspiring me to create this loot filter for D2R.
  - Mainly [Darkgale](https://www.twitch.tv/darkgale)'s filter called [Filtergale](https://www.reddit.com/r/pathofdiablo/comments/i9hdw7/filtergale/) ([download](https://greendu.de/s/ZbDwHekAg3rmeRB/download?path=%2F&files=item.filter)) regarding styling.
- [Practical Item Filter for D2RMM](https://www.nexusmods.com/diablo2resurrected/mods/317)
- [Cbraqz](https://www.nexusmods.com/diablo2resurrected/users/3106975)'s [D2R Simple Loot Filter](https://www.nexusmods.com/diablo2resurrected/mods/54) mod for giving me an idea on how to fix highlighting charms without removing rarity coloring

## License/Permissions

This code is licensed under GPL.

You are free to use and distribute all code in this mod, as long as you ask for permission (and permission is given), it stays open source, free of charge and all due credit is given.

If you are trying to profit off this mod in any way, then you're a dick and forbidden from using this code.

D2RMM-Loot-Filter-Extended

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README