Confirmedusers, editor, Administrators
886
edits
Modding:Basic Item: Difference between revisions
From Vintage Story Wiki
no edit summary
CreativeMD (talk | contribs) No edit summary |
CreativeMD (talk | contribs) No edit summary |
||
| (21 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
__FORCETOC__ | __FORCETOC__ | ||
This tutorial should introduce you into the basic of adding an item to the game using JSON files. If you want to add a item with functionality you should check out the tutorial for [[Advanced Items]]. There is a full list of all properties which can be defined inside the json file [[Item Json Properties]]. Adding a block to the game is rather similar, so if you have done that already most of the following steps should be | Please read the tutorial [[Getting Started with Advanced Modding#Domains|Getting Started]] first, if you haven't done it already. This tutorial should introduce you into the basic of adding an item to the game using JSON files. If you want to add a item with functionality you should check out the tutorial for [[Advanced Items]]. There is a full list of all properties which can be defined inside the json file [[Item Json Properties]]. Adding a block to the game is rather similar, so if you have done that already most of the following steps should be familiar to you. | ||
= A Simple Item = | = A Simple Item = | ||
So, the first thing we going to need is an idea. What does this game need | So, the first thing we going to need is an idea. What does this game need? Wait i got it ... the game needs an overpowered wand. Let's call this mod '''MyWandMod'''. | ||
== Workspace == | == Workspace == | ||
| Line 12: | Line 12: | ||
== The Texture == | == The Texture == | ||
This is the texture we gonna use [[File:Wand.png]] | This is the texture we gonna use [[File:Wand.png]]. | ||
In order to use the texture we need to put it at the right place. Therefore create the following folders in your workspace <code>assets/mywandmod/textures/item/</code>. Now rename the texture to <code>wand.png</code> and place it in there. | |||
== The Item File == | |||
To create the actual wand need to create a json file inside <code>assets/mywandmod/itemtypes/</code> in your workspace. In this example we name it <code>wand.json</code>. This file contains the basic properties of your item. | |||
The content of this json file should look as it follows: | The content of this json file should look as it follows: | ||
| Line 23: | Line 25: | ||
code: "wand", | code: "wand", | ||
creativeinventory: { "general": ["*"] }, | creativeinventory: { "general": ["*"] }, | ||
texture: { base: " | texture: { base: "item/wand" } | ||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
* '''code''': A unique identifier for your item | * '''code''': A unique identifier for your item. | ||
* '''creativeinventory''': The creative inventory tabs the itemshould be shown in (currently only 1 tab available) | * '''creativeinventory''': The creative inventory tabs the itemshould be shown in (currently only 1 tab available) | ||
* '''textures''': What textures to apply. | * '''textures''': What textures to apply. | ||
== | == Naming the Block == | ||
Now we got almost everything ready, except of a proper name. Create another json file in your workspace <code>assets/mywandmod/lang/en.json</code> and give your item a proper name: | |||
<syntaxhighlight lang="json"> | |||
{ | |||
"item-wand": "Wand" | |||
} | |||
</syntaxhighlight> | |||
== Testing/ Distribution == | |||
There is only one thing left. We need to create a zip file of the assets folder inside your workspace. Either you use an external program (such as WinRAR or 7Zip) or you right-click the <code>assets</code> folder and hit '''Send To''' -> '''Compressed (zipped) folder'''. Eventually you can rename the zip file to <code>MyWandMod.zip</code>. The zip file can be either used for testing purposes or you can send it to other people so they can use it as well. | |||
Furthermore you need to add a <code>modinfo.json</code> file, check out [[Game_Content_Mod|this tutorial]]. | |||
[https://wiki.vintagestory.at/images/e/ec/MyWandMod.zip MyWandMod.zip] | |||
To install the mod, navigate to the [[Vintagestory folder]] and place it inside the mods folder. | |||
Now we got everything ready to run our first test. You should be able to find the added item in the creative inventory. | |||
[ | [[File:2017-01-30 13-59-27.png|700px]] | ||
'''Hint''': Use the client command <code>.tfedit</code> if you want to adjust the item position, rotation and scale in Hands, in GUI, when dropped on the ground or in third person mode. | |||
= Advanced Properties = | = Advanced Properties = | ||
| Line 141: | Line 147: | ||
texturebytype: { | texturebytype: { | ||
"*-shovel": { | "*-shovel": { | ||
base: " | base: "item/wand-shovel", | ||
}, | }, | ||
"*-pickaxe": { | "*-pickaxe": { | ||
base: " | base: "item/wand-pickaxe", | ||
}, | }, | ||
"*-axe": { | "*-axe": { | ||
base: " | base: "item/wand-axe", | ||
}, | }, | ||
} | } | ||
| Line 155: | Line 161: | ||
<syntaxhighlight lang="json"> | <syntaxhighlight lang="json"> | ||
texture: { | texture: { | ||
base: " | base: "item/wand-{tooltype}", | ||
} | } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 169: | Line 175: | ||
<syntaxhighlight lang="json"> | <syntaxhighlight lang="json"> | ||
texture: { | texture: { | ||
base: " | base: "wand", | ||
overlays: [ " | overlays: [ "item/wand-overlay-{tooltype}" ], | ||
}, | }, | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 180: | Line 186: | ||
== Download == | == Download == | ||
You can download the mod to test it out yourself: [ | You can download the mod to test it out yourself: [https://wiki.vintagestory.at/images/e/ec/MyAdvancedWandMod.zip MyAdvancedWandMod.zip] | ||
{{Navbox/modding|Vintage Story}} | |||
