Differences

This shows you the differences between two versions of the page.

--- mtr_extra:resourcepack:make:others [2025/07/01 09:47] – initial commit Navi
+++ mtr_extra:resourcepack:make:others [2025/11/29 11:01] (current) – Navi
@@ Line 3: / Line 3: @@
 This guide will tell you how to add signs, sounds, etc. to your resource pack.
-<WRAP center round important 90%>
+<WRAP center round important 70%>
 **MTR4 format** is used in this tutorial.
@@ Line 9: / Line 9: @@
 </WRAP>
-===== Adding a sign =====
+<WRAP center round info 70%>
-  * Go to your //.minecraft// folder. {{:mtr_extra:resourcepack:minecraft_folder.png?200&nolink}}
+It is recommended to read [[mtr:adding_custom_resources|adding_custom_resources]] first, as it contains information about the structure of an MTR resource pack.
-  * Then find the //resourcepacks// folder {{:mtr_extra:resourcepack:screenshot_2023-05-16_211152.png?200&nolink}}
+</WRAP>
-  * Create a folder with a name that you want (for example: My custom signs) {{:mtr_extra:resourcepack:screenshot_2023-05-16_211341.png?200&nolink}}
+In the MTR mod, it is possible to add your own custom signs, rails, objects and lift retextures by editing the ''mtr_custom_resources.json''.
-  * Create a new folder inside of the existing folder called ''assets''.
-  * Upload a pack.png to your folder, this image will show in the resourcepack selection screen and should be 128x128.
-  * Download this template pack.mcmeta and put it into your resourcepack folder:
-<code json pack.mcmeta>
+==== Adding new custom content to the pack ====
-{
-    "pack": {
-        "description": "put your pack description here",
-        "pack_format": 9
-    }
-}
-</code>
-<WRAP center round info 90%>
+  * Create a folder under ''mtr'' with a name that you want (for example: ''custom_signs'').
-The pack format is what version of Minecraft the pack is for. If you are only adding MTR models or textures, this is not important. \\  However, if you feel the need to add a number, it is recommended to use 8 or 9, as they correspond to versions 1.18 and 1.19 respectively. \\  If a pack tells you it's "not compatible", just remember that the only thing that changes that is this number, so it really doesn't say much.
+<WRAP center round important 90%>
+Note that you can only use a-z, 0-9, - and _ for the folder name. CAPITAL LETTERS, white spaces and any other characters are **not acceptable.**
 </WRAP>
-  * Create a new folder named ''mtr'' in the assets folder.
+  * Drop in the custom content that you will use.
-  * Create a text file inside the folder named ''mtr_custom_resources.json''
+===== Registering custom content =====
-==== JSON files ====
+Return to ''mtr_custom_resources.json''.
-The ''mtr_custom_resources.json'' defines all custom resources that you want to add. The template is provided below.
+<tabbox Custom signs>
+**Compulsory components**
 <code json mtr_custom_resources.json>
 {
-    "vehicles": [],
+	"id": "my_custom_sign",
-    "signs": [],
+	"textureResource": "mtr:custom_signs/custom_icon.png",
-    "rails": [],
+	"customText": "你好|Hello",
-    "objects": [],
+	"small": false,
-    "lifts": []
+	"flipCustomText": false
 }
 </code>
-==== Adding your icon to the pack ====
+  * Replace the value of ''id'' with an ID that you like. Only a-z, 0-9, -, _ and ! are accepted.
+  * Replace the value of ''textureResource'' with the path to the icon.
-  * Create a folder under ''mtr'' with a name that you want (for example: ''custom_signs'').
+**Optional components**
-<WRAP center round important 90%>
+  * Replace the value of ''customText'' with any text that you want to render. Use a vertical bar (|) to separate between two languages.
+  * Set ''small'' to ''true'' if you want the icon to be rendered with a small padding around.
+  * Set ''flipCustomText'' to ''true'' if you want the text to be rendered to the right.
-Note that you can only use a-z, 0-9, - and _ for the folder name. CAPITAL LETTERS, white spaces and any other characters are **not acceptable.**
+<tabbox Custom rails>
-</WRAP>
+**Compulsory components**
-  * Add in the custom icon that you wanted to use.
+<code json mtr_custom_resources.json>
+{
+    "id": "my_custom_rail",
+    "name": "My custom Rail",
+    "color": "E5E533",
+    "modelResource": "mtr:custom_rails/my_custom_rail.obj",
+    "repeatInterval": 0.5
+}
+</code>
-<WRAP center round info 90%>
+  * Replace the value of ''id'' with an ID that you like. Only a-z, 0-9, -, _ and ! are accepted.
+  * Replace the value of ''name'' with a name that you like.
+  * Replace the value of ''modelResource'' with a path to the model.
+  * Replace the value of ''repeatInterval'' with the length of your model in metres.
-Typically, an icon for signs is 128 x 128 in size.
+**Optional components**
-</WRAP>
+  * Replace the value of ''color'' with a HEX colour value that you like. This will change the colour of the small square next to the object to that value.
-==== Registering the sign data ====
+<tabbox Custom objects>
-=== Compulsory components ===
+**Compulsory components** Inside the square brackets of ''"objects"'', add the following code.
-  * Return to the ''mtr_custom_resources.json''. Inside the square brackets of ''"signs"'', add the following code.
+<code json mtr_custom_resources.json>
+{
+	"id": "my_custom_object",
+        "name": "My custom object",
+        "modelResource": "mtr:custom_objects/my_custom_object.obj",
+        "textureResource": "mtr:custom_objects/my_custom_object.mtl",
+        "color": "000000",
+        "flipTextureV": true,
+        "translation": [0,0,0],
+        "rotation": [0,0,0],
+        "scale": [1,1,1],
+        "mirror": [false,false,false]
+}
+</code>
+  * Replace the value of ''id'' with an ID that you like. Only a-z, 0-9, -, _ and ! are accepted.
+  * Replace the value of ''name'' with a name that you like.
+  * Replace the value of ''modelResource'' with a path to the model.
+  * Replace the value of ''textureResource'' with a path to the model's texture.
+  * Set ''flipTextureV'' to ''false'' if your texture is flipped.
+**Optional components**
+  * Replace the value of ''color'' with a HEX colour value that you like. This will change the colour of the small square next to the object to that value.
+  * Modify the values of ''translation'', ''rotation'' and/or ''scale'' ([x,y,z]) if you want the model to be rendered by default to have that value of translation/rotation/scale.
+  * Set ''mirror'' to ''true'' if you want the icon to be rendered with a small padding around.
+<tabbox Custom lifts>
+**Compulsory components**
 <code json mtr_custom_resources.json>
 {
-	"id": "my_custom_sign",
+	"id": "my_custom_lift",
-	"textureResource": "mtr:custom_signs/custom_icon.png",
+        "name": "My custom lift",
-	"customText": "你好|Hello",
+        "color": "CCCCCC",
-	"small": false,
+        "textureResource": "mtr:custom_lifts/my_custom_lift.png"
-	"flipCustomText": false
 }
 </code>
-  * Replace the ''id'' to an ID that you like. Only a-z, 0-9, -, _ and ! are accepted.
+  * Replace the value of ''id'' with an ID that you like. Only a-z, 0-9, -, _ and ! are accepted.
-  * Replace the ''textureResource'' with the path to the icon.
+  * Replace the value of ''name'' with a name that you like.
+  * Replace the ''textureResource'' with the path to the lift texture.
-=== Optional components ===
+**Optional components**
-  * Replace the ''customText'' with any text that you want to render. Use a vertical bar (|) to separate between two languages.
+  * Replace the value of ''color'' with a HEX colour value that you like. This will change the colour of the small square next to the object to that value.
-  * Set ''small'' to ''true'' if you want the icon to be rendered with a small padding around.
-  * Set ''flipCustomText'' to ''true'' if you want the text to be rendered to the right.
+</tabbox>
-  * Save the JSON file.
+Save the JSON file when you're done.
 <WRAP center round important 90%>
@@ Line 104: / Line 141: @@
 </WRAP>
-==== Adding it to the game ====
+===== Adding it to the game =====
   * Open Minecraft, and go to {{:mtr_extra:resourcepack:make:options.png?100}} > {{:mtr_extra:resourcepack:make:rp.png?160}} from either the Game Menu or the title page.
   * Apply the resource pack, and press {{:mtr_extra:resourcepack:make:done.png?160}}.
-  * Your sign should now show in the game.
-{{:mtr_extra:resourcepack:make:2025-07-01_10.29.41.png?400}}
+===== Checking your custom content =====
+To check whether your custom content has been added to the game, follow the instructions below.
+==== Signs ====
+Place down a sign, and scroll to the last page. Your custom sign should show.
+==== Rails ====
+Place down a rail, and use (right click) one of the rail node. Press ''Edit...'' and you should see your rail model.
+==== Objects ====
+Place down a decoration object, and use (right click) it. Press ''Edit...'' and you should see your custom object.
-==== TODO ====
+==== Lifts ====
-  - How to add custom objects
+Create a lift structure, and use (right click) the lift track with a Lift Refresher. Press ''Style: ...'' and you should see your lift retexture.
-  - How to add custom rails
-  - How to add custom lifts