Submitting a Resource pack to the Hub by uploading a .zip to discord (not recommended) - melkypie/resource-packs GitHub Wiki

Submitting your pack to resource packs hub as a .zip

⚠️ Uploading your pack to discord as a .zip is not recommended. By making a pull request instead, you can control when you want to push updates to your pack. You would not have to wait for any one of the staff members to be online on discord. Pull requests for changes to packs are handled way quicker. See this guide on how to fork the plugin and make your initial commit/pull request properly.

Prerequisites

  • 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 #creations 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 (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.
  • Have PeaZip, 7Zip or WinRar installed

Steps

⚠️ 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, color.properties and README.md in any text editor like Notepad or VS Code.

  1. 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 (this was its intended use but we will accept the pack if you want to just use this as your own versioning system)
    • 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.4
    author=melky
    tags=simple,modern,smooth
  2. Make an icon.png file (dimensions are 224x147) in root folder.

  3. 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 needs to contain more in-depth information about your pack and some larger sized screenshots (one with resizable mode and one with fixed mode should be good enough).

    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.
    
  4. Delete files that aren't required to make the pack work. For example new pack creators often leave in unchanged vanilla sprites (from the sample vanilla pack) and random photoshop files.

⚠️ If you edited a pack that was already uploaded to github, 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.

  1. Rename your pack's folder in the form of pack-<your-packs-name> (e.g. pack-dark-vanilla). This helps us figure out what we should call the branch when we upload it to github.
  2. Add the folders and files in your pack's folder to a ZIP. Don't ZIP the pack's folder itself. It's vital you do this so we can handle your pack upload more easily. Otherwise it makes it harder to check with our script if the pack is good to go.

  3. Upload your .zip in #creations on discord and @nchy. When they are online, they'll review your pack.
⚠️ **GitHub.com Fallback** ⚠️