doc/texture_packs.txt

   1 Minetest Texture Pack Reference
   2 ===============================
   3
   4 Texture packs allow you to replace textures provided by a mod with your own
   5 textures.
   6
   7 Texture pack directory structure
   8 --------------------------------
   9
  10     textures
  11     |-- Texture Pack
  12     |   |-- screenshot.png
  13     |   |-- description.txt
  14     |   |-- override.txt
  15     |   |-- your_texture_1.png
  16     |   |-- your_texture_2.png
  17     `-- Another Texture Pack
  18
  19 ### Texture Pack
  20 This is a directory containing the entire contents of a single texture pack.
  21 It can be chosen more or less freely and will also become the name of the
  22 texture pack. The name must not be “base”.
  23
  24 ### `description.txt`
  25 A file containing a short description of the texture pack to be shown in the
  26 texture packs tab.
  27
  28 ### `screenshot.png`
  29 A preview image showing an in-game screenshot of this texture pack; it will be
  30 shown in the texture packs tab. It should have an aspect ratio of 3:2 and a
  31 minimum size of 300×200 pixels.
  32
  33 ### `your_texture_1.png`, `your_texture_2.png`, etc.
  34 Any other PNG files will be interpreted as textures. They must have the same
  35 names as the textures they are supposed to override. For example, to override
  36 the apple texture of Minetest Game, add a PNG file named `default_apple.png`.
  37
  38 The custom textures do not necceessarily require the same size as their
  39 originals, but this might be required for a few particular textures. When
  40 unsure, just test your texture pack in-game.
  41
  42 Texture modifiers
  43 -----------------
  44
  45 See lua_api.txt for texture modifiers
  46
  47 Special textures
  48 ----------------
  49
  50 These texture names are hardcoded into the engine but can also be overwritten
  51 by texture packs. All existing fallback textures can be found in the directory
  52 `textures/base/pack`.
  53
  54 ### Gameplay textures
  55
  56 * `bubble.png`: the bubble texture when the player is drowning
  57
  58 * `crack_anylength.png`: node overlay texture when digging
  59
  60 * `crosshair.png`
  61     * the crosshair texture in the center of the screen. The settings
  62       `crosshair_color` and `crosshair_alpha` are used to create a cross
  63       when no texture was found
  64
  65 * `halo.png`: used for the node highlighting mesh
  66
  67 * `heart.png`: used to display the health points of the player
  68
  69 * `minimap_mask_round.png`: round minimap mask, white gets replaced by the map
  70 * `minimap_mask_square.png`: mask used for the square minimap
  71 * `minimap_overlay_round.png`: overlay texture for the round minimap
  72 * `minimap_overlay_square.png`: overlay texture for the square minimap
  73 * `object_marker_red.png`: texture for players on the minimap
  74 * `player_marker.png`: texture for the own player on the square minimap
  75
  76 * `player.png`: front texture of the 2D upright sprite player
  77 * `player_back.png`: back texture of the 2D upright sprite player
  78
  79 * `progress_bar.png`: foreground texture of the loading screen's progress bar
  80 * `progress_bar_bg.png`: background texture of the loading screen's progress bar
  81
  82 * `moon.png`: texture of the moon. Default texture is generated by Minetest
  83 * `moon_tonemap.png`: tonemap to be used when `moon.png` was found
  84 * `sun.png`: texture of the sun. Default texture is generated by Minetest
  85 * `sun_tonemap.png`: tonemap to be used when `sun.png` was found
  86 * `sunrisebg.png`: shown sky texture when the sun rises
  87
  88 * `smoke_puff.png`: texture used when an object died by punching
  89
  90 * `unknown_item.png`: shown texture when an item definition was not found
  91 * `unknown_node.png`: shown texture when a node definition was not found
  92 * `unknown_object.png`: shown texture when an entity definition was not found
  93
  94 * `wieldhand.png`: texture of the wieldhand
  95
  96 ### Mainmenu textures
  97
  98 * `menu_bg.png`: used as mainmenu background when the clouds are disabled
  99 * `menu_header.png`: header texture when no texture pack is selected
 100
 101 * `no_screenshot.png`
 102     * texture when no screenshot was found for a texture pack or mod
 103
 104 * `server_flags_creative.png`: icon for creative servers
 105 * `server_flags_damage.png`: icon for enabled damage on servers
 106 * `server_flags_favorite.png`: icon for your favorite servers
 107 * `server_flags_pvp.png`: icon for enabled PvP on servers
 108
 109 ### Android textures
 110
 111 * `down_arrow.png`
 112 * `left_arrow.png`
 113 * `right_arrow.png`
 114 * `up_arrow.png`
 115
 116 * `drop_btn.png`
 117 * `fast_btn.png`
 118 * `fly_btn.png`
 119 * `jump_btn.png`
 120 * `noclip_btn.png`
 121
 122 * `camera_btn.png`
 123 * `chat_btn.png`
 124 * `inventory_btn.png`
 125 * `rangeview_btn.png`
 126
 127 * `debug_btn.png`
 128 * `gear_icon.png`
 129 * `rare_controls.png`
 130
 131 Texture Overrides
 132 -----------------
 133
 134 You can override the textures of a node from a texture pack using
 135 texture overrides. To do this, create a file in a texture pack
 136 called override.txt
 137
 138 Each line in an override.txt file is a rule. It consists of
 139
 140         nodename face-selector texture
 141
 142 For example,
 143
 144         default:dirt_with_grass sides default_stone.png
 145
 146 You can use ^ operators as usual:
 147
 148         default:dirt_with_grass sides default_stone.png^[brighten
 149
 150 Here are face selectors you can choose from:
 151
 152 | face-selector | behavior                                          |
 153 |---------------|---------------------------------------------------|
 154 | left          | x-                                                |
 155 | right         | x+                                                |
 156 | front         | z-                                                |
 157 | back          | z+                                                |
 158 | top           | y+                                                |
 159 | bottom        | y-                                                |
 160 | sides         | x-, x+, z-, z+                                    |
 161 | all           | All faces. You can also use '*' instead of 'all'. |