Submitting a Resource pack to the Hub using GitHub Desktop - melkypie/resource-packs GitHub Wiki
- Your pack must be around 25% original. If your pack doesn't satisfy the below conditions you are still free to share the pack (as a .zip) in #shared-packs on discord.
- ✅OK: Original colour scheme (not just another dark mode pack with some changed colour accents, but we will accept packs that are well-made recolours of the vanilla pack e.g. like Dark Vanilla or Pink Vanilla)
- ✅OK: Original skill icons
- ✅OK: Original tab stone icons
- ✅OK: Original Gameframe style (like Pixelscape)
- 🚫NOT OK: Just the chatbox or inventory background changed (i.e. your pack contains just a few unique files)
- 🚫NOT OK: Packs that are just mix of other packs that are already available (or you just edited someone else's work).
- If you have taken any assets from other packs, please make sure the pack creator is fine with you using them in your pack.
⚠️ Your pack should not contain any sprites that are not modified or any other files that are not required for the pack to work. Most new pack creators accidentally leave in Photoshop files or leave in whole unchanged folders from the sample-vanilla pack. We require you to remove these before submitting.- Have a github account and GitHub Desktop installed
⚠️ Please DO NOT neglect these first three steps. More often than not, new pack creators leave these details unchanged from the pack they yoinked and we have to manually change them. You can edit the pack.properties, overrides.toml and README.md in any text editor like Notepad or VS Code.
-
Fill out your
pack.properties
file and place it in the root folder (the folder which contains all your folders to sprites).pack.properties
-
displayName
- this is a human friendly name of your pack, that will be visible in the hub -
compatibleVersion
- version of plugin your pack is compatible with (e.g. 1.4.8) -
author
- name of the pack creator -
tags
- these will be used when people search for packs to display your pack (your pack's name is already a tag, so no need to add it here)
Example:
displayName=Flatscape compatibleVersion=1.4.7 author=melky tags=simple,modern,smooth
-
-
Make an
icon.png
file (dimensions are 224x147) in root folder. Please make the icon representative of what the pack would look like. -
Make a
README.md
file in root folder (this file uses Markdown format to display text, the file will be visible when people click the (?) on your pack). This file should contain more in-depth information about your pack and some larger sized screenshots of your pack.README.md
- If you don't know what to put in your README, copy and paste the following template into a text editor like Notepad or VS Code and fill it with your information and screenshots.
Template:
# Name of pack (by your name here) ![icon](paste link to icon.png here) Theme description goes here. ## Resizeable mode ![ResizeableMode](paste link to resizablemode.png screenshot here) ## Fixed mode ![FixedMode](paste link to fixedmode.png screenshot here) ## Credits List out the people and or packs you used to make your pack. You can delete this section if you can safely say your pack is completely original work or if your pack is a recolor of Jagex's UI.
⚠️ If you edited a pack that was already uploaded to the hub, double check if your pack satisfies the prerequisites and then delete the related github files that may have been included when you downloaded the source pack.
-
Fork the melkypie/resource-packs project, make sure you UNTICK "Copy the
master
branch only".How to fork the project
i. Click the fork button on the melkypie/resource-packs project page. -
In GitHub Desktop (make sure you're logged in), clone your fork locally. This will create a local path in your File Explorer (if you have never used GitHub Desktop, it will create a folder in Documents, but you can specify the path to any empty folder).
How to locally clone your fork
i. File -> Clone repository -> select your resource-packs repository -> Clone -
Make your new pack's branch, where the new branch name must be in the format of
pack-<your-packs-name>
and must be unique from all the other hub packs.- In the top left switch the "Current branch" to
pack-empty
. - Create a new branch (Branch -> New branch...) and then create the branch based on
pack-empty
and name the branch in the format ofpack-<your-packs-name>
(e.g.pack-dark-vanilla
)
- In the top left switch the "Current branch" to
-
Click the "Show in Explorer" button in the main window, to see the directory where you cloned your fork.
-
Copy all your pack's files (sprite folders and all the other stuff), and paste it to the directory where you cloned your fork.
-
Make a commit (bottom left, for your first commit you can just write "added
<your pack's name>
"). Double check to see if everything is selected for your first commit. -
Click "Publish branch" (or "Push origin") to upload the pack to your fork, and you will be prompted to create a pull request. Click "Create Pull Request" and your web browser will open a page comparing across forks.
-
Select the
head repository
as your own fork and thecompare
as your pack's branch in your fork -
Select the
base repository
asmelkypie/resource-packs
and thebase
aspack-empty
branch (We will create a new branch for you in the main repository after you submit your pull request and edit it in) -
Write in any desired comments. When done, click on the green
Create pull request
again. -
Now you wait until we review your pack.