Skip to content
This repository was archived by the owner on May 4, 2023. It is now read-only.

Commit 1be5942

Browse files
authored
Finish README for now
1 parent 44bf0a6 commit 1be5942

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,3 +128,22 @@ Once you have completed creating your pack, upload the folder containing it to t
128128
# Uploading a pack to the Pack Browser
129129
Uploading your pack requires some basic Git knowledge. If you have trouble understanding the instructions below, feel free to reach out to us or another developer familiar with Git for support.
130130
1. Create a fork of this repository. You can do this using the Fork button at the top-right corner.
131+
1. (Optional) Create and upload a square JPG preview image in `/images/{AUTHOR}`.
132+
1. Create and upload a JSON file in `/themes` titled `{AUTHOR}-{PACK_NAME}.json` that follows this template.
133+
```json
134+
{
135+
"repo_url": "https://github.com/AuthorGoesHere/RepoNameGoesHere",
136+
"repo_subpath": "FolderWherePackIsGoesHere",
137+
"repo_commit": "a1b2c3",
138+
"preview_image_path": "images/{AUTHOR}/{IMAGE_NAME}.jpg"
139+
}
140+
```
141+
4. (Optional) Test your pack submission by running `py main.py` in the repository folder.
142+
- Python and the Git CLI need to be installed.
143+
- If you are missing Python libraries, run `pip install -r requirements.txt`.
144+
- If the script throws no exceptions, you are ready to commit.
145+
1. Commit your changes and repeat for as many packs as you plan to upload.
146+
1. Create a pull request from your fork to the main repository.
147+
148+
# Support
149+
If you need any help creating or submitting a pack, please use [the Steam Deck Homebrew Discord server](https://discord.gg/ZU74G2NJzk). Please use the Audio Loader Support thread in the #support-plugins channel.

0 commit comments

Comments
 (0)