Getting Started

So, you've obtained an Item Customization Smithing Template from some Trail Ruins and you want to know how to get started adding custom assets to use with it? You've come to the right place!

This tutorial covers how to contribute to the Community Resource Pack. For help using the Item Customization Smithing Template, see Item Customization (In-Game) Tutorial.

This tutorial assumes you are a beginner to Git and version control. Feel free to use the git CLI instead of the GUI option included in this tutorial, if you know how to do so.

Setting up your environment

1. Install GitHub Desktop - this will be used for managing any files you will be uploading or changing.
2. Create a GitHub account and log in if you have not already done so.
3. Fork this repository.
4. Click Code -> Open with GitHub Desktop

5. A window should pop up that lets you clone your fork on your machine:

Submitting files

Read the Submission Guidelines first if you have not already!

Before you add your files to your fork, you must create a new branch.

1. Open GitHub Desktop and navigate to your fork ("Current repository" dropdown in the top left)
2. Click the "Current branch" dropdown and click "New branch"

3. Name your branch something descriptive, like kindabland/hanging-lights

4. Add or create the files you are submitting (see Item Customization File Specification for examples). Ensure that your files are under your username's namespace.

5. Commit your files using a descriptive commit message (bottom left) \

6. Publish your branch & push your files (top right)
7. Navigate to your fork on the GitHub website
8. Click "Compare & pull request" \

9. Fill out the submission checklist (place an x between the square brackets for each item after reading and confirming they are true)

10. Click "Create pull request"
11. Await feedback on your Pull Request from a Community Resource Pack Coordinator (igalaxy or kindabland)