Custom Items

This mod lets you define new items using JSON syntax, for example:

"uniqueName": "steakAndEggs",

"maxUses": 1,

"settings_Inventory": {

"texturePath": "steakAndEggs.png",

"localizationTerm": "Item/steakAndEggs",

"displayName": "Steak and Eggs",

"description": "A hearty meal!",

"stackSize": 5

"settings_usable": {

"isUsable": true,

"allowHoldButton": true,

"useButtonName": "LMB",

"useButtonCooldown": 1. 1,

"animationOnSelect": 38,

"animationOnUse": 15,

"forceAnimationIndex": false,

"setTriggering": false,

"lockItemDuringCooldown": true,

"resetTriggerOnDeselect": "",

"consumeUseAmount": 1,

"eventRef_break": "",

"useableItemTemplate":"ClayPlate_SteakWithJam",

"useableItemTextures":{

"Meals_AlbedoTransparency": "steakAndEggs_use.png"

"settings_consumeable": {

"foodType": 3,

"foodForm": 1,

"oxygenYield": 0. 0,

"hungerYield": 60. 0,

"bonusHungerYield": 60. 0,

"thirstYield": 0. 0,

"bonusThirstYield": 0. 0,

"isRaw": false,

"eventRef_consumeSound": "event:/char/chew"

"settings_cookable": {},

"settings_equipment": {}

The above defines a new meal item, steakAndEggs, based on ClayPlate_SteakWithJam.

It uses a custom png file for its inventory icon, and uses the ClayPlate_SteakWithJam in-game model with a modified texture to turn the jam yellow to look like egg (see the screenshots).

It has similar nutritional value to steak with jam, except less thirst and more hunger yield.

Usage

To use this mod, put your json code like above in a file with the json extension like steakAndEggs.json - make sure you are not saving it as a txt file. Put that file along with your your png files into the folder BepInEx/plugins/CustomItems. You can use subfolders, just make sure you add the subfolder to the png path in the code above.

To get info on existing items, you can use /dump <ItemName> in the chat box. Item names are here. This command will dump a json file into the CustomItems folder with an underscore on the front (files with underscore will not load as new items).

Textures

Getting in-game texture assets to create graphics is a little more complicated. The mod allows changing inventory sprites and main textures on mesh renderers of held objects.

I use this tool to export all Texture2D