-
Notifications
You must be signed in to change notification settings - Fork 5
Home
Welcome to the MCInstance Loader wiki!
Please take the time to read every page and the README file to better understand this mod's feature set.
Getting started using MCInstance Loader is fairly easy. To use any feature of this mod, you need to create a new MCInstance file.
To do so, either follow the different pages of the wiki, or adapt the default template inside the .minecraft/config/mcinstanceloader/pack folder to your needs.
Also note, the mod will automatically create a pack.mcinstance from the pack folder if there is no pack.mcinstance or pack.mcinstance.disabled file already.
If you don't have the pack folder, just launch your game once to create it. You'll also notice two other files along it: config.cfg and details.log.
The config.cfg file lets you customise a bunch of things of the mod. This is where you can configure stuff like the successful install message, whether to rename or delete the mcinstance file after a successful install, or even whether to disable the file disabling completely for a faster pack development process among others.
For instance, you can choose to disable the StopModReposts check for website URLs, although this puts you at risks of malware or outdated files from malicious reposting websites.
Starting from 2.0, the mod also includes a built-in update checker that you can highly configure from there. It can automatically update the mod, just tell you the link or even be disabled entirely.
As we know, the entire purpose of this mod is to automatically install mcinstance files. However, a user might want to overwrite some file included in a modpack for his own.
This is why the mod also bundles a carryover feature.
It lets modpack players put any files there (while respecting the .minecraft folder structure), and they will be copied back after the installation is complete. You can also fully disable any mod you don't like this way by replacing it with an empty file for example.
To use it, simply place files into the newly created carryover folder inside .minecraft (minecraft root).
You might have noticed it in the config.cfg file, there is a verbose mode. Enabling this will make the mod log way more things into the game's log.
However, you probably won't have to use it because the mod also created a details.log file.
In order to facilitate troubleshooting, i decided to create a separate file for logs.
This has the benefit of only including the messages sent by the mod in an easier to read way. It will include every message, even if you disable the verbose mode. Its goal is to easily let the modpack dev see where they've gone wrong, which address they might have been mistyped or which property is incorrect.
In addition to this, the mod will also display an info screen after the installation, telling the player whether the pack has been succesfully installed or whether it failed, while showing a brief list of which errors happened and why.
In case of an error, the game will also show a button to open the details.log file directly, next to the (optionally timed) quit game button.
Most issues are generally caused by an error in the URL, a server being down momentarily or permanently, a different hash from what is given in the resources.packconfig file, an antivirus blocking the download or an incorrect file name. Check those in priority if you have an issue.
Feel free to create an issue here if you can't manage to solve the issue yourself. Make sure the issue you're reporting wasn't already posted there though, as it may be a known issue that i'm already working to fix.