README

Join us on Discord!

What is Solder?

Technic Solder is an API that sits between a modpack repository and the launcher. It allows you to easily manage multiple modpacks in one single location. It's the same API we use to distribute our modpacks!

Using Solder also means your packs will download each mod individually. This means the launcher can check MD5's against each version of a mod and if it hasn't changed, use the cached version of the mod instead. What does this mean? Small incremental updates to your modpack doesn't mean redownloading the whole thing every time!

Solder also interfaces with the Technic Platform using an API key you can generate through your account there. When Solder has this key it can directly interact with your Platform account. When creating new modpacks you will be able to import any packs you have registered in your Solder install. It will also create detailed mod lists on your Platform page! (assuming you have the respective data filled out in Solder). Neat huh?

Requirements

PHP 8.1 or higher
Composer 2.2 or higher
unzip package
BCMath PHP Extension
Ctype PHP Extension
Fileinfo PHP extension
JSON PHP Extension
Mbstring PHP Extension
OpenSSL PHP Extension
PDO PHP Extension
Tokenizer PHP Extension
XML PHP Extension
A MySQL or PostgreSQL database

You can find commands for this in the getting started page.

Installation/Updating Solder

Refer to our documentation here: https://docs.solder.io/

If there is any missing/incorrect info, please post an issue on our issue tracker

Using Docker

Docker can make managing your instance of Solder easier. To get started, you will need to install Docker and Docker Compose to your host system. You will also need to have this repo cloned. Here's an example for Ubuntu 22.04. Follow the instructions below from the cloned directory:

Build the Solder Docker image.

docker build --no-cache -t solder -f ./docker/Dockerfile .

Run the setup to prepare your instance. You might need to modify start.sh to disable setting a new app key if you already have one. Make sure not to run this more than once unless you want a new app key.

docker-compose -f compose-setup.yml up setup

Finally, you can turn on your instance of Solder.

docker-compose up -d --remove-orphans

(The --remove-orphans flag is necessary to remove the container used in the setup.)

Refer to the Docker docs for more information about how to use it.

Troubleshooting

If you are having issues and can't seem to figure out what's going on, join our development Discord server.

solder / solder

Maintainers

Details