Jump to content

Heavy Mod Manager: Difference between revisions

no edit summary
No edit summary
No edit summary
Line 3:
The mod manager is currently able to apply file replacement mods only. The program is still under development, so many features are still planned.
 
==UsePlaying Guidemods==
===What you'll need===
* [https://github.com/igorseabra4/HeavyModManager/releases Heavy Mod Manager]
* Latest release of [https://dolphin-emu.org/ Dolphin Emulator] (make sure you get the latest development build, '''not 5.0 stable''').
* A copy of the GameCube or Wii ISO of the game(s) you want to play mods on (if you have a modded Wii, you can dump it from the GameCube or Wii disc with a homebrew application).
 
===Configure Dolphin path===
Line 14:
[[File:HeavyModManager 1.png]]
 
Click on Settings -> Choose Dolphin Path and a file selector window will open. Choose the location of your Dolphin executable (Dolphin.exe). Usually, you will find it on C:\Program Files\Dolphin-x64\, but this might vary depending on your Dolphin installation. If you have a shortcut on your desktop or elsewhere, you can select that as well. This will enable Heavy Mod Manager to launch Dolphin.
 
===Adding a game to the mod manager===
To addbe a gameable to play mods, the mod manager, must first youcreate mustan extractinternal backup of the filesgame. fromThis theprocess ISOmust usingbe Dolphin.repeated for any games you wish to add to the mod manager:
 
# Launch Dolphin and add your ISO to the game list.
# Right click the ISO on the game list and select Properties. Navigate to the Filesystem tab.
# Right click the root of the disc (first item on the file tree) and select Extract Entire Disc. Create a new folder and wait while the disc's files are extracted to it.
# In your new folder, there should be two folders: one named "files" and another named "sys".
# In Heavy Mod Manager, select the game you are adding from the "Choose Game" dropdown.
# Click on the "Create Backup" button. A file selector window will open. Navigate to the folder where you extracted your discgame's to.ISO Infile the "sys" folder,and select the "main.dol" fileit.
# The mod manager will create aan internal backup of the game's files. The window might be unresponsive for a few seconds, this is normal. After that, a message box will appear, notifying that the backup was successfully created.
# A message box will appear, notifying that the backup was successfully created. This means that now you can delete the "files" and "sys" folders which were extracted from Dolphin, as you do not need them anymore.
# You can start playing mods on this game now! If you want to test, click on "Apply Mods" and then on "Apply + Launch Game", even if you don't have any mods installed yet. Dolphin should launch with the selected game already running.
 
# You can start playing mods on this game now! If you want to test, click on "Apply Mods" and then on "Apply + Launch Game", even if you don't have any mods installed yet. Dolphin should launch with the selected game already running.
This process must be repeated for any games you wish to add to the mod manager.
 
===Installing and playing mods===
To install a mod:
To install a mod, click on the "Install Mod" button and select a mod's ZIP file (which you probably downloaded from the wiki or another place). This will install the mod. Click the checkbox next to the mod's name to enable it, as seen on the image below. You can enable and disable as many mods as you want to, as well as reorder them using the arrow buttons. The selected mods will be applied, in order from top to bottom, when you click the "Apply Mods" or "Apply + Launch Game" buttons. Note that not all mods are compatible with each other, meaning many mods (such as stage mods) are unlikely to work if multiple are enabled at the same time.
 
# Click on the "Install Mod" button and a file selector window will open. Select a mod's ZIP file (which you probably downloaded from the wiki or another place). This will install the mod.
# Click the checkbox next to the mod's name to enable it, as seen on the image below. You can enable and disable as many mods as you want to, as well as reorder them using the arrow buttons.
# Click on "Apply Mods" to apply the mods. The selected mods will be applied in order, from top to bottom. Note that not all mods are compatible with each other, meaning many mods (such as stage mods) will probably not work if multiple are enabled at the same time.
# Click on "Apply + Launch Game". This will apply the mods (if they haven't been applied already) and launch Dolphin with the modded instance of the game.
 
[[File:HeavyModManager 2.png]]
 
Note that installing mods from ZIPs is only possible if the mod's creator made a ZIP file that is compatible with the mod manager. If you try to load an uncompatible ZIP in the mod manager, it will display an error. If you want to play a mod from an uncompatible ZIP, you must create a new mod and add the files to it manually. This is explained below.
 
===Creating a mod=mods==
Creating a new mod within the mod manager is necessary if you're a mod developer creating a new mod or if you just want to play a mod from a ZIP file that was not created withby the mod manager in mind. You will need to create a new mod from the mod manager, then add the mod's files to the foldermod's it createsfolder.
 
First, click on Manage -> Create Mod. This will open the Create New Mod window.
Line 45 ⟶ 44:
[[File:HeavyModManager 3.png]]
 
On this window, you should type in the mod's name, creator name and aan optional short description. You can also set an optional date/time for when the mod was created and last updated.
 
The last field, Mod ID, is an ID that is generated automatically for the mod which should be unique among all mods, by all creators, for all games (installing a mod will overwrite a mod with that ID if it already exists). It's recommended not to change this from the default text, but you can if you believe another mod might already use this ID. You cannot change a mod's Mod ID after it is created.
 
Once you click on "Create Mod", a folder for the mod will be created and will be opened for you on a file browser window:
Line 86 ⟶ 85:
 
Developer mode also forces any running Dolphin instances to close when you click on "Apply + Launch Game". This means you do not need to close your running Dolphin instance before running the game, as the mod manager will do it automatically for you.
 
==Adding a game from extracted files==
Aside from adding the game from the ISO, you can also add it from the game's extracted files. The steps are very similar to the [[Setting up Dolphin for modding]] guide, as you can add the game's main.dol file to create the mod manager's backup.
 
# Launch Dolphin and add your ISO to the game list.
# Right click the ISO on the game list and select Properties. Navigate to the Filesystem tab.
# Right click the root of the disc (first item on the file tree) and select Extract Entire Disc. Create a new folder and wait while the disc's files are extracted to it.
# In your new folder, there should be two folders: one named "files" and another named "sys".
# In Heavy Mod Manager, select the game you are adding from the "Choose Game" dropdown.
# Click on the "Create Backup" button. A file selector window will open. Navigate to the folder where you extracted your disc to. In the "sys" folder, select the "main.dol" file.
# The mod manager will create a backup of the game's files. The window might be unresponsive for a few seconds, this is normal.
# A message box will appear, notifying that the backup was successfully created. This means that now you can delete the "files" and "sys" folders which were extracted from Dolphin, as you do not need them anymore.
# The game's backup should have been created and you can start adding and playing mods to it now.
 
==Planned features==
Features planned for Heavy Mod Manager's future:
* DOL patching
* Support for Xbox and PS2 emulators
* Save file redirection
* Support for automaticallyAutomatically enabling per-mod AR or Gecko codes
* Support for editing the game's INI configuration (instead of just replacing it with a mod's as it does now)
* Automatically editing the game's INI configuration
* Support for Xbox and PS2 emulatorsversions of the games
 
==External Links==
Cookies help us deliver our services. By using our services, you agree to our use of cookies.