Introduction


This mod adds a new merchant who sells various dyes and new outfits.

Dyes work like potions. These can be used by anyone, and will permanently change the user's colours as specified by the particular dye: there are separate options for major and minor colours, leather (belts/boots/straps), armour, decorative items (like belt buckles/amulets) and hair.

Outfits will change the the character's appearance to match the specified class: fighter, mage, thief or cleric. (I strongly suggested that you also install everything from One Pixel Productions). These can be used by anyone but monks (which would look wonky). Halflings have no mage avatars and will use the gnome mage avatar instead. Half-Orcs have no mage paperdolls in the unmodded game, meaning you won't see your character on the inventory screen (unless you install the 1PP update, which adds one).

All changes are purely cosmetic; you do not gain or lose abilities by using anything bought from Rupert's stores.

Rupert will appear in the Mithrest Inn in BG2:SoA, as well as in Saradush and Amkethran inns if Throne of Bhaal is installed. In BG:EE, SoD, TuTu, BGT and EET, he will also appear in a room on the second floor of the Friendly Arm Inn (the second from the left on the top-left side of the screen).


Visit the forum for all the latest updates.


Rupert the Dye Merchant > Introduction •BACK TO TOP

Compatibility


Rupert the Dye Merchant is designed to work on the following Infinity Engine games:

  • The series of Enhanced Editions published by Beamdog, which includes Baldur's Gate: Enhanced Edition (BGEE) and Baldur's Gate II: Enhanced Edition (BG2EE). The BGEE Siege of Dragonspear expansion (SoD) is supported as well.
  • The original Baldur's Gate II (BG2, or just SoA) with or without the Throne of Bhaal (ToB) expansion. Make sure you have Throne of Bhaal patched to version 26498. Check the ReadMe files related to your patch in your game folder and the BioWare website if necessary.
  • The conversion projects based on ToB, Baldur's Gate Trilogy (BGT), Baldur's Gate Tutu (Tutu) and Enhanced Edition Trilogy (EET).


The Rupert the Dye Merchant is a WeiDU mod, and therefore should be compatible with all WeiDU mods. However, we cannot test every single one. If you encounter any bugs, please report them on the forum!

Although it is not required for the Rupert the Dye Merchant mod to function properly, classical game players are strongly recommended to download and install the latest version of the BG2 Fixpack before proceeding with the installation of this mod.


Rupert the Dye Merchant > Compatibility •BACK TO TOP

Installation


Notes

If you've previously installed the mod, remove it before extracting the new version. To do this, run  setup-rupert.exe , un-install all previously installed components and delete the rupert folder.

When installing or un-installing, do not close the DOS window by clicking on the X button! Instead, press the Enter key whenever instructed to do so.

Disable any antivirus or other memory-resident software before installing this or any other mod. Some (particularly avast and Norton!) have a tendency to report false positives with mod activity, resulting in failed installs.

You can extract files from the archive using 7zip, WinRAR, ZipGenius or another file compression utility that handles .zip files.



Special Note for Siege of Dragonspear from Steam/GOG

Good Old Games (GOG) and Steam both package the additional content for Siege of Dragonspear in a method that WeiDU, the tool used to install this mod, cannot access. You must run a program called DLC Merger on your SoD installation before you can install this or any other WeiDU-based mod.



Enhanced Editions Note

The Enhanced Editions are actively supported games. Please note that every patch update will wipe your current mod setup! If in the middle of a modded game you might want to delay the patch update (if possible) as even after reinstalling the mods, you might not be able to continue with your old savegames. Alternatively, copy the whole game's folder into a new one that can be modded and will stay untouched by game patches. It is important that you install the mod to the language version you are playing the game in. Otherwise, the dialogues of the mod will not show but give error messages.



Windows

Rupert the Dye Merchant for Windows is distributed as an extractable compressed archive and includes a WeiDU installer.

Extract the contents of the mod to the folder of the game you wish to modify (the folder which contains the "CHITIN.KEY" file). On successful extraction, there should be a rupert folder and a setup-rupert.exe file in your game folder. To install, simply double-click  setup-rupert.exe  and follow the instructions on screen.

Run  setup-rupert.exe  in your game folder to reinstall, un-install or otherwise change components.



Mac OS X

Rupert the Dye Merchant for Mac OS X distributed in the same compressed archive and includes a WeiDU installer.

First, extract the files from the archive into your game directory. On successful extraction, there should be a rupert folder, setup-rupert and setup-rupert.command files in your game folder. To install, double-click  setup-rupert.command  and follow the instructions on screen.

You can run  setup-rupert.command  in your game folder to reinstall, un-install or otherwise the components settings.



Linux

Rupert the Dye Merchant for Linux is distributed in the same compressed archive and does not include a WeiDU installer.

Extract the contents of the mod to the folder of the game you wish to modify.

Download the latest Linux version of WeiDU and copy weidU and weinstall to /usr/bin. Then open a terminal and cd to your game installation directory.

Optional: run 'tolower' and answer 'Y' to both queries. You can avoid running the second option (linux.ini) if you've already ran it once in the same directory. To save time, the archive is already tolowered, so there's no need to run the first option (lowercasing file names) either, if you've extracted only this mod since the last time you lowercased file names. If unsure, running tolower and choosing both options is the safe bet.

Run  weinstall setup-rupert  in your game folder to install the mod. Then run  wine BGMain.exe  (or  wine Baldur.exe  for EE games), and start playing.



Note for Complete Un-installation

In addition to the methods above for removing individual components, you can completely un-install the mod using  setup-rupert --uninstall  at the command line to remove all components without wading through prompts.


Rupert the Dye Merchant > Installation •BACK TO TOP

Notes


To summon Rupert anywhere:

  •  CLUAConsole:CreateCreature("JL#RUPRT")  summons the regular BG:EE, SoD or BGT/TuTu/EET version of Rupert. Use this if you're playing BG1.
  •  CLUAConsole:CreateCreature("JL#RUPR2")  summons the BGII: SoA version.
  • In Saradush (ToB), type  CLUAConsole:CreateCreature("JL#RUPR3") .
  • In ToB, type  CLUAConsole:CreateCreature("JL#RUPR4") .

All of them sell the same items at the same prices.



To create items without Rupert:  CLUAConsole:CreateItem("JL#PXnnn") .

  • Replace "X" with "A" for a dye for the major colour, "B" for minor colour, "C" for straps/boots/leather, "D" for armour, "E" for buckles/amulets, or "F" for hair.
  • "nnn" being the number of the colour gradient you want, from 000 to 115.

For example, JL#PF001 will create a brown dye that affects the user's hair, while JL#PA000 is slightly red-tinted black and will affect the character's major colour.

For a complete list of colour gradients, see the list in the IESDP documentation.

The codes for the outfits are JL#CCLRC (cleric), JL#CFGTR (fighter), JL#CMAGE (mage) and JL#CTHIF (thief).



Caution

Since I have had a couple of crash reports, I recommend saving before using dyes. This is not a problem with the mod, but rather the game engine itself; unfortunately, this is not something that can be fixed. Which colours are affected, if any, seems to vary between installs.

Dyes add a permanent "set colour" effect to the user. This overrides the character's original colours, and you will no longer be able to switch major/minor colours on the inventory screen if you use dyes to change them. (Well, you can, it just doesn't do anything.) If you want to change back to your original colours, you will have to use another bottle of dye.

Dyes also override colours specified by armour or other gear. If you use a dye to turn your armour hot pink, every piece of armour that character wears in the future will be hot pink (unless you re-dye it).

It appears that the drow disguise in the Underdark cancels the effect of any dyes used on your characters. You can, however, return to the Mithrest Inn upon leaving the Underdark and re-stock on dyes.


Rupert the Dye Merchant > Notes •BACK TO TOP

Credits


Author: vilkacis


Special Acknowledgements to:
  • Spellhold Studios team for hosting the mod (Forums).
  • Special thanks to Miloch and Leomar for help with bams, updating and... stuff. Y'know. Things.
  • Gwendolyne: French translation.
  • BWP Russian Textpack team: Russian translation.
  • ilot: Italian translation.
  • Lisandro: Spanish translation.
  • Meresin: German translation.

If you wish to translate the mod, have a suggestion, or should encounter any bugs, please report them to the maintainers at the mod forum.



Programs/tools used in creation:


Copyrights

Public domain: no rights reserved. May be freely copied, edited and distributed.


Rupert the Dye Merchant > Credits •BACK TO TOP

Version History


Version 3.0.0 (June 16, 2020)
  • Added rupert.ini metadata file to support AL|EN's "Project Infinity"
  • Renamed setup-rupert.tp2 -> rupert.tp2 to support AL|EN's "Project Infinity".
  • Replaced `AUTHOR` keyword with `SUPPORT`.
  • Added `HANDLE_CHARSETS` function to convert string entries for EE games.
  • Added `REQUIRE_PREDICATE` conditions to avoid installing the mod in inaccurate games.
  • Added component `DESIGNATED` number and "rupert_the_dye_merchant" `LABEL`.
  • Added native BG:EE, BG2:EE and EET compatibility.
  • Commented code as much as possible.
  • Rewrote store patching process.
  • Simplified Rupert spawning and script `EXTEND_TOP` process with cross-platforms tutu variables.
  • Converted inventory BAMs to EE: This feature attempts to modify traditional inventory BAMs so that both the large and small icons are utilized by the EE games. The inventory BAM must have two sequences, the first containing the "large" inventory icon frame and the second containing the "small" inventory icon frame to be processed. Inventory icon BAMs in the bam folder that meet these requirements are patched and saved back to the override folder.
  • Included BWP Fixpack patch: fixed wrong header icons.
  • Added foreign languages WeiDU prompts whenever possible.
  • Added French translation (Gwendolyne).
  • Added Russian translation (BWP Russian Textpack team).
  • Restored German translation.
  • Fixed typos in English .tra files.
  • Re-formated, updated and renamed readme file to "rupert-readme-english.html", then moved it into new "readme" folder.
  • Removed useless files and "backup" folder.
  • Reorganized mod architecture tree: created folders to sort files according to their types.
  • Lower cased files.
  • Included Linux and Mac Os X versions in the same package (thanks AL|EN's Infinity Auto Packager tool!).
  • Added archive libiconv-1.9.2-1-src.7z with iconv licence info.
  • Updated WeiDU installer to v246.
  • Uploaded mod to official Spellhold Studios GitHub mirror account.

Version 2.1.1 (March 20, 2010)
  • Added Italian translation by ilot.

Version 2.1 (March 19, 2010)
  • Added Spanish translation by Lisandro.
  • Fixed a gnome-related typo in the code (thanks Lollorian).

Version 2.0 (December 23, 2009)
  • Added "outfits<.em>" to Rupert's store.
  • Re-arranged dyes: lower numbers are now at the top, rather than the bottom.
  • English only so far.

Version 1.1 (November 25, 2009)
  • Included Miloch's .bam and .itm fixes.
  • Traified the mod.
  • Added German translation by Meresin.
  • Changed to `README` command.
  • Added `VERSION` flag.
  • Updated WeiDU installer to v211.

Version 1.0 (February 23, 2007)
  • Initial release.

Rupert the Dye Merchant > Version History •BACK TO TOP