Tutorials/Creating a resource pack

Preface
Resource packs allow users to include files that can modify or add custom textures, models, animations, music, sounds, user interfaces, and languages that change the way some things in Minecraft behave or look.

What NOT to do
There are some things that you should NOT do when creating a resource pack, which includes but is not limited to:


 * Anything that violates the Minecraft EULA.
 * Release files that allow users to play a release of Minecraft without having purchased it from Mojang.
 * Release the decompiled source code of Minecraft in any way.
 * Sell the resource pack in any way.

In any case, you should always follow the Terms and Conditions on the Mojang Studios website.

It is also suggested that you never extract game files to your desktop, as it can result in technical issues.

Making a Resource Pack
Minecraft has a unique mechanic that allows for text and media files to be added to the game files that allow for everything from custom block textures and models to custom credits and sound events. This tutorial is meant to help with setting up the file systems in order to implement them. Since the files are essentially code, there are technical rules for how to format files and certain things may change from version to version. As such, what is written in this tutorial may not apply to every situation, but in the case where the difference is significant and specific, it will provide a framework on the changes needed for different versions.

This tutorial is geared toward the latest release of Minecraft, which is currently 1.16.5.

Tools
Creating custom files for Minecraft, whether in the forms of resource/data packs or mods, is somewhat technical and can be difficult. There are many rules that must be followed in order for add-ons to work correctly, most notably how the files are formatted. There are many tools that can help mitigate these issues, some of which are listed here.

File Archiver
To access the base assets of Minecraft to edit textures, models, or sounds, a file archiver is needed. Here are some popular suggestions:


 * 7-Zip or WinRAR for Windows users
 * The Unarchiver for MacOS users.

IDE
Text-based files in resource packs are written in JSON, which can be tricky to use and format correctly. Many IDEs (Integrated Development Environment) assist with formatting these files and making sure proper syntax is used, as well as help organizing files in a project. Here are some suggestions:


 * Atom – Suggested for those new to IDEs. Very easy to set up a project folder and stay organized.
 * Visual Studio Code – More complex IDE better suited for those who have experience with working in IDEs.

Audio Editor
In order to add sound files, you must put it in the proper format (.ogg). While this can be done using one of numerous sites online, an audio editor program is suggested to allow customizing or trimming of audio files. Audacity is one of the most popular audio editors.

Image Editor/3D Modeling Tool
To add textures or custom models, it is suggested to use a modeling program that allows for a visual-based editing system. Like with audio conversion websites, there are online tools, though a common recommended program is Blockbench. Most image editors will suffice to modify textures, but it is recommended to use an editor that supports transparency (e.g. paint.net and https://pixlr.com/) so that you may add transparent pixels to textures.

Creating a resource pack
All the resources and instructions in a pack reside in the pack folder, which lives in the "resourcepacks" directory. You may wish to use an IDE to help keep track of the files within your resource pack if there are multiple.

In versions 1.11 and higher, all file names within a resource pack should use lowercase letters only.

Creating the Folder
The first thing we need to do is create the folder that will contain all the resource pack files. Create a folder on your desktop or another easily accessible location and name it. This will be the name displayed in the resource pack menu.

Creating a .MCMETA file
Within your resource pack folder, we need to create a file. This lets Minecraft know that the folder is a resource pack and contains useful information such as:


 * The recommended version for using the resource pack.
 * The description displayed under the pack title in the selection menu.
 * Preliminary information on any custom languages added in the resource pack.

To create this file, we need to create a text file within the folder and name it . Make sure the file extension is  and not  or the pack may not be detected. If you are not using an IDE, you may get a warning that changing a file name extension could make the file unusable or switch the program required to open it. You can still open this file in a text editor by right-clicking the file and selecting the "Open With" option. Note: You may need to select a program using your file browser.

Formatting pack.mcmeta
Open in a text editor or IDE of your choice and type or copy+paste the following:

The value of  tells Minecraft what release the resource pack is designed for, and is different for certain versions. The following list what versions each value is associated with:


 * for versions 1.6.1 – 1.8.9
 * for versions 1.9 – 1.10.2
 * for versions 1.11 – 1.12.2
 * for versions 1.13 – 1.14.4
 * for versions 1.15 – 1.16.1
 * for versions 1.16.2 – 1.16.5
 * for versions 1.17+

Note: As more updates are released, values may be changed or added.

The text following  is displayed under the pack title in the selection menu, and must be put inside quotes. If you wish to use special characters, you can enter the Unicode code for the character in the format, where   is the hexadecimal code for the character. Say you want to use the letter Þ (Thorn), which has code. Inside the description you would type. Make sure that you are using the correct slash, or it may not work. A list of Unicode codes can be found here (only the characters 0000-FFFF (BMP) are supported).

Correct Syntax
Be very careful not to forget quotation marks, colons  , braces  , or square brackets. Missing one of these can lead to your resource pack not being detected by Minecraft. Make sure that your  file matches the one shown above.

Testing your Pack
At this point, you can test if the pack is formatted correctly by putting it in the game! You may access your pack folder by selecting "Options", then "Resource Packs", then "Open Pack Folder", or you can navigate to it from your file browser:


 * For Windows, go to %appdata% → .minecraft → resourcepacks
 * For MacOS, go to Library → Application Support → minecraft → resourcepacks

Once you have the folder open, you can drag your custom pack folder and drop it in.

If you have formatted the files correctly, you should see your resource pack appear in the menu.

Troubleshooting
If you don't see your pack in the list, make sure your file is correct and saved in the folder. Look for any missing braces {}, commas ,, colons :, quotation marks "", or square brackets []. Remember that for each open brace, quotation, or square bracket, you must have a closing bracket, quotation, or square bracket.

Pack icon
If an icon is not specified, a cobblestone icon will show up next to the pack. If you want to use your own pack icon, you can place it inside your resource pack folder with the name. The file must be a PNG, and works with any square resolution, but a 128x128 pixel image renders the best.

Structuring the assets folder
Now that you have your resource pack set up, you can start adding content to it. Most files you add will be in a subfolder called. Simply create a new folder inside your resource pack folder named. This,, and   should be the only files located directly in your parent resource pack folder. Any other resource files must be located somewhere in  or they won't be read by Minecraft.

Adding a namespace folder
Inside your assets folder is your namespace folders. These help separate the files in your resource pack so that there is no confusion between which files are located where. If you plan on modifying or replacing vanilla resources, those files would go into the  namespace folder. Custom additions should go in your own namespace folder, which for this tutorial will be named. In the future, you should use a significant or unique namespace so that there isn't a possibility of other resource packs confusing which files belong where when multiple packs are loaded.

Accessing the vanilla resources
If you plan on editing multiple resources, or to help ease of access, you may want to save a copy of the vanilla resources in an accessible location in case some things rely on other files within the directory. To do this, you need to navigate to the vanilla resources file by opening the  folder inside the   directory. You should see a list of numbered folders, which correspond to versions that you've loaded or used in the past. Open the folder corresponding to the version you want for your resource pack (in this tutorial it would be 1.16.5) and extract the JAR file located inside, which can be done by right clicking the file and selecting a file archiver from the "Open With" option. You may want to save this in an accessible location for future reference, as certain tasks such as modifying block models require textures in addition to the model files.

Modifying an Entity's texture
This section goes through the process of modifying a texture, using the creeper texture as an example.

Finding the vanilla texture
First, you will need the vanilla resource to get the texture you want to edit. This will be located in the extracted version folder that was created in the previous section. In the extracted folder, navigate to → → → →  where you will find. Save a duplicate of this file somewhere accessible or keep the folder window open during the next few steps.



Next you'll need to replicate the folder structure of the vanilla pack within your resource pack, which lets Minecraft know to use the texture. Since we are modifying a default texture, this will be in the  subfolder of our   folder. Within the  folder of your resource pack, do the following:


 * 1) Inside, create a folder called.
 * 2) Inside, create a folder called.
 * 3) Inside, create a folder called.
 * 4) Copy the creeper texture from the vanilla resource pack into your newly created  folder.

Now that you have the normal creeper texture placed in your resource pack, open it up in the image editor of your choice. It should look something like the image shown.

Since texture files are very small, you may need to zoom in.


 * A quick note on textures

If you've never seen a texture before, the above image might surprise you. Most textures look this way and are "wrapped" around a model, like wrapping paper around a present. Now it's time to be creative! Edit the texture however you want. For simplicity, this example adds a headband. Note where the changes are and compare it to the color-coded texture above.

Once you are happy with your texture, save the file as. It is important that it is saved with the same name as the default asset or otherwise it will not detect and load your texture.

Now you can load up Minecraft and spawn a creeper with your custom texture! If it doesn't show up, make sure that you've selected your resource pack. If it still doesn't work, make sure you've named the file properly and placed it in the correct folder.

Pack Hierarchy
If you are playing with multiple resource packs loaded, there may be some textures that are in your pack that aren't being shown. This is because of the way resource packs are loaded in Minecraft. All selected resource pack files are loaded from the bottom up as they are shown in the selection menu, so if there is a resource pack that is loaded above yours, it may replace files that you've changed. This can cause various issues with using multiple themed resource packs that have differing textures.

Modeling Blocks/Items
Sometimes you may want to change one of the Minecraft models. To do so you will need a file archiver to get the default model and texture along with a 3D modeling tool to edit the model. Blockbench works well in this case since it can export directly to the  format needed for models.

Replacing a Block
Because the default ladder in Minecraft isn't 3D, you can replace it with your own model. First, get all the ladder's files into this resource pack:


 * 1) Open the Minecraft JAR file using a ZIP viewer of your choice.


 * Navigate into the folder, then extract  to
 * Navigate into the folder, then extract  to
 * Navigate into the folder, then extract  to
 * Lastly, navigate into the folder, then extract  to.

Now you can either edit the using your preferred image editor, or you can edit it in your preferred modeling editor.

Note: The ladder.json files are unnecessary. If you don't have that much time you can skip them and only use the ladder.png file. This applies for all textures or things you will edit while creating your texture/resource pack.

Modeling the Ladder - Blockbench
In modeling the ladder, we will use Blockbench. Once you have opened the program, press to open the model selection menu. After the open dialog has appeared, go to the location where you saved  and select.

You then should be facing a ladder that is on the south side of the box.


 * On the menu bar, go to "Edit -> Add Cube" to create a new block.
 * Resize the model to a full-sized cube. Then, under Textures on the left panel right click, then click Apply to Untextured Faces.
 * In the top left, there will be an image of the ladder, with a 1×1 highlighted region. Move this to change the texture to what you want it to be. Repeat until all sides of the block are as wanted.
 * Go to "File -> Save Model" and save in (Replace "block" with "blocks" for 1.12 and below).

Now we have created a new model for the ladder block in Blockbench.

Modeling the Ladder - Paint.net
Go to getpaint.net and get paint.net or go to ninite.com, select paintNET and run it after it downloads to install paint.net for free.


 * Open paint.net
 * Do Ctrl+O and go to .minecraft/textures/block/ladder.png and double click.
 * Edit the Ladder however you want.
 * When your done, press the X button in the top right of the window. It will open a dialog if you changed anything and ask do you want to save your work. Press Save then okay twice. You don't need to change anything in the menus.

Finishing off
When you have completed the 3D model of the ladder and saved it, launch Minecraft, and test it out. Place a ladder on a wall, and you should see its replaced model.

Changing existing sounds or music
Just like modifying the default textures or models, you can substitute custom sounds in place of the default ones. In this example, you will learn how to change the boss music in the ender dragon fight.

Finding a sound's path
Similar to the custom texture and models, you'll first need to know the path of the sound you want to change.


 * 1) Inside your .minecraft folder, navigate to, which will have a list of numbered  files.
 * 2) Find the file corresponding to your Minecraft version (e.g. ), and open it with a text editor or IDE.
 * 3) In this file you can find all the sounds found in Minecraft. Press to search for your sound.
 * 4) * For a list of filenames for music, you can check Music
 * 5) Your sound path will look something like this:

Modifying the sound

 * 1) Inside your resource pack folder, navigate to.
 * 2) Create a new folder named.
 * 3) Now inside your folder, you need to create new folders depending on your sound's path. For example, if your path is, you need to create the folders.
 * 4) In the last folder (in this example, it's ) you can put in your new sound file. Make sure you named the file to the file that you're replacing, or in this example,.
 * 5) *Note that this file must be a file. To convert your sound file to a  file, you can use the free website Online-Convert.com

Testing your sound
If everything went according to plan, you have now replaced a sound in Minecraft. To test it:


 * 1) Make sure you have enabled your resource pack.
 * 2) *If you already had Minecraft open with your resource pack enabled, you can press to reload all resource packs.
 * 3) Use the command to play your sound. In our example, type:

Adding new sounds or music
In addition to modifying default sounds, you can add your own! In this example, a new player hurt sound can be added without replacing any of the current player hurt sounds.

Finding the sound path
In order to add a sound, you'll need to know where it should actually go by determining its path. Unlike replacing sounds, you will go straight to your resource pack folder and search in there.


 * 1) Find and open your version's  index file (e.g  ) from.
 * 2) Press  to search for your sound path.
 * 3) *In this case, the location for the player hurt sounds will look like this:.

Adding the folders and sound in your resource pack

 * 1) Going to your resource pack folder, navigate to.
 * 2) Inside the  folder, create a folder named.
 * 3) *If you already have a  folder from replacing a default sound, open that folder.
 * 4) Within the  folder, create a folder that matches the directory of the sound you want to add. In this case, we are going to create a file called.
 * 5) Add your sound here.
 * 6) *The sound must be a file. Like in the previous section, you may use the free website Online-Convert.com or use Audacity as mentioned at the top of the page.
 * 7) *Also note the already existing files seen in your file from above. In this case, five other hurt sounds exist within the  folder, two for falling at different heights ( and ) and the other three are when the player actually gets hurt (,, and ) Since we want to add a fourth sound to the existing three hurt sounds, we cannot reuse those file names. For simplicity, name your sound.

Creating the sounds.json file
Because we are adding a sound, we must define the sound event it will be used in.


 * 1) Go back to in your resource pack folder.
 * 2) Create a text file named . Do make sure that the file format is indeed .json and nothing else.
 * 3) At your choice, paste the following template into :


 * 1) * The above code only applies to this example. Replace/rename anything necessary to allow it to apply to your chosen sound.
 * 2) *You can find out the id used by Minecraft for each sound folder. By using in-game, you can determine this id. In this case, using  will confirm that the player's hurt sound is indeed classified as.
 * 3) *Make sure the name fields are in lowercase characters only. The names of your files should be in lowercase as well. Otherwise, the resource pack may fail to use your new sounds.
 * 4) Correct formatting is required! Any missing bracket, comma, etc. will result in the resource pack failing to work properly.

Testing your sound
If there is an error anywhere in your file, none of the sounds described in it will appear in-game. If this happens, you should check the spelling and file paths.

If everything went according to plan, you have now added a sound to Minecraft. To test it:


 * 1) Make sure you have enabled your resource pack.
 * 2) *If you already had Minecraft open with your resource pack enabled, you can press to reload all resource packs.
 * 3) Use the command once again to play your sound. In our example, type: . For this example, it will likely require multiple tries, as hurt sounds are chosen randomly.

Adding Languages
You can add new languages to Minecraft using a resource pack. Assume your language code is 'LANG' and country/region code is 'COUNTRY', will look like:


 * pack.mcmeta

If you want your language to be right-to-left, set to.

Then, put in  inside your resource pack. When you launch the game, choose your resource pack, open the Language selection screen, and your new language will be there.


 * Notes

The goes in the root folder of your resource pack, not in the  folder. Also note that the above is the same file as the  file that you have created a while ago. As of 1.7-pre, you can choose multiple resource packs at once. If you want to use your new language and resource pack for before 1.7, you need to combine them manually because multiple resource packs could not be selected before the version.

Animation Properties
An example of an animation file is this:


 * stone.png.mcmeta


 * Note

All you really need to make a texture animated is the following code. By default, it will make each frame last only one tick:


 * stone.png.mcmeta

Save the file as the same name as the texture you want to be animated with an in the same folder as your texture.

Texture Properties
An example of a texture property is this:


 * shadow.png.mcmeta

Fonts
Character sizes in fonts are determined by the last line of pixels that contains pixels that contain a non-zero alpha. This allows additional padding to be added around characters by adding a color with an alpha level of 1, which Minecraft will consider as part of the character.

Testing your Resource Pack

 * Launch the game
 * Click on Options
 * Click on Resource Packs
 * Find "Tutorial_Resource_Pack" in the list on the left and click the arrow next to it
 * Click Done

If you decide you want to make some changes to your resource pack, just close the game, edit your resource pack, relaunch the game, and follow the steps above to test your resource pack again. Alternatively, saving the texture to the resource pack and pressing will reload the pack without the need to close the game.

Packaging Resource Packs with Worlds
For use in singleplayer worlds, you can package your resource pack as a ZIP file named inside the world directory. This will then be automatically used when playing the singleplayer world.

Server Resource Packs
If you are the owner of a server, you may set it as the resource pack of your server.


 * 1) Make sure your pack format is a .zip-folder.
 * 2) Upload the pack on a file hosting website, e.g. Dropbox.
 * 3) Copy the download link of your pack. IMPORTANT: It has to be a direct download link. For example, in Dropbox the URL will end with "dl=0", so if you're using Dropbox, all you have to do is to change it to "dl=1".
 * 4) Open the server.properties with a text editor.
 * 5) Search for the line "resource-pack=".
 * 6) Paste the download link after the equal sign.
 * 7) Save your changes to the server-properties and restart your server.
 * 8) Enjoy!

Servers can have an icon that will show up in the Multiplayer list.


 * 1) Create a PNG image with a size of 64 by 64 pixels, transparency is supported.
 * 2) Save (or rename) it to.
 * 3) Move it to the server's directory.
 * 4) Restart the server.
 * 5) Server icons will display next to the server name.