Skip to content

Commit

Permalink
Updated version, README
Browse files Browse the repository at this point in the history
  • Loading branch information
@Caedendi
Caedendi committed Apr 8, 2024
1 parent e828728 commit b7d352c
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 36 deletions.
2 changes: 1 addition & 1 deletion Bonesy's Color Dye System/mod.json
View file
Expand Up @@ -3,7 +3,7 @@
"description": "Dye your weapon, armor, helm and shield to your preferred color using 3 Perfect Gems/Skulls. Use 3 Antidote Potions to remove.",
"author": "Caedendi, Bonesy",
"website": "https://www.nexusmods.com/diablo2resurrected/mods/474",
"version": "1.1.0",
"version": "2.0.0",
"config": [
{
"id": "ShouldUseCheapRecipes",
Expand Down
56 changes: 21 additions & 35 deletions README.md
View file
Expand Up @@ -7,15 +7,15 @@ A D2RMM implementation for the [Color Dye System](https://www.youtube.com/watch?

- [Screenshots](#screenshots)
- [Changelog](#changelog)
- [2.0.0](#200)
- [1.0.0](#100)
- [How to Install](#how-to-install)
- [Technicalities \& Limitations](#technicalities--limitations)
- [Known Issues](#known-issues)
- [Roadmap](#roadmap)
- [Recommended Mods](#recommended-mods)
- [License/Permissions](#licensepermissions)
- [Credits](#credits)
- [My Mods + Source](#my-mods--source)
- [License/Permissions](#licensepermissions)


## Screenshots
Expand All @@ -25,7 +25,17 @@ To do. In the meantime, see [ColorDye](https://www.nexusmods.com/diablo2resurrec

## Changelog

### 2.0.0

This update introduces a breaking change that is incompatible with the previous version. Remove all your applied color dyes before updating because the game will either not load or will not be able to read your save files with these old dyes.

- BREAKING CHANGE: Color Dye stats now only use 2 bits of save data, as opposed to the previously unnecessarily high 16
- Changed the cube recipes to take 3 gems/potions instead of 1 to match D2RLaunch
- Previous version's cube recipe quantities added as an optional setting
- Changed Color Dye stat priority from 997 to 999

### 1.0.0

- Initial D2RMM release, feature parity with [ColorDye](https://www.nexusmods.com/diablo2resurrected/mods/418)
- Some lines in cubemain.txt are shifted, this mod's order makes more sense.
- Bonesy's trademark values for ValShift, Save Bits and Save Add in itemstatcost.txt have been altered/removed on his suggestion.
Expand All @@ -52,13 +62,14 @@ This mod adds new entries to the following files:
| properties.txt | 8 | 276 | 288 | ? |
| item-modifiers.json | 7 | 27379 | 48006 | 65535 |

The current highest entry in item-modifiers.json has ID 27379. To prevent incompatibility with a future game update, this mod mirrors Bonesy's Vanilla++ (and Slim for that matter) by starting the new entries at ID 48000, if available. If not, it assumes the entries are properly sequentially sorted and takes the ID of the last entry and works up from there. All other files/entries also scale with other mods.
The current highest entry in item-modifiers.json has ID 27379. To prevent incompatibility with a future game update, this mod mirrors Bonesy's Vanilla++ (and Slim for that matter) by starting the new entries at ID 48000, if available. If not, it assumes the entries are properly sequentially sorted and takes the ID of the last entry and works up from there. The other files/entries should also scale with other mods.


## Known Issues

The game will crash if you disable this mod and then try to load a save file with dyed items in it. Be sure to remove all color dyes from items when you stop using it.


## Roadmap

- [x] Full feature parity with the original mods
Expand All @@ -67,31 +78,9 @@ The game will crash if you disable this mod and then try to load a save file wit

## Recommended Mods

In addition to this, I recommend you also take a look at the other D2RMM mods I use (in order):

| Mod | Creator | Notes |
|----------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------:|----------------------------------------------------------------------------------------------------------------------------------------|
| [Diablood (D2RMM)](https://www.nexusmods.com/diablo2resurrected/mods/305) | [anwjrzlffj](https://www.nexusmods.com/diablo2resurrected/users/3346450) | More blood! More gore! |
| [Enhanced effects and sounds (D2RMM)](https://www.nexusmods.com/diablo2resurrected/mods/423) | [anwjrzlffj](https://www.nexusmods.com/diablo2resurrected/users/3346450) | Mostly visual/animation changes. |
| [Disable Battle.net](https://github.com/olegbl/d2rmm.mods) | [olegbl](https://github.com/olegbl) | So you don't accidentally get yourself banned. |
| [Skip Videos for D2RMM](https://www.nexusmods.com/diablo2resurrected/mods/179) | [Caedendi](https://www.nexusmods.com/diablo2resurrected/users/179695179) (me) | Disable launch intro videos and cinematic cutscenes when transitioning between acts. |
| [Improved Potion Visibility for D2RMM](https://www.nexusmods.com/diablo2resurrected/mods/384) | [MetalTxus](https://www.nexusmods.com/diablo2resurrected/users/18894694) | Changes healing/mana potion sprites so it's easier to distinguish different potion levels. |
| [Move Cain and Teleports for D2RMM](https://www.nexusmods.com/diablo2resurrected/mods/310) | [night0wl117](https://www.nexusmods.com/diablo2resurrected/users/33697975) | Move town starting points, TP locations and Cain's position in Act 5. |
| [Town Cast for D2RMM](https://www.nexusmods.com/diablo2resurrected/mods/183) | [olegbl](https://github.com/olegbl) | Teleport and buff in town. _(BREAKING: allows teleporting past Jerhyn during the Act 2 questline)_ |
| [Pseudo Loot Filter (D2RMM)](https://www.nexusmods.com/diablo2resurrected/mods/467) | [icalexci](https://www.nexusmods.com/diablo2resurrected/users/29547100) | Loot filter for preventing unwanted items from dropping. Sets drop chance to NoDrop without influencing the other items' drop chances. |
| [Caedendi's Extended Loot Filter for D2RMM](https://www.nexusmods.com/diablo2resurrected/mods/361) | [Caedendi](https://www.nexusmods.com/diablo2resurrected/users/179695179) (me) | Loot filter for name shortening/highlighting, light pillars, drop sounds, big tooltips & more. |
| [Bonesy's Color Dye System for D2RMM](https://www.nexusmods.com/diablo2resurrected/mods/474) | [Caedendi](https://www.nexusmods.com/diablo2resurrected/users/179695179) (me) | Dye your equipment to custom colors. |
| [UI Fixes for D2RMM](https://www.nexusmods.com/diablo2resurrected/mods/387) | [MetalTxus](https://www.nexusmods.com/diablo2resurrected/users/18894694) | Fixes the placement of a few item grids. |
| [Settings Font Fix for D2RMM](https://www.nexusmods.com/diablo2resurrected/mods/200) | [olegbl](https://github.com/olegbl) | In case any mod touches __profilehd_ and screws up the font size in the settings menu. |
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!


## 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 granted), 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.
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
Expand All @@ -108,13 +97,10 @@ Major thanks to:
- [olegbl](https://github.com/olegbl) for creating [D2RMM](https://www.nexusmods.com/diablo2resurrected/mods/169)


## My Mods + Source
## License/Permissions

### Diablo II: Resurrected ###
This code is licensed under GPL.

| Nexus Mods Page | Source |
|:---------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------|
| [Caedendi's Extended Loot Filter for D2RMM](https://www.nexusmods.com/diablo2resurrected/mods/361) | [GitHub](https://github.com/Caedendi/D2RMM-Loot-Filter-Extended) |
| [Caedendi's Simple Loot Filter for D2RMM](https://www.nexusmods.com/diablo2resurrected/mods/360) | [GitHub](https://github.com/Caedendi/D2RMM-Loot-Filter-Simple) |
| [Skip Videos for D2RMM](https://www.nexusmods.com/diablo2resurrected/mods/397) | [GitHub](https://github.com/Caedendi/D2RMM-Skip-Videos) |
| [Bonesy's Color Dye System for D2RMM](https://www.nexusmods.com/diablo2resurrected/mods/474) | [GitHub](https://github.com/Caedendi/D2RMM-Color-Dye) |
You are free to use and distribute all code in this mod, as long as you ask for permission (and permission is granted), 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.

0 comments on commit b7d352c

Please sign in to comment.