Overview


This is a readme file template for mods developed and/or hosted at SHS and is written in HTML language.

For each section, I took over, whenever possible, elements of readmes already published in order to maintain a semblance of consistency in the terms used. All you have to do is to keep the ones you need (list of compatible games, installation procedures according to the platform, list of tools used...) and, for the rest, replace "MYMOD" and "Author" by the name of the mod and its author, modify the links and fill in the appropriate texts. For some sections,I have been as exhaustive as possible: all you have to do is to choose the paragraphs that interest you and delete the others.


Short mod description: obvious, isn't it? 😉


Key features

  • Feature #1
  • Feature #2
  • Feature #3
  • Feature #4
  • ... 🙂

Note: If you want to use more complex templates, please have a look here and here.




Some special characters: mid dot [·] - > [>] - non-breaking space [  ;  ] - ⁂
Some smileys : 🙂 [:)] - 😉 😉 [;)] - 😝 [:p] - 🙁 [:(] - 😎 [] - ⚠ et ⚠ [:warning:] - ⚠️ ou ⚠️ [yellow warning]


Extra list symbols:

  • □ white square
  • ⬨ white medium lozenge
  • ⬦ white medium diamond
  • ◇ white diamond
  • ▷ white right-pointing triangle
  • • bullet
  • ⬧ black medium lozenge
  • ⬥ black medium diamond
  • ◆ black diamond
  • ▶ black right-pointing triangle
  • ► black right-pointing pointer



Spoiler button examples




Spoiler 2 with button :  


TEXT TO DISPLAY SPOILER 2



Spoiler 3 without button: click here
Spoiler 4 : text to hide (click the text)

TEXT TO HIDE SPOILER 4

Mymod > OverviewBACK TO TOP

Compatibility


Games supported

Mymod is designed to work on most Infinity Engine games. This includes:

  • The series of Enhanced Editions published by Beamdog, which at present includes Baldur's Gate: Enhanced Edition (BGEE), Baldur's Gate II: Enhanced Edition (BG2EE), Icewind Dale: Enhanced Edition (IWDEE), and Planescape: Torment: Enhanced Edition (PsTEE). The BGEE Siege of Dragonspear expansion (SoD) is supported as well. All of the Enhanced Edition games include the original expansion packs, e.g. IWDEE includes Heart of Winter and Trials of the Luremaster.
  • The original Baldur's Gate (BG), with or without the Tales of the Sword Coast (TotSC) expansion.
  • 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 (and EasyTutu) and Enhanced Edition Trilogy (EET).
  • The original Icewind Dale (IWD) with or without either of its expansions, Heart of Winter (HoW) and Trials of the Luremaster (TotLM).
  • Icewind Dale II (IWD2).
  • Planescape: Torment (PsT).



Other Mods Compatibility

This mod is a WeiDU mod, and therefore should be compatible with all WeiDU mods.

Though we are striving to make Mymod compatible with as many other mods as possible, there is always a chance that incompatibilities will arise. Below are the ones discovered thus far:

  • mod 1
  • mod 2
  • ...

If you encounter any bugs, please report them on the forum!




Installation Order

➽ Although it is not required for Mymod to function properly, you are strongly recommended to also download and install the BG2 Fixpack before proceeding with the installation of this mod.

  • Please install Mymod after Divine Remix mod, as it alters spells in Lizard Man Shamans spellbook
  • Please install Mymod after Imoen Romance.
  • ...

➽ ⚠️ Don't forget that there are mods managers that strive to make the players life easier. So don't forget to fill the mymod.ini file in 📁 mymod folder.





It is very easy. Let's take the mymod/Divine Remix installation order. All you need to do is to fill the following line in mymod.ini:

# This mod should be installed *after* the mods listed after the keyword
After = bg2fixpack, EET, divine_remix


And that's it! Players will NEVER install those mods using bad install order. 😉


➽ ⚠️ At last, please never forget that metadata keywords implementation has still a WIP status. Thus, you are strongly recommended checking the last version of .ini files here.


Mymod > CompatibilityBACK TO TOP

Installation


Notes

If you've previously installed the mod, remove it before extracting the new version. To do this, run  setup-mymod.exe , un-install all previously installed components and delete the 📁 mymod 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.

  ► Spoiler box template: Deprecated as of v 6.0.0 (read this instead):

Important: blabla.

blabla2.

blabla3.

blabla4.




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

Mymod 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 📁 mymod folder and a setup-mymod.exe file in your game folder. To install, simply double-click  setup-mymod.exe  and follow the instructions on screen.

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




Mac OS X

Mymod for Mac OS X is distributed in the same compressed archive and includes a WeiDU installer.

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

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




Linux

Mymod for Linux is distributed in the same compressed archive and does not includesa 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, weinstall and tolower 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-mymod  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-mymod --uninstall  at the command line to remove all components without wading through prompts.




⚠️ Warning: new installation process

Configuration options needed for installation options are read from mymod-config-default.ini file, or mymod-config-user.ini if it exists.


As interrupting installation with plain text prompts allowing players to customise components to their liking is not compatible with most mods managers, all those options set during installation have been moved into mymod-config-default.ini file in 📁 mymod folder. This file provides a 'default' installation.

If you want to define your own customized installation, you have to edit mymod-config-default.ini with Notepad or another text editor, then save it as mymod-config-user.ini.

Each line consists of a configuration option, then '=', then a number, or an alphanumeric character string. The only thing you should edit is the number or the string.

The installation process will read both .ini files and prioritize user's options values. If a value is not set or mismatched in mymod-config-user.ini, any installation failure will be prevented by reverting it back to its default value.

Here is a chart listing the options related to the installation process:


Option Description Type
mymod_variable1 blabla

1 = first option (recommended) [default].
2 = second option.
integer
mymod_variable2

(supports: only EE)
blabla

1 = first option (recommended).
2 = second option.
3 = third option.
integer
mymod_variable3 blabla

one character.
A [default]
string
mymod_variable4 The name of your mount

a name!
Silver Star [default]
string


Mymod > InstallationBACK TO TOP

Components


The installer includes the following components. The number of each is the component DESIGNATED number which gives it a fixed install position, lets other components and mods detect it and allows automated installers to specify component choices.

[Optional: All subcomponents require the main component (they need to since it's the one that installs new content). All components are otherwise optional.]




[10] Component blabla (main component)

Main component description.

Or alternatively

➽ Main component description.




[20] Component blublu

Component blublu description.




[30] Component bloblo

Component bloblo description.


Mymod > ComponentsBACK TO TOP

Components


The installer includes the following components. The number of each is the component DESIGNATED number which gives it a fixed install position, lets other components detect it and allows automated installers specify component choices.

[Optional: All subcomponents require the main component (they need to since it's the one that installs new content). All components are otherwise optional.]


[10] Component blabla (main component)
[20] Component blublu
[30] Component bloblo
[40] ...




[10] Component blabla (main component)
Requires ToB v26498

  • Checks mod files
  • ToB only: Checks .exe validity, backs up and patches the .exe
  • ToB only: Replaces _LOW creature animations
  • Updates .ids files
  • Restores any necessary mod-overwritten animations
  • Copies new animations (any extracted to /content folder)
  • Fixes any affected creatures

BACK TO COMPONENTS INDEX



[20] Component blublu

  • Male human fighters get the fighter instead of cleric animation
  • Male elf fighters get the fighter instead of cleric animation
  • Male halfling fighters get the fighter instead of cleric animation
  • Female human fighters get the fighter instead of cleric animation
  • Male human mages get the mage instead of cleric animation
  • Male elf mages get the mage instead of cleric animation
  • Male human thieves get the thief instead of fighter animation
  • Female human thieves get the thief instead of fighter animation
  • Male human monks get the monk instead of cleric animation
  • Male human pirates get the pirate animation
  • Male human sailors get the sailor animation
  • Amnian guards get the Amnian guard animation
  • Male human Shadow Thieves get the Shadow Thief animation

BACK TO COMPONENTS INDEX



[30] Component bloblo

  ► Deprecated as of v 6.0.0:

Requires IA_Fiends_Genies content.

  • Uses djinn, efreet, dao, jann and marid animations where sensible

BACK TO COMPONENTS INDEX



[40] ...

  ► Deprecated as of v 6.0.0:

Requires IA_Fiends_Genies, IA_IWD and IA_PST_Abishai content.
Requires IA_NWN_01_Modron content (only if certain mods are installed).

  • Nabassus get a green-grey tanar'ri animation
  • Chromatic Demon gets a somewhat more colourful base animation
  • Bebiliths (Longer Road and Drizzt Saga only) get the NWN animation
  • Some mariliths get a darker animation
  • Night hags get the PS:T night hag animation
  • Bone fiends get the NWN osyluth animation
  • Gelugons (only if added by a mod) get a frost salamander animation
  • Yochlols (except those in drow form) get a dark otyugh-based animation
  • White, green and red abishai get the relevant IWD or PS:T animations
  • Manes get the IWD drowned dead animation
  • Erinyes get a black-winged elf avatar
  • Succubi get the NWN succubus animation
  • Maurezhi get a dark ghoulish animation
  • Glabrezu get the proper glabrezu animation

Mymod > ComponentsBACK TO TOP

Screenshots


1PP basic example (1ppv4: Spell tweaks)



1PP complex example

These animations do not exist in a typical Baldur's Gate II game, though the slots exist and can display the relevant Icewind Dale content if ported. Hover your cursor over each animation to see its name.


hover to show original content


Mymod > ScreenshotsBACK TO TOP

Troubleshooting


These are some general tips if you have problems getting the game working, with or without this or other mods. Many times, errors have to do with the game engine itself or the manner of installation or gameplay. The game recommends deleting all files out of the /cache, /temp and /tempsave 📁 sub-folders in your game folder to see if that resolves the problem before any further troubleshooting.




Symptom: Game freezes or crashes to desktop (CTDs)


Sometimes the game displays an "assertion error" in a pop-up window when this happens, but often times it doesn't. To enable the full error message, open the file baldur.ini in your game folder with a text editor (such as Notepad). If you find you can't edit it or save changes in Windows Vista or 7, see this topic for assistance.

Under the [Program Options] section in the file, type Logging On=1 (unless it's already there). While you're there, you may also want to make sure Debug Mode=1 is there to enable the CLUA Console for debugging and testing. Save the file and exit. Now go back into the game and try to reproduce the crash. Then look in your game folder again for the Baldur.err file and open it with a text editor to analyse its contents.




Symptom: Game crashes with no Baldur.err log and shows either a black screen or a pop-up window indicating an error at offset 005ca8a8


This usually indicates an animation-related issue. Make sure you have the latest version of the mod. If you've installed other mods after it and have this issue, install the fix available here.




Symptom:

ERROR: error copying [infinityanimations/content/somefile.bam]
ERROR: [SOMEFILE.CRE] -> [override/SOMEFILE.CRE] Patching failed (COPY)
Stopping installation because of error.
(with no other error message)

Less-than-informative messages like these may indicate you're installing to a hard drive with a low data transfer rate or an antivirus program is active during installation (which can also affect data transfer). Try installing to an internal drive with antivirus protection disabled during the install. If unsure, disconnect from the Internet (either unplug your network cable or disable your wireless adaptor) and turn off all memory-resident programs during the install. To get a list of these, go to Start > Run and type  msconfig  where it says "Open:" then click OK. When the System Configuration Utility appears, click on the Startup tab. The only really necessary programs that need to be loaded in memory at startup are those related to your graphics chip (typically ATI or NVIDIA). Uncheck everything else, reboot and try installing the mod again. There are well-documented issues with installing mods while Avast antivirus is running, so make absolutely sure all components of Avast are completely disabled.




Other issues


If you have more than one large mod installed, please refer to the Megamod FAQ for more troubleshooting tips.


If none of this resolves your issue, or you have mod-specific issues, please report the problem in the mod's forum. Include the contents of your WeiDU.log file in the post, or attach it if it's large.


Mymod > TroubleshootingBACK TO TOP

Credits


Author: Author
WeiDU coding: coder1, revised by coder2
Support: maintainer


For support or questions, please visit the mod forum.




Special Acknowledgements to:
  • Spellhold Studios team for hosting the mod (Forums).
  • machin for permission to use blabla.
  • dugland for coding help.
  • trucmuche for coding help and suggestions.
  • bidule for dialogue help.
  • xxx for the yyy translation.
  • zzz for proofreading.
  • ...
  • Everyone else from the La Couronne de Cuivre, The Gibberlings Three, Spellhold Studios forums, and the other Infinity Engine gaming and modding communities who offered their help and support.



Programs/tools used in creation:



Copyrights

Feel free to pick any sentience or formatting that fits your needs, or write yours.

MYMOD is not developed, supported, or endorsed by BioWare™ or Interplay/BlackIsle, Overhaul, Beamdog or the Wizards of the Coast. It was developed by AUTHOR, based on material from the game Baldur's Gate II and its expansion.

All mod content is ©AUTHOR.

Baldur's Gate II: Shadows of Amn and Baldur's Gate II: Throne of Bhaal © TSR, Inc. The BioWare Infinity Engine is © BioWare Corp. All other trademarks and copyrights are property of their respective owners.


This mod was created to be freely enjoyed by all Baldur's Gate II players, and its content is free of rights. However, it should not be sold, published, compiled or redistributed in any form without the consent of the author.

Please note that any and all redistribution and/or hosting of this mod is prohibited without permission from the author.


If there are any copyright issues or this statement needs revision, then please contact me and advise me what to do about it. Most notably, if you see any artwork in this mod that might conflict with Copyright rules, please let me know as soon as possible, and I will remove the conflicting content immediately.


MYMOD is not developed, supported, or endorsed by BioWare™ or Interplay/BlackIsle, Overhaul, Beamdog or the Wizards of the Coast. It was developed by AUTEUR, based on material from the game Baldur's Gate II and its expansion.

All mod content is ©AUTHOR.

Baldur's Gate II: Shadows of Amn and Baldur's Gate II: Throne of Bhaal © TSR, Inc. The BioWare Infinity Engine is © BioWare Corp. All other trademarks and copyrights are property of their respective owners.


This mod was created to be freely enjoyed by all Baldur's Gate II players, and its content is free of rights. However, it should not be sold, published, compiled or redistributed in any form without the consent of the author.

Please note that any and all redistribution and/or hosting of this mod is prohibited without permission from the author.


If there are any copyright issues or this statement needs revision, then please contact me and advise me what to do about it. Most notably, if you see any artwork in this mod that might conflict with Copyright rules, please let me know as soon as possible, and I will remove the conflicting content immediately.


The modding community for the Infinity Engine has been going strong for more than 10 years now, and is the culmination of thousands of unpaid modding hours by fellow fans of the game. Modders produce their best work and players get the best, well-supported mods when we all work together.

There are two big ways to upset this harmony. One is to claim someone else's work as your own. The second is to host and redistribute a mod without permission from the author(s).

Be kind to your fellow players and modders. Don't do either.


Creative Commons License This work (including all code and documentation) is licensed under a Creative Commons Attribution-Noncommercial 3.0 Unported License. You are free to share (copy, distribute and transmit) and to remix (adapt) this work, except for commercial purposes. See the Creative Commons Public License for more details. Please post any changes or updates at the mod's forum.

All copyrights and trademarks are the property of their respective owners.


Mymod > CreditsBACK TO TOP

Version History


If your mod is hosted at GitHub, you can save yourself trouble of creating mod packages manually by using this tool. It produces zip and IEMod packages for you when you create mod release. It is very easy to use and most SHS mods are released with it. For further documentation, please read this.


Version 2.0.0  (Month day, year)
  • Major updates:
    • Added mymod.ini metadata file to support AL|EN's "Project Infinity".
    • Renamed setup-mymod.tp2 -> mymod.tp2 to support AL|EN's "Project Infinity".
  • Integrated all code and BWP Fixpack fixes:
    • fix ref 1.
    • fix ref 2.
  • Added native EE games compatibility.
  • Specific components fixes:
    • Main component: xxxx.
    • component #nn: blabla.
    • ...
  • Split code into separate components for more comfortable readability. 😉
  • Commented code as much as possible.
  • Coding simplification:
    • Used new and more efficient WeiDU functions and got rid of deprecated functions (such as DECOMPILE_BCS_TO_BAF and DECOMPILE_DLG_TO_D)
    • Minor fixes...
  • Updated readme.
  • Added Language translation (translator's name).
  • Traification. Feel free to provide me with translations. I will include them as soon as possible.
  • Updated WeiDU installer to v247.


Version 1.0.0  (Month day, year)
  • Initial release.


Mymod > Version HistoryBACK TO TOP