Difference between revisions of "VS Model Creator Tutorials"

From Vintage Story Wiki
Jump to navigation Jump to search
(Marked this version for translation)
Line 1: Line 1:
 
<translate>
 
<translate>
 +
<!--T:6-->
 
Vintage Story has its own model creator called VS Model Creator that allows anyone to create, texture, and animate custom shapes for use in Vintage Story mods. The newest version can be downloaded [https://github.com/tyronx/vsmodelcreator/releases here].  
 
Vintage Story has its own model creator called VS Model Creator that allows anyone to create, texture, and animate custom shapes for use in Vintage Story mods. The newest version can be downloaded [https://github.com/tyronx/vsmodelcreator/releases here].  
  
 +
<!--T:7-->
 
Below you can find modified versions of a modeling tutorial and an animation tutorial created by Balduranne and Luke, respectively. Click [https://www.vintagestory.at/forums/topic/505-vs-model-creator-basics/ here] if you would like to visit the original thread where these tutorials were originally posted.
 
Below you can find modified versions of a modeling tutorial and an animation tutorial created by Balduranne and Luke, respectively. Click [https://www.vintagestory.at/forums/topic/505-vs-model-creator-basics/ here] if you would like to visit the original thread where these tutorials were originally posted.
  
 +
<!--T:8-->
 
[[File:Vsmc_1.png|thumb|center|600px]]
 
[[File:Vsmc_1.png|thumb|center|600px]]
  
 +
<!--T:9-->
 
__TOC__
 
__TOC__
  
== Modeling ==
+
== Modeling == <!--T:10-->
  
===Modeling Basics===
+
===Modeling Basics=== <!--T:11-->
  
 +
<!--T:12-->
 
The model creator only allows working with cubes or parts of cubes, which you can create by clicking the Red/Green/Blue icon below the selection window. Once you have something selected, you can get to the modeling proper - Voxel Size determines the shape and size of the object, Position moves it around the grid, while Origin is from where the model is supposed to 'start' from. This mostly comes into play when rotating the object.
 
The model creator only allows working with cubes or parts of cubes, which you can create by clicking the Red/Green/Blue icon below the selection window. Once you have something selected, you can get to the modeling proper - Voxel Size determines the shape and size of the object, Position moves it around the grid, while Origin is from where the model is supposed to 'start' from. This mostly comes into play when rotating the object.
 
[[File:Vsmc_2.jpg|thumb|center|800px]]
 
[[File:Vsmc_2.jpg|thumb|center|800px]]
 
&nbsp;
 
&nbsp;
  
 +
<!--T:13-->
 
When adding more cubes, it's important to keep in mind what you have selected - In this case, Cube2 is docked under Cube1, so if we move the latter, Cube2 will end up moving along with Cube1. Cube 3 in this example is sitting on its own, and is unaffected by the other two.
 
When adding more cubes, it's important to keep in mind what you have selected - In this case, Cube2 is docked under Cube1, so if we move the latter, Cube2 will end up moving along with Cube1. Cube 3 in this example is sitting on its own, and is unaffected by the other two.
 
[[File:Vsmc_3.png|thumb|center|800px]]
 
[[File:Vsmc_3.png|thumb|center|800px]]
 
&nbsp;
 
&nbsp;
  
 +
<!--T:14-->
 
After a little fiddling, we have our model. In this case it's a candle holder with a candle:
 
After a little fiddling, we have our model. In this case it's a candle holder with a candle:
 
[[File:Vsmc_4.png|thumb|center|800px]]
 
[[File:Vsmc_4.png|thumb|center|800px]]
 
&nbsp;
 
&nbsp;
  
===Model Duplication===
+
===Model Duplication=== <!--T:15-->
 
Very often you'll want to duplicate an element and move it around to speed up the modelling process. It's less time consuming than making a fresh object and moving it in the correct place and shape:
 
Very often you'll want to duplicate an element and move it around to speed up the modelling process. It's less time consuming than making a fresh object and moving it in the correct place and shape:
 
[[File:Vsmc_10.png|thumb|center|800px]]
 
[[File:Vsmc_10.png|thumb|center|800px]]
 
&nbsp;
 
&nbsp;
  
 +
<!--T:16-->
 
I'm sure very often you'll find yourself just applying the same texture to the entire object. This is where the Entity Texturing Mode comes into play:
 
I'm sure very often you'll find yourself just applying the same texture to the entire object. This is where the Entity Texturing Mode comes into play:
 
[[File:Vsmc_11.png|thumb|center|800px]]
 
[[File:Vsmc_11.png|thumb|center|800px]]
 
&nbsp;
 
&nbsp;
  
 +
<!--T:17-->
 
Once clicked, the entire model will be assigned one texture. It's handy, but we still need to tweak it by hand. While the mode is on, you can only move an entire object around in the UV map editor (Left), that's hardly ideal in some cases. That's why we want to disable the Entity Texturing Mode (Don't worry, the texture will stay on), and go back to the Face menu and manually move the texture around.
 
Once clicked, the entire model will be assigned one texture. It's handy, but we still need to tweak it by hand. While the mode is on, you can only move an entire object around in the UV map editor (Left), that's hardly ideal in some cases. That's why we want to disable the Entity Texturing Mode (Don't worry, the texture will stay on), and go back to the Face menu and manually move the texture around.
 
[[File:Vsmc_12.png|thumb|center|800px]]
 
[[File:Vsmc_12.png|thumb|center|800px]]
 
&nbsp;
 
&nbsp;
  
 +
<!--T:18-->
 
This is especially important in cases where we want to use a single texture for a model, as is the case with my Loom model, or the NPC models (Including the player one):
 
This is especially important in cases where we want to use a single texture for a model, as is the case with my Loom model, or the NPC models (Including the player one):
 
[[File:Vsmc_13.png|thumb|center|800px]]
 
[[File:Vsmc_13.png|thumb|center|800px]]
 
&nbsp;
 
&nbsp;
  
 +
<!--T:19-->
 
Furthermore, if you're using one texture, you can tweak the texture size for larger objects:
 
Furthermore, if you're using one texture, you can tweak the texture size for larger objects:
 
[[File:Vsmc_14.png|thumb|center|800px]]
 
[[File:Vsmc_14.png|thumb|center|800px]]
 
&nbsp;
 
&nbsp;
  
 +
<!--T:20-->
 
[[File:Vsmc_15.png|thumb|center|800px]]
 
[[File:Vsmc_15.png|thumb|center|800px]]
 
&nbsp;
 
&nbsp;
  
 +
<!--T:21-->
 
Another useful trick is exporting the UV map of your model. Once you have it unwrapped (That is, spread around your texture sheet), you can export the UV map to make a proper texture for it, or in the case of the player model - Make your own skin for it:
 
Another useful trick is exporting the UV map of your model. Once you have it unwrapped (That is, spread around your texture sheet), you can export the UV map to make a proper texture for it, or in the case of the player model - Make your own skin for it:
 
[[File:Vsmc_16.png|thumb|center|800px]]
 
[[File:Vsmc_16.png|thumb|center|800px]]
 
&nbsp;
 
&nbsp;
  
 +
<!--T:22-->
 
That should about cover the basics. One important thing to keep in mind is that one block is 16x16x16 (The size of the grid) in the editor.
 
That should about cover the basics. One important thing to keep in mind is that one block is 16x16x16 (The size of the grid) in the editor.
  
 +
<!--T:23-->
 
Model Editor controls, for reference - They're in the Help submenu (It really helps to memorize them!):
 
Model Editor controls, for reference - They're in the Help submenu (It really helps to memorize them!):
 
[[File:Vsmc_18.png|thumb|center|600px]]
 
[[File:Vsmc_18.png|thumb|center|600px]]
 
&nbsp;
 
&nbsp;
  
 +
<!--T:24-->
 
Once you have the hang of it, you can use Render Passes. An explanation of the different modes can be found by clicking [http://apidocs.vintagestory.at/api/Vintagestory.API.Client.EnumChunkRenderPass.html here], but In laymans terms, they determine how a block will behave visually (Think - Glass, Ice, etc):
 
Once you have the hang of it, you can use Render Passes. An explanation of the different modes can be found by clicking [http://apidocs.vintagestory.at/api/Vintagestory.API.Client.EnumChunkRenderPass.html here], but In laymans terms, they determine how a block will behave visually (Think - Glass, Ice, etc):
 
[[File:Vsmc_17.png|thumb|center|600px]]
 
[[File:Vsmc_17.png|thumb|center|600px]]
Line 67: Line 83:
 
&nbsp;
 
&nbsp;
  
 +
<!--T:25-->
 
Let's look at this interface - Textures are assigned separately for each side of the model, which we need to apply manually. We can speed it up by clicking Copy and then Paste for every side. If a side is not going to be visible in game, you can deselect "Enabled", which will make that side invisible.
 
Let's look at this interface - Textures are assigned separately for each side of the model, which we need to apply manually. We can speed it up by clicking Copy and then Paste for every side. If a side is not going to be visible in game, you can deselect "Enabled", which will make that side invisible.
 
[[File:Vsmc_6.png|thumb|center|800px]]
 
[[File:Vsmc_6.png|thumb|center|800px]]
 
&nbsp;
 
&nbsp;
  
 +
<!--T:26-->
 
But first we need to click Image and import a texture we want to use. To make life easier, you can set the default texture path to take textures from. This is useful if you're going to use vanilla textures. Once a texture is imported - Click on it and select Apply. Please note that if your texture is outside of the game folder when Imported, you will need to tweak the model's shape (.json) file to reflect its location for the game. You will have to do this most of the time.
 
But first we need to click Image and import a texture we want to use. To make life easier, you can set the default texture path to take textures from. This is useful if you're going to use vanilla textures. Once a texture is imported - Click on it and select Apply. Please note that if your texture is outside of the game folder when Imported, you will need to tweak the model's shape (.json) file to reflect its location for the game. You will have to do this most of the time.
 
[[File:Vsmc_7.png|thumb|center|800px]]
 
[[File:Vsmc_7.png|thumb|center|800px]]
 
&nbsp;
 
&nbsp;
  
 +
<!--T:27-->
 
If we want to fine tune our UV Mapping (Aka how the texture is lined up on the model), we can use the Face UV controls to change the shape of the face. In this case, we stretch it out so that all the rivets are visible. One should also drag and move around the individual faces in the leftmost menu for best effect:
 
If we want to fine tune our UV Mapping (Aka how the texture is lined up on the model), we can use the Face UV controls to change the shape of the face. In this case, we stretch it out so that all the rivets are visible. One should also drag and move around the individual faces in the leftmost menu for best effect:
 
[[File:Vsmc_8.png|thumb|center|800px]]
 
[[File:Vsmc_8.png|thumb|center|800px]]
 
&nbsp;
 
&nbsp;
  
 +
<!--T:28-->
 
Once we're satisfied with the effect, we can save the model and use it in a mod:
 
Once we're satisfied with the effect, we can save the model and use it in a mod:
 
[[File:Vsmc_9.png|thumb|center|800px]]
 
[[File:Vsmc_9.png|thumb|center|800px]]
 
&nbsp;
 
&nbsp;
 
</translate>
 
</translate>

Revision as of 03:16, 28 July 2020

Vintage Story has its own model creator called VS Model Creator that allows anyone to create, texture, and animate custom shapes for use in Vintage Story mods. The newest version can be downloaded here.

Below you can find modified versions of a modeling tutorial and an animation tutorial created by Balduranne and Luke, respectively. Click here if you would like to visit the original thread where these tutorials were originally posted.

Vsmc 1.png

Modeling

Modeling Basics

The model creator only allows working with cubes or parts of cubes, which you can create by clicking the Red/Green/Blue icon below the selection window. Once you have something selected, you can get to the modeling proper - Voxel Size determines the shape and size of the object, Position moves it around the grid, while Origin is from where the model is supposed to 'start' from. This mostly comes into play when rotating the object.

Vsmc 2.jpg

 

When adding more cubes, it's important to keep in mind what you have selected - In this case, Cube2 is docked under Cube1, so if we move the latter, Cube2 will end up moving along with Cube1. Cube 3 in this example is sitting on its own, and is unaffected by the other two.

Vsmc 3.png

 

After a little fiddling, we have our model. In this case it's a candle holder with a candle:

Vsmc 4.png

 

Model Duplication

Very often you'll want to duplicate an element and move it around to speed up the modelling process. It's less time consuming than making a fresh object and moving it in the correct place and shape:

Vsmc 10.png

 

I'm sure very often you'll find yourself just applying the same texture to the entire object. This is where the Entity Texturing Mode comes into play:

Vsmc 11.png

 

Once clicked, the entire model will be assigned one texture. It's handy, but we still need to tweak it by hand. While the mode is on, you can only move an entire object around in the UV map editor (Left), that's hardly ideal in some cases. That's why we want to disable the Entity Texturing Mode (Don't worry, the texture will stay on), and go back to the Face menu and manually move the texture around.

Vsmc 12.png

 

This is especially important in cases where we want to use a single texture for a model, as is the case with my Loom model, or the NPC models (Including the player one):

Vsmc 13.png

 

Furthermore, if you're using one texture, you can tweak the texture size for larger objects:

Vsmc 14.png

 

Vsmc 15.png

 

Another useful trick is exporting the UV map of your model. Once you have it unwrapped (That is, spread around your texture sheet), you can export the UV map to make a proper texture for it, or in the case of the player model - Make your own skin for it:

Vsmc 16.png

 

That should about cover the basics. One important thing to keep in mind is that one block is 16x16x16 (The size of the grid) in the editor.

Model Editor controls, for reference - They're in the Help submenu (It really helps to memorize them!):

Vsmc 18.png

 

Once you have the hang of it, you can use Render Passes. An explanation of the different modes can be found by clicking here, but In laymans terms, they determine how a block will behave visually (Think - Glass, Ice, etc):

Vsmc 17.png

 

Texturing

Once we have our model, we can slap some textures on:

Vsmc 5.png

 

Let's look at this interface - Textures are assigned separately for each side of the model, which we need to apply manually. We can speed it up by clicking Copy and then Paste for every side. If a side is not going to be visible in game, you can deselect "Enabled", which will make that side invisible.

Vsmc 6.png

 

But first we need to click Image and import a texture we want to use. To make life easier, you can set the default texture path to take textures from. This is useful if you're going to use vanilla textures. Once a texture is imported - Click on it and select Apply. Please note that if your texture is outside of the game folder when Imported, you will need to tweak the model's shape (.json) file to reflect its location for the game. You will have to do this most of the time.

Vsmc 7.png

 

If we want to fine tune our UV Mapping (Aka how the texture is lined up on the model), we can use the Face UV controls to change the shape of the face. In this case, we stretch it out so that all the rivets are visible. One should also drag and move around the individual faces in the leftmost menu for best effect:

Vsmc 8.png

 

Once we're satisfied with the effect, we can save the model and use it in a mod:

Vsmc 9.png