-
Notifications
You must be signed in to change notification settings - Fork 10
Primary
These commands are the core of Rustique and the primary ones you will use day-to-day.
Usage: Rustique sync [OPTIONS]
Sync is the underlying function that Rustique uses for everything. It creates a file called rustique-sync.json in your mods folder and holds information about all your mods. This is essentially a database, but simpler and human-readable. I had considered using a sqlite db, but I felt it's important to see what Rustique was doing.
Since the sync file is treated as the source of truth for Rustique there are a few commands that run sync automatically if it detects there is no valid rustique-sync.json file; such as List and Update.
Sync is pretty simple and only have a few flags.
-
-s, --sync-search-db- While not actually a database, just another json file. This sync command saves a local copy of the api call
https://mods.vintagestory.at/api/modsthat hase some information about every mod on the mod site. - The file saved is about ~2mb. Rustique uses this for its search functionality as I found the api search to be terrible. Using this also speeds up searching significantly as the only API call is the initial one to save the file.
- Rustique runs this automatically
once a day.
- While not actually a database, just another json file. This sync command saves a local copy of the api call
-
-g, --sync-game-versions- Rustique saves a local copy of
https://mods.vintagestory.at/api/gameversions/as well. - This contains the valid game versions for Vintage Story and is used to verify game versions are correct for the Download command and for version pinning.
- Rustique runs this automatically
once a day.
- Rustique saves a local copy of
Sync is the first command you run before you an update your mods. It also provides extra information to the List command.
$ Rustique syncโญโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฎ
Syncing... /home/..../.config/VintagestoryData/Mods
โฐโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏ
โญโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฎ
Sync operation completed: 1.44s
โฐโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏPretty straight forward. You run this command, then proceed to use list, update, delete to actually manage your mods.
The sync file is saved to any directory you tell Rustique to look at for mods.
These locations are the recommended default location for mods. There are technically 2 mods folders by default, one in the Vintage Story binary directory and the ones I outline below. It's recommended to use the locations below and NOT the mod folder thats next to the VS binary.
-
Linux & Mac
~/.config/VintagestoryData/Mods
-
Windows
%appdata%/Vintagestory/Mods
When you run sync, a rustique-sync.json file will be created at one of those locations. However, you change the default mod location via the Config settings.
If you have mods in a different location, you can point Rustique to that folder manually OR update the Configs default location.
I used a location from a modpack that is installed
$ Rustique -m ~/.config/rustique/modpacks/installed/tmmv syncโญโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฎ
Syncing... /home/.../.config/rustique/modpacks/installed/tmmv
โฐโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏ
โญโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฎ
Sync operation completed: 2.29s
โฐโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏBecause we passed -m /path/to/mods a sync file will now be saved at that location containing all the info about the mods in that folder only.
Usage: Rustique update [OPTIONS] [MOD_IDS]...
Important Make sure to run Sync first or there will be nothing to update.
Update is exactly what it sounds like, it updates your mods. You can update mods individually or all at once.
-
-a, --all- Used to update all mods installed, if any. This works even if there is only 1 mod that needs updating.
-
-k, --keep-old-files- By default, Rustique will delete the old mod file after updating. UNLESS the files are the same name.
- Setting this flag will tell Rustique to leave the old file in place. IMO it's better to just make sure backups are enabled instead of using this flag. Rustique doesn't really manage multiple of the same mods well, it always grabs the newest version as priority.
- I mainly use this for testing, but its available if you have a need.
$ Rustique update -aโญโโโโโโโโโโโโโโโโโโโฎ
Updating mods...
โฐโโโโโโโโโโโโโโโโโโโฏ
โญโโโโโโโโโโโโโโโโโโโโโโโโโโโฌโโโโโโโโโฎ
โ Successfully Installed โ โ
โโโโโโโโโโโโโโโโโโโโโโโโโโโโชโโโโโโโโโก
โ Alchemy โ 1.6.50 โ
โ Combat Overhaul : Armory โ 0.2.4 โ
โฐโโโโโโโโโโโโโโโโโโโโโโโโโโโดโโโโโโโโโฏ
โญโโโโโโโโโโโโโโโโโโโโโโโโโโโฎ
โ Total mods Installed 2 โ
โฐโโโโโโโโโโโโโโโโโโโโโโโโโโโฏ
โญโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฎ
Update operation completed: 0.50s
โฐโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏ
โญโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฎ
Syncing... /home/.../.config/VintagestoryData/Mods
โฐโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏ
โญโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฎ
Sync operation completed: 1.46s
โฐโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏ
In this example both Alchemy & Combat Overhaul : Armory were updated. Rustique will everything that needs it.
Lets say you ONLY wanted to update the Alchemy mod.
$ Rustique update alchemyโญโโโโโโโโโโโโโโโโโโโฎ
Updating mods...
โฐโโโโโโโโโโโโโโโโโโโฏ
โญโโโโโโโโโโโโโโโโโโโโโโโโโฌโโโโโโโโโฎ
โ Successfully Installed โ โ
โโโโโโโโโโโโโโโโโโโโโโโโโโชโโโโโโโโโก
โ Alchemy โ 1.6.50 โ
โฐโโโโโโโโโโโโโโโโโโโโโโโโโดโโโโโโโโโฏ
โญโโโโโโโโโโโโโโโโโโโโโโโโโโโฎ
โ Total mods Installed 1 โ
โฐโโโโโโโโโโโโโโโโโโโโโโโโโโโฏ
โญโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฎ
Update operation completed: 0.49s
โฐโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏ
โญโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฎ
Syncing... /home/.../.config/VintagestoryData/Mods
โฐโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏ
โญโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฎ
Sync operation completed: 1.51s
โฐโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏEven though I have the armory mod installed, rustique only updated alchemy. Super simple!
Usage: Rustique list [OPTIONS]
Running Sync first is a good idea to get the most accurate info. If there is no sync file present, sync will run first automatically.
-
-u, --updates- Shows only mods that have updates available.
-
-g, --game-versions <MAJOR.MINOR>- This flag shows all the valid VS game versions. This is most useful when using the Download command or for pinning game versions.
- Example: -g 1.20 - This will show all valid game versions for 1.20.X.
-
-e, --export-as <TYPE>- Export to a different format. Right now only
csvis a valid choice. More may be added in the future
- Export to a different format. Right now only
-
-c, --columns <COLUMNS>- --columns overrides the listed columns shown with the values you pass here
- Valid columns:
[name, mod-id, version, latest-version, deps, missing-deps, changelog, description, website, game-version, last-update-local, last-update-remote, pinned-version, has-backup, filename, mod-url] -
NOTE: If you choose to display the changelog AND export as csv, the changelog column may get truncated due extra long values. Save the output to a file if you need to save the results with changelog with
-f /path/to/file
-
-f, --file-path- Save the output of list to a file. This may be required if you are displaying the changelog and want to export as CSV.
-
REQUIRES
-e csvfor now.
List is one of the more simple commands. It'll show you some info about all the mods you have installed. The table columns can be configured in Config.
Normal usage
$ Rustique listโญโโโโโโโโโโโโโโโโโโโโโโโโโโโฌโโโโโโโโโโโโโโโโโฌโโโโโโโโโโฌโโโโโโโโโโโโโโโโโฌโโโโโโโโโโโโโโโโโโโโโฌโโโโโโโโโโโโโโโโโโโโโโโฌโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฎ
โ Name โ ModID โ Version โ Latest Version โ Dependencies โ Missing Dependencies โ Description โ
โโโโโโโโโโโโโโโโโโโโโโโโโโโโชโโโโโโโโโโโโโโโโโชโโโโโโโโโโชโโโโโโโโโโโโโโโโโชโโโโโโโโโโโโโโโโโโโโโชโโโโโโโโโโโโโโโโโโโโโโโชโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโก
โ Alchemy โ alchemy โ 1.6.50 โ 1.6.50 โ โ โ An alchemy mod that adds a couple of player enhancing potions. โ
โโโโโโโโโโโโโโโโโโโโโโโโโโโโผโโโโโโโโโโโโโโโโโผโโโโโโโโโโผโโโโโโโโโโโโโโโโโผโโโโโโโโโโโโโโโโโโโโโผโโโโโโโโโโโโโโโโโโโโโโโผโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโค
โ Combat Overhaul โ combatoverhaul โ 0.3.9 โ 0.3.9 โ [overhaullib@*] โ โ โ
โโโโโโโโโโโโโโโโโโโโโโโโโโโโผโโโโโโโโโโโโโโโโโผโโโโโโโโโโผโโโโโโโโโโโโโโโโโผโโโโโโโโโโโโโโโโโโโโโผโโโโโโโโโโโโโโโโโโโโโโโผโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโค
โ Combat Overhaul : Armory โ armory โ 0.2.3 โ 0.2.4 โ [combatoverhaul@*] โ โ Weapons, shields and armor โ
โโโโโโโโโโโโโโโโโโโโโโโโโโโโผโโโโโโโโโโโโโโโโโผโโโโโโโโโโผโโโโโโโโโโโโโโโโโผโโโโโโโโโโโโโโโโโโโโโผโโโโโโโโโโโโโโโโโโโโโโโผโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโค
โ Overhaul Library โ overhaullib โ 0.2.8 โ 0.2.8 โ โ โ โ
โฐโโโโโโโโโโโโโโโโโโโโโโโโโโโดโโโโโโโโโโโโโโโโโดโโโโโโโโโโดโโโโโโโโโโโโโโโโโดโโโโโโโโโโโโโโโโโโโโโดโโโโโโโโโโโโโโโโโโโโโโโดโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏAs you can see there a good bit of information here. And if you notice, one mod is out of date. (in the terminal you will see pretty colors :3)
Lets list only by mods that need updating.
$ Rustique list -uโญโโโโโโโโโโโโโโโโโโโโโโโโโโโฌโโโโโโโโโฌโโโโโโโโโโฌโโโโโโโโโโโโโโโโโฌโโโโโโโโโโโโโโโโโโโโโฌโโโโโโโโโโโโโโโโโโโโโโโฌโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฎ
โ Name โ ModID โ Version โ Latest Version โ Dependencies โ Missing Dependencies โ Description โ
โโโโโโโโโโโโโโโโโโโโโโโโโโโโชโโโโโโโโโชโโโโโโโโโโชโโโโโโโโโโโโโโโโโชโโโโโโโโโโโโโโโโโโโโโชโโโโโโโโโโโโโโโโโโโโโโโชโโโโโโโโโโโโโโโโโโโโโโโโโโโโโก
โ Combat Overhaul : Armory โ armory โ 0.2.3 โ 0.2.4 โ [combatoverhaul@*] โ โ Weapons, shields and armor โ
โฐโโโโโโโโโโโโโโโโโโโโโโโโโโโดโโโโโโโโโดโโโโโโโโโโดโโโโโโโโโโโโโโโโโดโโโโโโโโโโโโโโโโโโโโโดโโโโโโโโโโโโโโโโโโโโโโโดโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏAnd there you go! list -u really shines when you have lots of mods and only care about what needs to update.
This command will show all valid game versions for the major.minor that you provide. You can also show everything by passing -g 1 which will show all game versions in 1.X.X.
Version pinning and the Download commands use game version numbers.
$ Rustique list -g 1.20โญโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฎ
[1.20.11], [1.20.11-rc.1], [1.20.10], [1.20.9], [1.20.8], [1.20.8-rc.2], [1.20.8-rc.1], [1.20.7], [1.20.6], [1.20.5], [1.20.5-rc.3], [1.20.5-rc.2], [1.20.5-rc.1], [1.20.4],
[1.20.4-rc.4], [1.20.4-rc.3], [1.20.4-rc.2], [1.20.4-rc.1], [1.20.3], [1.20.2], [1.20.1], [1.20.0], [1.20.0-rc.9], [1.20.0-rc.8], [1.20.0-rc.7], [1.20.0-rc.6], [1.20.0-rc.5],
[1.20.0-rc.4], [1.20.0-rc.3], [1.20.0-rc.2], [1.20.0-rc.1], [1.20.0-pre.0]
โฐโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏUsage: Rustique install [OPTIONS] [MOD_IDS]...
Install lets you, well, install new mods. You need either the numerical ModID or the text ModID to download a new mod. These can be discovered by searching with Rustique search -q 'name of mod'. See Searching.
Any mod installed this way will also take care of its dependencies. If the dependencies are already installed, then it just downloads the mod itself
So you found your modid, you know its armor so lets download the latest version. Armor has a few dependencies, so we can see how that is handled.
$ Rustique install armorโญโโโโโโโโโโโโโโโโโโโโโโโโฎ
Installing.. armory
โฐโโโโโโโโโโโโโโโโโโโโโโโโฏ
โญโโโโโโโโโโโโโโโโโโโโโโโโโโฌโโโโโโโโฎ
โ Successfully Installed โ โ
โโโโโโโโโโโโโโโโโโโโโโโโโโโชโโโโโโโโก
โ Combat Overhaul โ 0.3.9 โ
โ Combat Overhaul: Armory โ 0.2.4 โ
โ Overhaul lib โ 0.2.8 โ
โฐโโโโโโโโโโโโโโโโโโโโโโโโโโดโโโโโโโโฏ
โญโโโโโโโโโโโโโโโโโโโโโโโโโโโฎ
โ Total mods Installed 3 โ
โฐโโโโโโโโโโโโโโโโโโโโโโโโโโโฏ
โญโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฎ
Syncing... /home/..../.config/VintagestoryData/Mods
โฐโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏ
โญโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฎ
Sync operation completed: 1.46s
โฐโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏ
โญโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฎ
Install operation completed: 4.58s
โฐโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏInstall found Armory and pulled in its dependencies; combat overhaul which has overhaul lib as its dependency. You can use List again to see all the dependencies for these mods. It handles dependency chains without any issue!
Maybe you have a specific version you want to install. Maybe the latest version has bugs and you don't want to deal with that. You can use Info to find versions for this mod that are valid. We'll use armory again here.
To install a specific version you can use modid@version instead of just modid
Lets find the version we want
$ Rustique info armoryโญโโโโโโโโโโโโฌโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฎ
โ 2651 โ Combat Overhaul: Armory โ
โโโโโโโโโโโโโชโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโก
โ Author โ Maltiez โ
โ URL โ https://mods.vintagestory.at/show/mod/15285 โ
โ Side โ both โ
โ Tags โ Weapons โ
โ Downloads โ 119834 โ
โ Follows โ 1030 โ
โ Comments โ 137 โ
โฐโโโโโโโโโโโโดโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏ
โญโโโโโโโโโโฌโโโโโโโโโโโโโโโโฌโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฎ
โ Version โ Game Versions โ Changelog โ
โโโโโโโโโโโชโโโโโโโโโโโโโโโโชโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโก
โ 0.2.4 โ 1.20.7 โ Fixed sabre recipe โ
โ โ โ โ
โ โ โ Added french translation by Kyane โ
โ โ โ โ
โ 0.2.3 โ 1.20.7 โ Changed long-axe smithing recipe โ
โ โ โ โ
โ 0.2.2 โ 1.20.7 โ Added sabres that deal more damage then 1h swords, but has lower damage tier โ
โ โ โ โ
โฐโโโโโโโโโโดโโโโโโโโโโโโโโโโดโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏFrom this list, we wanted to grab the version before the latest, 0.2.3. Lets install that.
$ Rustique install armory@0.2.3โญโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฎ
Installing.. armory@0.2.3
โฐโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏ
โญโโโโโโโโโโโโโโโโโโโโโโโโโโฌโโโโโโโโฎ
โ Successfully Installed โ โ
โโโโโโโโโโโโโโโโโโโโโโโโโโโชโโโโโโโโก
โ Combat Overhaul โ 0.3.9 โ
โ Combat Overhaul: Armory โ 0.2.3 โ
โ Overhaul lib โ 0.2.8 โ
โฐโโโโโโโโโโโโโโโโโโโโโโโโโโดโโโโโโโโฏ
โญโโโโโโโโโโโโโโโโโโโโโโโโโโโฎ
โ Total mods Installed 3 โ
โฐโโโโโโโโโโโโโโโโโโโโโโโโโโโฏ
โญโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฎ
Syncing... /home/..../.config/VintagestoryData/Mods
โฐโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏ
โญโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฎ
Sync operation completed: 1.47s
โฐโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏ
โญโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฎ
Install operation completed: 4.48s
โฐโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏAnd just like that you have a specific version installed! Now, if you run sync + update, it will update this version to the latest.
Dependency versions are taken directly out of the modinfo.json file that comes with the mod you installed. So if armory needs combat overhaul 0.2.8, then 0.2.8 will be installed.
Using Rustique to download your mods will always take care of dependencies automatically. BUT if you install mods in a different way, you may not have them. Let's use list to see a mod does not have its dependencies installed already.
NOTE: If you install mods outside rustique, you will need to run Sync manually to obtain info about it, otherwise rustique won't know anything about that mod.
$ Rustique listโญโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฌโโโโโโโโโโโโโโโโโโโโโฌโโโโโโโโโโฌโโโโโโโโโโโโโโโโโฌโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฌโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฌโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฎ
โ Name โ ModID โ Version โ Latest Version โ Dependencies โ Missing Dependencies โ Description โ
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโชโโโโโโโโโโโโโโโโโโโโโชโโโโโโโโโโชโโโโโโโโโโโโโโโโโชโโโโโโโโโโโโโโโโโโโโโโโโโโโโโชโโโโโโโโโโโโโโโโโโโโโโโโโโโโโชโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโก
โ The Working Classes Combat โ twccormcompatredux โ 1.0.0 โ 1.0.1 โ [combatoverhaul@0.1.25] โ [combatoverhaul@0.1.25] โ The mod makes the 3 mods mentioned compatable. It โ
โ Overhaul Rustbound Magic โ โ โ โ [rustboundmagic@2.1.48] โ [rustboundmagic@2.1.48] โ is only needed if you intend to use all three. โ
โ Compatability โ โ โ โ [theworkingclasses@1.0.3] โ [theworkingclasses@1.0.3] โ โ
โฐโโโโโโโโโโโโโโโโโโโโโโโโโโโโโดโโโโโโโโโโโโโโโโโโโโโดโโโโโโโโโโดโโโโโโโโโโโโโโโโโดโโโโโโโโโโโโโโโโโโโโโโโโโโโโโดโโโโโโโโโโโโโโโโโโโโโโโโโโโโโดโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏSo we installed this mod and didn't grab its dependencies, as you can see it has a few of them. Luckily Rustique can install specifically missing dependencies to ease the pain! There are actually a lot of mods where the author doesn't explicitly mention what dependencies they have and is one reason Rustique was created in the first place.
$ Rustique install -mโญโโโโโโโโโโโโโโโโโโโโโโโโโฌโโโโโโโโฎ
โ Successfully Installed โ โ
โโโโโโโโโโโโโโโโโโโโโโโโโโชโโโโโโโโก
โ Combat Overhaul โ 0.3.9 โ
โ Expanded Matter โ 3.2.2 โ
โ Overhaul lib โ 0.2.8 โ
โ Rustbound Magic โ 2.5.6 โ
โ The Working Classes โ 1.0.4 โ
โ Trait Acquirer โ 0.9.6 โ
โฐโโโโโโโโโโโโโโโโโโโโโโโโโดโโโโโโโโฏ
โญโโโโโโโโโโโโโโโโโโโโโโโโโโโฎ
โ Total mods Installed 6 โ
โฐโโโโโโโโโโโโโโโโโโโโโโโโโโโฏ
โญโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฎ
Syncing... /home/..../.config/VintagestoryData/Mods
โฐโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏ
โญโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฎ
Sync operation completed: 1.85s
โฐโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏ
โญโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฎ
Install operation completed: 5.47s
โฐโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏWow! There are even more mods here than we thought! Thats because some of the dependencies of twccormcompatredux also have dependencies of their own, instead of just the 3 we saw with list, 6 were installed.
All without having to track down all the dependencies on your own! Pretty nice, right?
Usage: Rustique delete [OPTIONS]
Delete does what it says, deletes mods. You MUST provide [-m, --mod-id] OR [-a, --all].
There is not much nuance to this command, you use it to delete things.
CAUTION: There is NO confirmation with delete. Be sure what you are deleting is what you want to delete. Of course, you can easily reinstall if you need.
-
-m, --mod-id ...- Specify the mod(s) you would like to delete. You use a list here. Example:
Rustique delete -m alchemy armory - You can specify a specific version with the following:
-m modid@version, EXAMPLE:-m alchemy@1.6.49 -
REQUIRED: This field is required, unless you use
-a, --all.
- Specify the mod(s) you would like to delete. You use a list here. Example:
-
-b, --mod-backups- Used with
-m, --mod-idto delete the backups of the mod specified - Mod backups only happen if you have them enabled in the config. See Config
- Used with
-
-a, --all <TYPE>- Specifying -a will allow you to delete ALL of the particular type.
- If TYPE is
mods, then ALL mods in your mod dir will be deleted, EXCEPT for any modpack mods. - If TYPE is
backups, then ALL mods that have been backup will be deleted. - If TYPE is
both, then ALL mods AND backups will be deleted, EXCEPT for modpack mods. The backups for modpack mods are in the same location as any other backup, so those would be removed. - Valid TYPE:
[mods, backups, both]
Delete is pretty straight forward. Call delete with -m modid and it will remove.
For this example we have the following mods installed.
โญโโโโโโโโโโโโโโโโโโโโโโโโโโโฌโโโโโโโโโโโโโโโโโฌโโโโโโโโโโฎ
โ Name โ ModID โ Version โ
โโโโโโโโโโโโโโโโโโโโโโโโโโโโชโโโโโโโโโโโโโโโโโชโโโโโโโโโโก
โ Alchemy โ alchemy โ 1.6.49 โ
โโโโโโโโโโโโโโโโโโโโโโโโโโโโผโโโโโโโโโโโโโโโโโผโโโโโโโโโโค
โ Alchemy โ alchemy โ 1.6.50 โ
โโโโโโโโโโโโโโโโโโโโโโโโโโโโผโโโโโโโโโโโโโโโโโผโโโโโโโโโโค
โ Combat Overhaul โ combatoverhaul โ 0.3.9 โ
โโโโโโโโโโโโโโโโโโโโโโโโโโโโผโโโโโโโโโโโโโโโโโผโโโโโโโโโโค
โ Combat Overhaul : Armory โ armory โ 0.2.4 โ
โโโโโโโโโโโโโโโโโโโโโโโโโโโโผโโโโโโโโโโโโโโโโโผโโโโโโโโโโค
โ Overhaul Library โ overhaullib โ 0.2.8 โ
โฐโโโโโโโโโโโโโโโโโโโโโโโโโโโดโโโโโโโโโโโโโโโโโดโโโโโโโโโโฏIn our above example, we ended up with 2 alchemy mods installed and we only want the latest version. Lets remove ONLY Alchemy 1.6.49. You can pass the version with the modid like modid@version to remove a specific version.
$ Rustique delete -m alchemy@1.6.49โญโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฎ
โ Successfully deleted: [alchemy@1.6.49:alchemy_1.6.49.zip] โ
โฐโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏPretty simple.
Lets remove all the mods now, lets say we are prepping to use a modpack, which is easy enough.
$ Rustique delete -a modsโญโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฎ
โ Successfully deleted: [["/home/..../.config/VintagestoryData/Mods/alchemy_1.6.50.zip", โ
โ "/home/..../.config/VintagestoryData/Mods/armory_0.2.4.zip", โ
โ "/home/..../.config/VintagestoryData/Mods/combatoverhaul_0.3.9.zip", โ
โ "/home/..../.config/VintagestoryData/Mods/overhaullib_0.2.8.zip", โ
โ "/home/..../.config/VintagestoryData/Mods/rustique-sync.json", โ
โ "/home/..../.config/VintagestoryData/Mods/alchemy_1.6.49.zip"]] โ
โฐโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏThe output will always show you which file it deletes. Notice that here it deletes the rustique-sync.json file as well.
This is because without any mods, there is no need to have a synce file thats outdated.
A new sync file will be built the next time you install a new mod.
If you see the following message when you try to delete something, then you need to run sync first.
Delete requires the information sync provides to ensure it deletes the correct file.
2025-06-05T19:13:16.890636Z WARN main ThreadId(01) "alchemy"@Some("1.6.49") not found
โญโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฎ
โ Successfully deleted: [] โ
โฐโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏ