77
edits
Changes
Inital Import dokuwiki
A “model” is simply a shape. It can be a simple cube, it can be several cubes, it can be a truncated icosidodecahedron, or anything in between. Most models you’ll see will be in the vanilla JSON format. Models in other formats are loaded into an <code>IBakedModel</code> by an <code>IModelLoader</code> at runtime. Forge provides default implementations for WaveFront OBJ files and Blitz3D files. Most things do not care about what loaded the model or what format it’s in as they all "bake" into an <code>IBakedModel</code>.
When <code>ResourceLocation</code> refers to a model, the path is normally relative to <code>models</code> (e.g. <code><nowiki>examplemod:block/block</nowiki></code> → <code><nowiki>assets/examplemod/models/block/block</nowiki></code>).
Block and item models differ in a few ways, the major one being item property overrides.
== Textures ==
Textures, like models, are contained within resource packs and are referred to with <code>ResourceLocation</code>s. When <code>ResourceLocation</code>s refer to textures in models, the paths are taken to be relative to <code><nowiki>textures/</nowiki></code> (e.g. <code><nowiki>examplemod:blocks/test</nowiki></code> → <code><nowiki>assets/examplemod/textures/blocks/test.png</nowiki></code>). Additionally, in Minecraft, the [[https://en.wikipedia.org/wiki/UV_mapping UV coordinates]] (0,0) are taken to mean the ''<code>top-left</code>'' corner. UVs are <code>always</code> from 0 to 16. If a texture is larger or smaller, the coordinates are scaled to fit. A texture should also be square, and the side length of a texture should be a power of two, as doing otherwise breaks mipmapping. (E.g. 1x1, 2x2, 8x8, 16x16, and 128x128 are good. 5x5 and 30x30 are not recommended because they are not powers of 2. 5x10 and 4x8 are completely broken as they are not square.) If there is an <code>mcmeta</code> file associated with the texture, and an animation is defined, the image can be rectangular and is interpreted as a vertical sequence of square regions from top to bottom, where each square is a frame of the animation.
== JSON Models ==
Vanilla Minecraft’s JSON model format is rather simple. It defines cuboid (cube/rectangular prism) elements, and assigns textures to their faces. On the wiki, there is a definition of its format.
{{Colored box|title=Tip|content=JSON models only support cuboid elements; there is no way to express a triangular wedge or anything like it. To have more complicated models, another format must be used.}}
When a <code>ResourceLocation</code> refers to the location of a JSON model, it is not suffixed with <code><nowiki>.json</nowiki></code>, unlike OBJ and B3D models (e.g. <code><nowiki>minecraft:block/cube_all</nowiki></code>, not <code><nowiki>minecraft:block/cube_all.json</nowiki></code>).
When <code>ResourceLocation</code> refers to a model, the path is normally relative to <code>models</code> (e.g. <code><nowiki>examplemod:block/block</nowiki></code> → <code><nowiki>assets/examplemod/models/block/block</nowiki></code>).
Block and item models differ in a few ways, the major one being item property overrides.
== Textures ==
Textures, like models, are contained within resource packs and are referred to with <code>ResourceLocation</code>s. When <code>ResourceLocation</code>s refer to textures in models, the paths are taken to be relative to <code><nowiki>textures/</nowiki></code> (e.g. <code><nowiki>examplemod:blocks/test</nowiki></code> → <code><nowiki>assets/examplemod/textures/blocks/test.png</nowiki></code>). Additionally, in Minecraft, the [[https://en.wikipedia.org/wiki/UV_mapping UV coordinates]] (0,0) are taken to mean the ''<code>top-left</code>'' corner. UVs are <code>always</code> from 0 to 16. If a texture is larger or smaller, the coordinates are scaled to fit. A texture should also be square, and the side length of a texture should be a power of two, as doing otherwise breaks mipmapping. (E.g. 1x1, 2x2, 8x8, 16x16, and 128x128 are good. 5x5 and 30x30 are not recommended because they are not powers of 2. 5x10 and 4x8 are completely broken as they are not square.) If there is an <code>mcmeta</code> file associated with the texture, and an animation is defined, the image can be rectangular and is interpreted as a vertical sequence of square regions from top to bottom, where each square is a frame of the animation.
== JSON Models ==
Vanilla Minecraft’s JSON model format is rather simple. It defines cuboid (cube/rectangular prism) elements, and assigns textures to their faces. On the wiki, there is a definition of its format.
{{Colored box|title=Tip|content=JSON models only support cuboid elements; there is no way to express a triangular wedge or anything like it. To have more complicated models, another format must be used.}}
When a <code>ResourceLocation</code> refers to the location of a JSON model, it is not suffixed with <code><nowiki>.json</nowiki></code>, unlike OBJ and B3D models (e.g. <code><nowiki>minecraft:block/cube_all</nowiki></code>, not <code><nowiki>minecraft:block/cube_all.json</nowiki></code>).