Rustique

The complete Mod Manager for Vintage Story!

For Linux, Windows & Mac (coming soon)

Written in Rust; fitting, right?

Hiya! 

I've created a new mod manager for Vintage Story as I felt there was a need for a fast AF solution that handles dependencies.

Platforms:

THIS VERSION IS FOR WINDOWS 

This version is identical to the linux version, other than it works on Windows and has a different default mod path.

Linux Version: Linux

Mac: You will need to build from source for now.

!!Caution!!: This is Alpha software. Back up your mods just in case and expect things to blow up on occasion. Expect extra verbosity and annoying messages. :3

~DISCORD~

I created a discord to make it easier to get in touch with me about bugs or suggestions you might have. This will also be the best place to get dev builds if you want to do some testing. These builds will be the ones between the versions released here on the mod site.

https://discord.gg/mXXVTgQgzs

How to use? (Windows):

1. Download the zip from the mod website and extract the file wherever you want.
2. Use Powershell to navigate to where you extracted Rustique
3. Then you can run it like any other terminal program: .\Rustique.exe -V

NOTE: Check out the help command to see a full list of what Rustique can do. Below I show the long form of the flags, but there are shorter versions of each one as well.

Basic update routine

• $ .\Rustique.exe sync   (compile a local JSON data structure of installed mods and synchronize with the VS Mods server to check currently available versions)
  
• $ .\Rustique.exe list --updates    OR     .\Rustique.exe list    (the `--updates` flag shows only installed mods that are known to have updates available)
• $ .\Rustique.exe update --all   (update everything, including dependencies)
  

It's as easy as that! I know it seems like a lot, 3 commands and all.. But the point of Rustique is to give you full controll and flexibility when managing your mods. This means you pick how and when you update your mods.

Installing missing dependencies

Tired of having to seek out all the dependencies for the cool new mod you just found? Rustique can handle that as well!

• .\Rustique.exe sync     (You need to sync first so Rustique knows whats already on the system.)
• .\Rustique.exe install --missing-dependencies

And that's it! This command will recursively download all missing dependencies for all currently installed mods and the dependencies for those. It's nice and fast!

Install a new mod with Rustique

Rustique has the ability to install new mods for you, provided you know the mod ID. This can be obtained from the URL bar on the mod page on the website.

NOTE: Not all mods show their mod ID in the url bar!

Example:

https://mods.vintagestory.at/alchemy  -- alchemy is the mod ID for this mod. As you can see, the ID appears in the URL bar. That ID can then be used with Rustique to install it and any dependencies it might have.

Example of a mod without a mod ID:

https://mods.vintagestory.at/show/mod/23518   -  This mod shows a number, but that number is actually something called an "ASSET ID": this will not work to download the mod! If the VS Mods API is updated to enable us to install by numeric ID (e.g. 23518), Rustique will be updated to handle it.

So, with 'alchemy' ID known, let's see how to install a new mod:

• $ .\Rustique.exe install alchemy

It's that easy! Any dependencies will automatically be downloaded as well.

If you don't want to deal with the CLI for download, feel free to manually install mod. Rustique will be able to find and manage that without any issues. Just sync and update.

What about non-default mod locations?

With version v0.2.0 you can set the default mod directory through Rustique itself.

The following will set the default, so you dont have to type it everytime

.\Rustique.exe config set -m /path/to/your/mods

.\Rustique.exe list

You can still use .\Rustique.exe -m /path/to/mods  to run rustique on any dir you want, as -m takes priority.

There are other features to modify and you can check them out with .\Rustique.exe help config   (Not all functionality is implemented just yet)

Missing Features

There are several features that are still being worked on. This is an Alpha version, but it's stable and what is there works very well. If you do find any bugs or confusing behavior, please report them on the github page. You can leave a message here too, but I will see them faster on github.

• Smart Version Pinning & Management:
  
  • There is also no way to tell the program which version of the game or mod to download or avoid.

• Configurations
  • Configuration is in!! Not all functionaly is complete as of yet.

• Searching
  • Search is in! Checkout Rustique help search for more info!

• Modpacks!!
  • Right now there really isn't a way to create or use mod packs with Vintage Story. This will soon be a reality with Rustique!

• Mod Removal
  • You can install and update mods, but you can't remove them.

• Instances
  • If you have multiple servers you need to manage mods for, instancing will help with that. You'll be able to set a name for your instance and rustique will be able to manage the mods easily using that name. I'll have more info on how this works in the future, there are some systems that need created first for this to work.

• GUI
  • There is a GUI planned. I will not be working on that until the cli version is feature complete. But it will happen

• Localization
  • Localization is planned. This will prob take a while to get implemented and I will need volunteers as I only speak english.

Known Issues

• Rustique doesn't handle non-zip files from the mod site atm. Rustique will continue but that file will most likely not be downloaded.
• Some messages are noisy. This is expected and will eventually be cleaner and more user friendly.
• Not all fields for changing the look of the list and search displays are live, this will be coming shortly.

Special thanks

• MothHelix : For breaking things and doing extra testing!
• EDKE : For reporting bugs on github & mac testing!