cf-updater

README

CurseForge Updater

A tool to update CurseForge mods, written in Go. Currently only tested with Minecraft.

Installation

Installing on Windows

To install it on Windows, download it from the Releases page and save it into your mods folder (e.g. for Minecraft it's .minecraft/mods or .minecraft/mods/<version>).

Installing with go get

First, install Go. Then run:

go get github.com/DimitrodAM/cf-updater

Setup

Backup your mods before doing anything else!

Unfortunately, some setup is first required. You must put URLs to all of your mods in a file called mods.txt. This can be tedious if you've got a lot of mods, but I don't see a way around it. If you have an idea, please submit an issue or a pull request!

Treat this file as the single source of mods, because the tool will delete any mods not in the mods file! Files with any other extension (e.g. .bak) do not count as mods and will not be deleted.

Example

Here's an example mods file (URLs must always start with https://):

version 1.12.2

https://www.curseforge.com/minecraft/mc-mods/jei
https://www.curseforge.com/minecraft/mc-mods/shadowfacts-forgelin
https://www.curseforge.com/minecraft/mc-mods/dimitrodam-test

You can also omit the URL and just include the mod's name:

version 1.12.2

jei
shadowfacts-forgelin
dimitrodam-test

version is the version of the game that the mods are for and is required. Lines starting with # are comments.

Mods not on CurseForge

Some mods aren't on CurseForge. They should be downloaded manually and specified with exclude:

exclude ^OptiFine.*\.jar$
exclude ^Computronics.*\.jar$

These support regexes for updating mods manually without having to edit the mods file (you only really need to remember .* and ^$), but because of that you should escape dots with a backslash (\.).

As stated above, mods that aren't specified or excluded will be deleted!

Usage

Now that the preparations are complete, simply run cf-updater in a terminal in the mods folder or double-click the executable. For more usage options, run cf-updater -h.

If you want to use an option every time without having to open a terminal on Windows, you should create a .cmd file. On Linux, you should create a shell script.

Why does it delete all mods not in the mods file?

That's because it's impossible to tell if you've got an older version of the mod that should be deleted or if that is just another mod. And because Forge doesn't allow multiple versions of the same mod at the same time, the old one must be deleted. So in the end, this is the only possible solution (again, suggestions are welcome!).