Author: bibi
Mod Website and Forum: Mymod
Download the mod at Spellhold Studios
This is a readme file template for GitHub for mods developed and/or hosted at SHS. It is written in Markdown language. Although it is close enough to the HTML language, some formatting are not supported by GitHub, such as color display.
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. You just have 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 links and fill in appropriate texts. For some sections,I have been as exhaustive as possible: all you have to do is to choose paragraphs you are interested in and delete the others.
Short mod description: 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 formating, please have a look here and there.
CLICK ME
yes, an hidden code block!
GitHub markdown emoji listings:
Tip to underline text
This mod is designed to work on all 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.
- The conversion projects Baldur's Gate Trilogy (BGT), Baldur's Gate Tutu (Tutu), Icewind Dale-in-Baldur's Gate II (IWD-in-BG2), 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).
MYMOD is a WeiDU mod, and therefore should be compatible with all WeiDU mods. It has been tested on several different installations, and has so far worked perfectly. However, we cannot test every single one. If you encounter any bugs, please report them on the forum!
Though I am 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!
Although it is not required for the 1pp mod to function properly, BG2 and TOB players are strongly recommended to download and install the latest version of the BG2 Fixpack before proceeding with the installation of this mod.
- Please install mymod before mod A.
- Please install mymod After mod B.
- ...
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 Console 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.
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.
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.
MYMOD for Windows is distributed as an extractable compressed archive and includes a WeiDU installer.
Extract files from the archive into the folder of the game you wish to modify (the folder which contains the "CHITIN.KEY" file), using build-in "Right-click>Extract all..." Explorer fearure, 7zip, WinRAR, ZipGenius, or another file compression utility that handles .zip files. 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 the components settings.
MYMOD for Mac OS X is 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 📁 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.
Run setup-mymod.command in your game folder to reinstall, uninstall or otherwise change the components settings.
MYMOD 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 version of WeiDU for Linux from WeiDU.org and copy weidu and weinstall to /usr/bin. Following that, open a terminal, cd to your game installation directory, 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 you're unsure, running tolower and choosing both options is the safe bet.
To install, run weinstall setup-mymod in your game folder. Then run wine bgmain.exe and start playing.
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.
The installer includes the following components. The number of each is the component DESIGNATED number which gives it a fixed install position 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.
Main component description.
Or alternatively
➽ Main component description.
Component blublu description.
Component bloblo description.
To be used with a huge number of components.
The installer includes the following components. The number of each is the component DESIGNATED number which gives it a fixed install position and allows automated installers to specify component choices.
[10] Component blabla [main component]
[20] Component blublu
[30] Component bloblo
[40] ...
➽ [10] Component blabla (main component)
Main component description.
Component blublu description.
Component bloblo description.
☛ For support or questions, please visit the mod forum.
Author: bibi
- Spellhold Studios team for hosting the mod (Forums).
- The creators of the Baldur's Gate series: Bioware and Black Isle Studios.
- machin for permission to use blabla.
- dugland for coding help.
- trucmuche for coding help and suggestions.
- bidule for dialogue help.
- xxx for the French translation.
- yyy for proofreading.
- Everyone else from the The Gibberlings Three, Spellhold Studios forums, and the other Infinity Engine gaming and modding communities who offered their help and support.
- etc.
- WeiDU, by Wes Weimer, the bigg and Wisp.
- Near Infinity, by Jon Olav Hauglid, FredSRichardson, and Argent77.
- Infinity Explorer, by Dmitry Jemerov / bigmoshi.
- DLTCEP, by Avenger.
- CreMaker_v3.1.9.
- IESDP, maintained by igi and lynx.
- G3 Debugging Suite, by CamDawg.
- BAM Workshop, by Glenn Flansburg.
- BAMWorkshop 2, by Andrew Bridges.
- BAM Batcher, by Miloch.
- Adobe Photoshop
- GIMP, by the GIMP team.
- GIF Movie Gear.
- Blender, by the Blender Foundation.
- 3ds Max.
- Notepad++, by the Notepad++ team, Don Ho, and the spellcheck plug-in.
- WeiDU Highlighter for Notepad++, by Argent77.
- ConTEXT Text Editor, by Eden Kirin.
- WeiDU ConTEXT Highlighters , by Idobek, updated by cmorgan.
- EditPad Classic, by Jan Goyvaerts.
- PSPad, by Jan Fiala.
- Bulk Rename Utility, by TGRMN Software.
- Visual Studio Code, modern, cross-platform editor.
- Visual Studio Code - BGforge MLS - Syntax highlighting and more.
- Infinity Auto Packager, automatically generates Infinity Engine mod packages.
Pick what you think insightful:
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.
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.
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.
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).
☛ 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.
- modification 1
- modification 2
- modification 3
- modification 2
- modification 2
- modification 1
- Initial release.