Modding:Basic Block/ru: Difference between revisions

Пожалуйста, сначала прочитайте руководство [[Modding:The_Asset_System|Система активов]], если вы этого еще не сделали. Это руководство познакомит вас с основами добавления блоков в игру, используя JSON файлы. Если вы хотите добавить функциональный блок, то вам необходимо изучить руководство по [[Advanced Blocks|Продвинутым блокам]]. С полным списком свойств которые вы можете использовать в json файлах, вы можете ознакомиться [[Block Json Properties|здесь]].

Мы будем использовать эту текстуру для нашего блока: [[File:Gold block.png]].

Теперь вам нужно создать новый файл json в вашем редакторе (мы рекомендуем использовать редактор с подсветкой синтаксиса, такой как [https://notepad-plus-plus.org/ Notepad++] или Visual Studio).

code: "mygoldblock",

creativeinventory: { "general": ["*"] },

blockmaterial: "Stone",

drawtype: "Cube",

textures: {

all: { base: "block/mygoldtexture" }

resistance: 3.5,

sounds: {

Чтобы установить мод, перейдите к [[Vintagestory folder|папке Vintage Story]] и поместите его в папку модов.

textures: {

all: {  

base: "block/mygoldtexture",

alternates: [{base: "block/mygoldtexture1" }, {base: "block/mygoldtexture2" }, {base: "block/mygoldtexture3" }],

Eventually save it and run Vintagestory again. Now you should see a result like this:

Of course you can add more texture if you would like to.

== Variants ==

Gold is the best, but iron is awesome too ... so what shall we do? Let's add another variant of this block, because we all love iron.

You could duplicate the blocktype file and rename silver to gold in all the places, or you can simply add another variant to the existing blocktype.

=== Variantgroup: Type ===

So first of all we need some new textures again: [[File:Myirontexture.png]] [[File:Myirontexture1.png]] [[File:Myirontexture2.png]] [[File:Myirontexture3.png]]

Now we need to change a few things in our json file. We can add all kinds of different groups, but for now we keep it simple. We are adding group called <code>type</code>, with the states <code>gold</code> and <code>iron</code>. You can use any group code you want.

variantgroups: [

{ code: "type", states: ["gold", "iron"] }

The next thing we need to do is set textures by type. So we remove our <code>texture</code> property and replace it with a new property <code>texturesbytype</code>, which will allow us to set different textures for each type.

texturesbytype: {

all: {  

base: "block/mygoldtexture",

alternates: [{base: "block/mygoldtexture1" }, {base: "block/mygoldtexture2" }, {base: "block/mygoldtexture3" }],

all: {  

base: "block/myirontexture",

alternates: [{base: "block/myirontexture1" }, {base: "block/myirontexture2" }, {base: "block/myirontexture3" }],

Every group will be added after each other to the blocks code <code>myblockname-mygroup-mysecondgroup</code>. In our example we can save ourselves writing a few extra letters by using the wild card <code>*</code>.

You can also use a more compact definition. Due to way we named our textures we can use the placeholder {type} to determine the texture name, so instead of handling every case individually we can write it like this:

textures: {

all: {  

base: "block/my{type}texture",

alternates: [{base: "block/my{type}texture1" }, {base: "block/my{type}texture2" }, {base: "block/my{type}texture3" }],

The full blocktype definition could then look like this:  

code: "myshinyblock",

creativeinventory: { "general": ["*"] },

variantgroups: [

{ code: "type", states: ["gold", "iron"] }

blockmaterial: "Stone",

drawtype: "cube",

textures: {

all: {  

base: "block/my{type}texture",

alternates: [{base: "block/my{type}texture1" }, {base: "block/my{type}texture2" }, {base: "block/my{type}texture3" }],

resistance: 3.5,

sounds: {

=== Variantgroup: Condition ===

Let's at another group to our block, which will determine the condition of this block. There will be two states <code>good</code> and <code>used</code>. We can add this group by adding another property inside <code>variantgroups[]</code>.

variantgroups: [

{ code: "type", states: ["gold", "iron"] },

{ code: "condition", states: ["good", "used"]}

To finish implementing this second group we need to take care of every case. We want the <code>good</code> blocks to only use the base texture and the <code>used</code> blocks to also use their random textures:

texturesbytype: {

all: {  

base: "block/my{type}texture",

all: {  

base: "block/my{type}texture",

alternates: [{base: "block/my{type}texture1" }, {base: "block/my{type}texture2" }, {base: "block/my{type}texture3" }],

The blocks in a good condition or on the left side, while the used ones are on the right:

== Custom Shapes ==

In order to use a custom shape we need to create one first. The engine only supports the model/shape format that's created by the [[VS Model Creator]].

Once you have created your own shape you need to export it as a json file, create a new folder <code>assets/myshinyblock/shapes/block/</code> and save the file in there. In our example we will use this model [https://wiki.vintagestory.at/images/3/38/Myshinymodel.json Myshinymodel.json] and move it to <code>assets/myshinyblock/shapes/block/myshinymodel.json</code>.

Now we need to specify the model inside our block type json file.

Therefore we will change the drawtype from <code>cube</code> to <code>json</code>:

drawtype: "json",

and the shape to <code>myshinymodel</code>

shape: { base: "block/myshinymodel" },

Although this would be enough theoretically, we also should determine this block as being non-solid, to prevent graphical glitches.

sidesolid: {

all: "false"

sideopaque: {

all: "false"

So let's run the game. This is how it should look like:

== Variants of Custom Shapes ==

I created another model for the blocks in good condition ([https://wiki.vintagestory.at/images/f/fa/Myshinymodel1.json myshinymodel1.json]), because they should look more awesome, than the ones in used conditions. Therefore we need to copy the json file to <code>assets/myshinyblock/shapes/block/</code> as well.

In order to specify the shape by type we need to remove the property <code>shape</code> and replace it with <code>shapebytype</code>:

shapebytype: {

base: "block/myshinymodel1",

base: "block/myshinymodel",

= Mod Download =

You can find the complete mod here for reference:

= Moving Forward =

The example shown here, while seemingly complex, only scratches the surface of what blocktypes are capable of in Vintage Story. It's highly suggested that you experiment with or at least familiarize yourself with all the known block properties before moving onto code mods. The best way to do this is to peruse the '''[[Modding:Block Json Properties | Block Properties]]''' page, which contains an ongoing list of all the usable JSON block properties currently incorporated into the game. Most properties in the list also have referenced files you can search for in the Vintage Story Assets folder. If you don't know where this is, you can find tutorials for each operating system at the [[Modding:The Asset System | Asset System]] page.  

If you haven't yet, it's suggested you also check out the '''[[Modding:Basic Item | Basic Item]]''' and '''[[Modding:Basic Entity | Basic Entity]]''' pages to learn how simple JSON items and entities are added to the game.  

However, if you're feeling like making the jump to code mods then you'll want to start by setting up your '''[[Modding: Setting up your Development Environment | Development Environment]]'''.