Setup for Solder

setup.md

Getting set up for modpack development with Solder

Install python3, pip3, git, and git-lfs

Find and follow instructions for your particular distro.

Get setup on GitLab

1. Log in with a Github account here: https://gitlab.tetrarch.co
2. Add your SSH public key here: https://gitlab.tetrarch.co/profile/keys
3. Have me add you to the tetrarch/mod-repo project

Install SolderingIron

git clone ssh://[email protected]:20000/skwerlman/solderingiron.git
cd solderingiron
git checkout dev
pip3 install -R requirements.txt
cd ..

Grab the mod repo

# This bit will take a long time!
git clone ssh://[email protected]:20000/tetrarch/mod-repo.git
cd mod-repo
git checkout dev
mkdir archive
mkdir unpacked

Using SolderingIron to pack mods

1. Download any mods you want to add to the repo.
2. Move them into mod-repo/unpacked/
3. From the mod-repo folder, run python3 ../solderingiron/src/solderingiron.py pack unpacked
4. That's it! The mods are packed. SolderingIron can pack multiple mods at once, and will tell you if something is wrong.

Getting packed mods into the repo

git add .
git status # Make sure everything looks correct! This is your last chance to fix mistakes!
git commit -m 'mods for the mod god' # or whatever
git push

Once that's done, create a merge request at https://gitlab.tetrarch.co/tetrarch/mod-repo/merge_requests I'll double check it for issues, and merge it into the master branch. The live repo pulls from master every 5 min.

Getting setup on Solder

1. Send me your email address. I'll create an account for you on Solder.
2. Once you have your account credentials, go to https://solder.tetrarch.co and log in.

Adding mod versions to Solder's database

1. Click on Mod Library and then Mod List.
2. For each mod you'd like to add: 1. Search for that mod in the search bar.
   • If the mod exists, continue.
   • If you can't find the mod, see Adding mods to Solder's database below. 2. Click on that mod's name. 3. Fill out the Version field. 4. Click Add Version.

Adding mods to Solder's database

1. Click on Mod Library and then Add a Mod.
2. Fill out the fields. * Mod Slug must be entered exactly as it appears in the repo. * Author Donation Link can be ignored, as it is not used. * Mod Website should point to the mod's official project page, not a rehoster. * Description should have a short summary of what the mod is and does.
3. Click Add Mod * You still need to add a mod versions before you can add this to a pack.