Modding:Asset Type - Shapes: Difference between revisions

From Vintage Story Wiki
(Page creation.)
 
mNo edit summary
Line 2: Line 2:
<translate>
<translate>
== Usage ==
== Usage ==
'''Patch''' assets are used to change specific parts of other JSON assets. They can be used for changing base game assets, or used for mod compatibility. Patch assets are written in JSON.   
'''Shape''' assets are used to define 3D models for other assets. Shape assets are written in JSON.   


=== Asset Location ===
=== Asset Location ===
New patch assets can be made by creating new JSON files in a folder called 'patches' in your mod's domain.
New shape assets can be made by creating JSON files in a folder called 'shapes' in your mod's domain. Although not necessary, it is good-practice to split shapes into '<nowiki/>''block''<nowiki/>', ''<nowiki/>'item''<nowiki/>', and ''<nowiki/>'entity''' subfolders.


=== Notes ===
=== Notes ===
Although patches are written in JSON, it is recommended to use the in-built mod maker program to generate them.
Although shapes are written in JSON, it is highly recommended to use the official [https://github.com/anegostudios/vsmodelcreator/releases Vintage Story Model Creator] to create shape files.  


== See Also ==
== See Also ==


* [https://github.com/anegostudios/vsessentialsmod/blob/master/Loading/JsonPatchLoader.cs#L41 JsonPatch on GitHub]
* [https://github.com/anegostudios/vsapi/blob/cad83424ee89915ef206d0b23845af0a4ef72348/Common/Model/Shape/CompositeShape.cs CompositeShape on GitHub]
* {{ll|Modding:JSON Patching|JSON Patching}}
* [https://github.com/anegostudios/vsmodelcreator VSModelCreator]
* {{Ll|Modding:CompatibilityLib|Compatibility With Other Mods}}


</translate>
</translate>
{{Navbox/contentmodding}}
{{Navbox/contentmodding}}

Revision as of 10:55, 19 July 2024

Other languages:
  • English

Usage

Shape assets are used to define 3D models for other assets. Shape assets are written in JSON.

Asset Location

New shape assets can be made by creating JSON files in a folder called 'shapes' in your mod's domain. Although not necessary, it is good-practice to split shapes into 'block', 'item', and 'entity' subfolders.

Notes

Although shapes are written in JSON, it is highly recommended to use the official Vintage Story Model Creator to create shape files.

See Also


Content Modding
Basics Content Mods Developing a Content Mod Packaging & Release
Tutorials
Concepts Modding Concepts Modinfo Variants Domains Patching Remapping World Properties
Moddable Assets
Uncategorized
Icon Sign.png

Wondering where some links have gone?
The modding navbox is going through some changes! Check out Navigation Box Updates for more info and help finding specific pages.

Modding
Modding Introduction Getting Started Theme Pack
Content Modding Content Mods Developing a Content Mod Basic Tutorials Intermediate Tutorials Advanced Tutorials Content Mod Concepts
Code Modding Code Mods Setting up your Development Environment
Property Overview ItemEntityBlockBlock BehaviorsBlock ClassesBlock EntitiesBlock Entity BehaviorsWorld properties
Workflows & Infrastructure Modding Efficiency TipsMod-engine compatibilityMod ExtensibilityVS Engine
Additional Resources Community Resources Modding API Updates Programming Languages List of server commandsList of client commandsClient startup parametersServer startup parameters
Example ModsAPI DocsGitHub Repository