Add an entirely new Mod:
Prerequisites:
- You need to have a GitHub account first.
- It is recommended to download GitHub Desktop for easier file and branch management.
Step by step:
- If you want to add a new mod to our project, firstly check the mod list in our GitHub and on our Faithful Website by typing the name of the mod or its assets folder name.
ℹ️ Info
See here if the mod repository already exists.
- If the mod does not have any repository, then create a repository in your own profile (if you have access to the Faithful Mods organisation, then create it there). The repository needs to have the same name as the
assets
folder file (ex:Actually Additions
mod repository would be named:actuallyadditions
).
- Keep the
main
branch empty (you can add areadme.md
/license.md
stuff but no textures on that branch) and make a new branch for each supported Minecraft version.
⚠️ Warning
- The
main
branch needs to be set as the default branch! Do not merge other branches into the main branch!- Only texture files should be inside minecraft branches,
readme.md
&license.md
files shouldn’t be there!
ℹ️ Info
- If you made your repository before the 1st October 2020, rename your
master
branch tomain
- If you want to license your work, please consider a license that follow the Faithful License
Upload your textures to each branch (see how here).
Your repository now should look like this:
ℹ️ Info
- You need to create an
assets
folder and place your textures inside!- The
pack.png
andpack.mcmeta
are not needed anymore, because that process is now automated.
- Final step: ask Juknum#0001 on the Faithful Discord to add the mods to the website