Creating your own resource pack - melkypie/resource-packs GitHub Wiki

How to create your own Resource pack

  1. Download the sample-vanilla or any other resource pack you want to modify.
  2. Edit the images while keeping the image sizes, folder and file structure the same. Most pack creators use software like Photoshop or GIMP.

⚠️DO NOT PUT OR EDIT YOUR RESOURCE PACK INSIDE .runelite\resource-packs-repository OR IT WILL GET DELETED. The plugin overwrites what's in the folder whenever runelite, the plugin or even the packs themselves get updated.

  1. To apply it, follow the guide on Using a custom pack (not from the hub)

Frequently Asked Questions

I want to edit just my inventory background (or some other sprite), how do I go about doing it?

  1. Follow the guide above and then edit the resizeable_mode\side_panel_background.png and/or fixed_mode\side_panel_background.png (depending on what you use).

💡 The vanilla Resizeable mode inventory background uses a smaller sprite that the game tiles. So if you want your desired image to fill the inventory properly, resize your image accordingly.

  • Resize resizeable_mode\side_panel_background.png to 201x276 pixels.
  • For reference, fixed_mode\side_panel_background.png is 190x261 pixels.
  1. Delete any unedited sprites and unused folders. Just leave the folders containing the sprites you did change. For example, if you only changed the inventory backgrounds, your pack should only have two folders; resizeable_mode and fixed_mode. Deleting unedited folders & sprites ensures you will be using the newest vanilla UI elements provided by Jagex.

YT video demonstrating how to change the inventory backgrounds using GIMP. Turn on CC for text instructions.

Note: The resizable mode transparent background (Resizable - Modern layout) is not changeable as it uses dialog\background_brighter.png and that changes a lot of other UI elements. You can't change the opacity either, only the color and the used texture.

If you want to edit some other sprite and are unsure which folder said sprite is located, feel free to join the Resource packs discord's #creation channel and ask.

Is it possible to change the size or positioning of the sprite?

Changing the size may result in unwanted consequences as the sprite being stretched out/squished but some sprites adjust to it well, so it is a matter of experimenting with the specific sprite.

Changing the position within the transparent space of the image should be fine most of the time but changing size of the sprite and then positioning it differently will most likely cause what was mentioned above.

Can we use semi-transparent sprites?

No there is no way to use semi-transparent sprites as OSRS does not support them. You can only use fully opaque or fully transparent sprites (Both of them together is also fine). Everywhere where you see semi transparency it is just a color with opacity changed.

Can we delete any of the unused sprites/folders?

Yes you can freely delete any of the sprites or their folders. In fact it is best to do so in case Jagex changes said sprite to something different. Any sprites that will not be found in your resource pack will just use the vanilla sprite.

Can I change the chat text color and/or NPC dialog text color?

You can change the chat text color to be more visible with your pack. You can do this via the in-game settings (Settings > Chat > Chat Colour).

However, you cannot change NPC dialog text colors.

Why can this X sprite not be changed?

Most of the time it will be that said sprite was not seen anywhere in game and so it hasn't been made available for editing. If you find any such sprites, submit an issue for it to be added. To make our jobs easier, please include a screenshot of the missing sprite, and/or explain where the sprite is used (thanks in advance).

Although in some other cases there could be a way to abuse editing sprites which is the reason for any safezone/PVP sprites. If you are unsure if it falls within that category you can always ask me on discord.

Tips for making a custom pack from scratch

Using image editing software like GIMP (which is free) or Photoshop is highly recommended.

You basically open a sprite from the sample-vanilla pack and then draw your custom sprite work on top of it in a new layer. This ensures you keep your UI element within the correct dimensions so it would work with the plugin. A lot of the skill set involved in making a new pack is just recolouring and minute pixel work for smaller sprites like skill icons or the tab stone icons.

💡 Pro-tip: You can use batch processing to recolour a whole folder of sprites. This could potentially save you a whole bunch of time doing a recolour. Batch recolouring isn't perfect, so it is recommended to go in and make edits if you want to have certain UI elements to have extra clarity.

  1. Follow the tutorial to get BIMP installed and working on GIMP: Batch edit using BIMP plugin with GIMP
  2. Click on File > Batch Image Manipulation... > Add > Other GIMP procedure..., then search for "hue" to find the procedure to alter the HSV values of the sprites you want to change.

See Using a custom pack (not from the hub) on how to use your custom pack. This is useful in test fitting your work-in-progress pack.

Feel free to join the discord's #creation channel for feedback or to share your work-in-progress.

How do I submit my pack to the resource packs hub?

The best way to do that is to fork the plugin, make a branch containing your new pack and make a pull request. Check the wiki's guide on how to do that by using GitHub Desktop.

The easiest way is to come to the discord and upload your pack as a .zip in #creation. Please check the wiki's guide on how to ZIP your pack to make it easier to upload.

⚠️ We will not accept packs that are just mix of other packs that are already available on the Resource packs hub (e.g. just another dark mode with some changed colour accents). Old packs on the Resource packs hub that do fall into this category were grandfathered in due to their large installed bases. However, we welcome new packs that are good and sensible recolours of the vanilla UI. sgfost's Default Nord, Snow Monarch's Pink Vanilla or Nichy's Dark Vanilla are great examples of this.