Modding:Content Tutorial Simple Recipe

From Vintage Story Wiki
Revision as of 12:02, 24 March 2024 by Nateonus (talk | contribs) (Minor formatting.)
Other languages:
  • English

This page was last verified for Vintage Story version 1.19.4.


Introduction

Objective

In this tutorial, you will create two new grid recipes for our previously made item and block! Recipes are a great way of allowing players to access your new content.

Assets

Before starting, it is recommended you download the workspace and assets for this tutorial. The completed files can also be found here.

This tutorial starts with the following assets:

  • Mod Setup & Folder Structure
  • Premade Blocktype file
  • Premade Itemtype file
  • Premade Lang file
  • Texture & Shape Files
  • Empty Grid Recipe Files

Prerequisites

This tutorial will assume you understand the following topics:

Although not necessary, it is recommended to have completed the following tutorials:

  • 2. Simple Item
    • The 'Simple Wand' item is included in the tutorial setup.
  • 3. Simple Block
    • The 'Simple Gold Block' is included in the tutorial setup.

Navigating Assets

Browse the downloaded workspace. You should have an understanding of most of the files that currently exist, however there are two new files:

  • assets/simplerecipe/recipes/grid/simplewandrecipe.json - An empty json file. This will be used to create a recipe for the 'Simple Wand' item.
  • assets/simplerecipe/recipes/grid/simpleblockrecipe.json - An empty json file. This will be used to create a recipe for the 'Simple Gold Block'.

Creating the Item Recipe

Conclusion

Congratulations, you have now created your first block! This tutorial should have given you greater understanding of blocks, textures, sounds and language files, as well as the basics of modding for Vintage Story!

Next Steps...

If you want to test your knowledge, consider doing the tasks under the Going Further section below.

When you're ready, try out the next tutorial: Simple Recipes. This will show you how to create recipes for the assets you have created.

Going Further

Want to make some additional changes to this mod? Try and achieve the following things!

Change the color of the block

To achieve this...
Modify the shinygoldtexture.png texture to a different color.

Change the block to only be mined with at least a tier 1 tool. Note that you will have to add a new "requiredToolTier" property

To achieve this...
Add "requiredToolTier":1 to the blocktype file.

Change your modid and domain to something else

To achieve this...
Modify both the modid entry in modinfo.json, and change the name of the 'simpleblock' folder in 'assets'.

Rename your 'Simple Gold Block'

To achieve this...
Change the entry for simplegoldblock in your en.json lang file.

Create another block with a different texture and properties

To achieve this...
Create a new block texture with a different name, and a duplicate blocktype file. In the new blocktype file, change the block code and change the texture property to your new texture path. Modify the properties to change the type of block. Don't forget to add new lang translation entries!


Content Modding
Basics Content Mods Developing a Content Mod
Tutorials
Concepts Modding Concepts Variants Domains Patching Remapping World Properties
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