Vintage Story - Mod Organizer 2 Support Tools

CURRENTLY INCOMPATIBLE WITH 1.22.x

 

This suite adds support for vintage story in mod organizer 2 (MO2) and offers extra functionality.
Using this tool, you can more easily organize your mods and manage different mod presets and profiles.

 

 

Features:

• Easily install mods in MO2
• Organize your mods in any order you'd like
• Add seperators to categorize your mods.
• Add notes to any mod to help organize.
• Use different profiles for different modpack installations.
• Install mods directly from the modDB using 1-click-install
• Update mods with 1-click-install
• Manage mod config presets

 

 

 

 

 

How to install:

Obviously, it requires MOD ORGANIZER 2 , Scroll down to the downloads and download either the 7z file or exe file to install.

I recommend getting the 7z file and extracting it to it's own folder. This helps with isolating functionality between different MO2 instances.
Download the archive here and put the contents in your MO2 installation. It should be 2 folders: "plugins" and "Vintage Story MO2 Support"

Just point MO2 to your vintage story install folder and it should automatically use the right folders for mods.
When you open it for the first time it should give you a short tutorial on how to use MO2.

 

How to use:

• Setting up 1-click install:
  Run VS MO2 Manager.exe, enter both your Vintage Story installation path & your MO2 Instance path. (IMPORTANT: POINT THE MO2 PATH TO THE VINTAGE STORY INSTANCE, IF YOU'RE USING A GLOBAL INSTALLATION, THIS IS NOT THE MO2 INSTALLATION.)
  If you're not sure, you can open mo2 and click the little folder icon to the right of the profile selection and click on "Open Instance Folder". This shoudld contain a mods and dowloads folder besides a  bunch of other. This is where you should point it.
  
  Now you can press the "set ModDB Protocol" button and it will setup the program to use MO2 to install mods instead of the default vintage story.
  To reset the behaviour back to defauly, simply click the "Reset ModDB Protocol" Button.
  
  Now, when you press a 1-click install link on ModDB it will download the mod and move it into the appropriate folder in MO2. You might have to refresh MO2 to see the effect.
  By default, it will keep the old version in a folder in case you want to quickly revert.
  
  Optionally, you have the choice to have old versions deleted on downloading a new version, effectively updating the mod.
  You also have the option to keep any downloaded archives in MO2
  Simply tick the boxes to make your choice.

 

• Manually installing mods:
  Included in this package is a custom installer plugin for MO2.
  This means that, when installed, whenever you install a mod through MO2 manually, it will simply make a new mod and move the archive to the correct folder without unpacking.
  
  To do this: Click the second button on the top toolbar with the disk icon. Point MO2 to the archive you want to install. The installer will take it from here and your mod will be installed correctly.
  
  
• Managing config presets:
  You can manage different mod config presets using the tool as well.
  When first starting the tool, the dropdown menu will be empty. To save your current config files, press the "Save current set" button and enter a name.
  This will make a copy that you can always return to. Make as many presets as you like.
  
  If you want to load a preset you've made, select your preset in the dropdown menu and press the "Load selected set" button. This will make a backup of the files currently present in your mod config folder in case you didn't mean to load a new one
  It will then remove all old config files and copy all files of the selected preset into your mod config folder.
  
  Highly recommended to use in combination with MO2's profiles feature so you can match modlists with config presets

 

• Migrating mods into MO2:
  Run VS MO2 Manager.exe. Click on the "Migrate Mods" button. This will prompt you to select a folder containing your mod zip files.
  Select your folder and it will import all your mods into MO2. It doesn't delete anything for safety reasons.

 

• Starting VS Through MO2
  Once you have installed and organized your mods to your liking (don't forget to enable them), press the Run button on the top right (make sure Vintage Story is selected in the menu to the left of it).

 

Updating Mods:


I highly recommend you check out mo_mo's MO2 updater plugin. It works flawlessly and all withing the MO2 program. Thank you for making this mo_mo!

 

For those who use the Mods Updater, If you press the button with the two cogs at the top of MO2, press the plus button on top and point to the exe file of the Mods updater. This will add the program to the executable list. Now you can run the program through MO2 just like you would launch the game and it will work with the virtual file system. The only caveat is that the newly updated mods will appear in the overwrite folder in MO2 all the way at the bottom of the mods list. You can simply double click overwrite and drag the files to their respective mods in the list to but them back in their place. I don't think I can make a workaround for this but it's a small problem.
Also, the plugin is setup to use vintage story's installation folder's mod folder, not the one located in the documents folder. You might have to configure Mods Updater to point here instead.

 

Reminders:
If you are using a global installation of MO2 that handles multiple instances of different games, there's a couple things to keep in mind:
- Point the manager tool to your instance installation and not your MO2 installation. See the "setting up 1-click install" for more info

- The installer plugin automatically has the highest priority and this is installed in the plugins folder. This means that it will also register for any other instances you might have and therefore use the custom installer there too.
   You will have to manually disable the plugin in the plugins menu of the other instances. Simply press the wrench and screwdriver icon on the top to go to the settings of the instance, go to the plugins tab, find "VS Archive Installer" under the installer section and disable it.
   It should now be back to default behaviour.

 

Known Problems:

• Rare bug if the file contained in the ModDB API contains an illegal character (Very rare, only encountered once and will throw a very obvious error)

 

Planned Features:

• Profile specific config files DONE!
• Download directly to MO2 with click-to-install DONE!
• Improved 1-click install support (no more re-archiving) DONE!
• Custom installer plugin  DONE!
• Smarter plugin behaviour

 

If you encounter any issues, bugs or anything else, please let me know.
The source code is included in the src folder if you're curious

 

Thank you to: VoiCat, ZTBot and Yallendallis for helping with testing