Notifications
Notification preferences
notifications_off

No unread notifications right now

You're up to date
View All

You're up to date

0 of 0

File information

Last updated

Original upload

Created by

restless-barkeep

Uploaded by

restlessbarkeep

Virus scan

Safe to use

Tags for this mod

Tag this mod
Current section

About this mod

Want to add new Items/Recipes to the game?

Requirements
Permissions and credits
CustomItems

this mod is a big one and Nexus formatting is a bit bad see the Step By Step Guide with pictures on GitHub along with more Documentation and Code

Mod to allow adding more Items into the game

Only tested Food/Drink and Recipes atm

(currently ToolTips do not work)

How it works
The mod will look into all folders provided in the config for any .csv file containing item/recipe and will load those csv into memory and on game start will add all into the inGame database. For all Sprites in the item file you will need to provide a .png spriteSheet and the name with folder to the spriteSheet, note the spritesheet counts off starting at bottom left (0,0) and the file has to be 512x512 pixels.

Note mod also needs the CsvHelper.dll added into the BepInEx plugins so don't forget to copy that overNote mod assumes the SpriteSheet has 33x33 sprites but even the game does not do exactly that to save some space

[img alt="Folder Structure"]readmePictures/img.png[/img]

item list 1

item list 2

recipe

Examples:
fried egg = "1251 - ""egg"" (1)" + "-27 - ""any oil"" (1)"


Create an Item file (.csv)
id,name,foodType,canBeUsedAsModifier,containsAlcohol,ingredientType,canBeAged,hasToBeAgedMeal,appearsInOrders,excludedFromTrends,spriteSheetName,spriteX,spriteY,modifiers,silverCoins,copperCoins
0,fried egg,Food,false,false,None,false,false,false,false,rbk-tr-CustomItems\stardewValleySprites.png,0,3,,1,2


foodType

  • Food or Drink or None

ingredientType

  • If this new item is an ingredient item what type of ingredient is it

None
Herb
Fruit
Veg
Hop
Honey
Meat
WhiteFish
Grain
Cheese
Flour
Seed
Wort
Yeast
Sandwich
Beer
Wine
Distillate
Cocktail
Liqueur
Mushroom
Legumes
Nuts
BlueFish
Shellfish
Berries


modifiers (currently not connected)

  • If this new item is an ingredient item what type of modifiers does it provide

Fruity
Citrus
Sweet
Vanilla
Caramel
Herbal
Hoppy
Bitter
Juicy
Meaty
Fishy
Starchy
Veggie
Cheesy
Sour
Spicy
Aromatic
Seedy
Aged
Dairy


silverCoins

  • number of silver coins for the sell price (used with copperCoins)

copperCoins

  • number of copper coins for the sell price (used with silverCoins)

Create a Recipe file (.csv)
id,name,itemId,workstation,page,recipeGroup,recipeIngredients,fuel,time,outputAmount
182001,Fried Egg,182001,672,Starter,Food,"1251 - (1)",5,10,1

workstation

  • id for the workstation this recipe will be added to

670 - Distillery
672 - Oven
673 - Malting Machine
674 - Cheese Factory
675 - Fermentation Tank
676 - Mash Barrel
703 - Sawmill
704 - Smelting Furnace
706 - Stone Workshop
709 - Press
723 - Cutting Axe
731 - Stonecutter Work Table
733 - Mixing Tank
728 - Blacksmith Table
1232 - Forage Table
1240 - Kitchen Table
1380 - Preserves Table
1451 - Tackle Table
1532 - Cocktail Table


page

  • What page will this recipe show in the crafter/recipe book

All
Starter
Vegetables
PastaRice
Meat
Fish
Broth
Dessert
Drinks


recipeGroup

  • What group does this recipe best fit in

None
Food
Drink
Wood
Stone
Metal


recipeIngredients

  • formated as: "itemId - (itemAmount)"
    • so a fried egg is just 1 egg so "1251 - (1)"
  • you can have up to 5 ingredients separated by |
  • groupIds are also supported (yes they are negative):

-45 - "Beer Group"
-44 - "Wine Group"
-43 - "Grape Juice"
-42 - "Roasted Hops"
-41 - "Black Hops"
-40 - "Light Hops"
-39 - "Roasted Gray Malt"
-38 - "Roasted Light Malt"
-37 - "Gray Malt"
-36 - "Light Malt"
-35 - "Mince and Seafood"
-34 - "Mince"
-33 - "Crab Group"
-32 - "Cephalopod"
-31 - "Citrus"
-30 - "Pickles Group"
-29 - "Lemon Lime"
-28 - "Cake Flavors"
-27 - "Oily"
-23 - "Milk Group"
-22 - "Ribs Group"
-21 - "Fat Group"
-19 - "White Fish"
-18 - "Fish and Seafood"
-17 - "Blue Fish"
-16 - "Seafood Group"
-15 - "Group Meat Vegetables or Fish"
-14 - "Nuts"
-13 - "Tea Leaves"
-12 - "Legumes Group"
-11 - "Meat and Fish Group"
-10 - "Mushrooms Group"
-9 - "Vegetables Group"
-8 - "Fish Group"
-7 - "Seeds Group"
-6 - "Dishes Group"
-5 - "Bread Group"
-4 - "Cheese Group"
-3 - "Cereal Group"
-2 - "Fruit Group"
-1 - "Meat Group"


Examples - added recipes for Amos' consumables
Using Yeast and Malts to make more Yeast[img alt="img_14.png"]readmePictures/img_14.png[/img]

Using White Wine to make Vinegar[img alt="img_15.png"]readmePictures/img_15.png[/img]

ChangeLog
0.2.2
  • More Debugging options

0.2.1
  • Adding fallback wall textures if things end up breaking

0.2.0
  • Added option for Custom DecorativeTiles (Tavern Walls/Flooring)

0.1.1
  • Fixed warning issue on custom item
  • Added bait recipes

0.1.0
  • Added modifier requirements to recipes
  • Added reload recipe/items functionality
  • Added tooltips
  • Progress to getting non Food items as well!!

0.0.6.2
  • Added modifer logic, fixed tooltips, updated ingredient flow

0.0.6
  • Update to support new recipe format White Vinegar = 10x 166 "white wine" which was suggested instead of 166 - "white wine" (10)
    • the mod "for now" will support both styles
  • fixed issue with variable recipes not using item sell prices to increase recipe sell price
  • Items and Recipes can now have id 0 and the mod will find the items (only modded items not base game items)

0.0.5
  • added even more safety to the mod (bad headers in file)

0.0.4
  • Added more safety to mod


0.0.3
  • Update to split silver and copper prices
  • fixing issue I added on the new ingredient column types

0.0.2
  • Added Seed recipe generator
  • Changed from "item## - "hint" (10)|item## - "hint" (10)|item## - "hint" (10)|item## - "hint" (10)" to one column per ingredient
  • Added option for mod to assign Ids

0.0.0
  • Mod supports reading a CSV with Items and a CSV with Recipes and referencing a SpriteSheet PNG for the item icons.


Here are DrStalker's tips on downloading/installing mods which is how I figured out these mods above.

Downloading the mod
Mods are available on Nexus Mods or you can download/recompile the mod from my github repo

How to install mods:
  • Install Bepinex (Stable version 5.4 for Windows 64; the filename will look like BepInEx_win_x64_5.4.23.2.zip)
  • Start the game, quit the game after it finishes loading
  • This will create a Bepinex config file and a plugins folder that you can put additional mods in
  • (optional) Enable the Bepinex Console (see the detailed guide or the Bepinex documentation for steps)
  • Copy the mod .dll to the plugins directory.

How to change mod settings:
  • Install the mod and start the game.
  • Bepinex will create a file in the \BepInEx\config\ with default settings for the mod.
  • Exit the game, edit the config file, restart the game.

Is this mod save to add/remove mid play-through?
Yes and No

Custom Wall/Floor must be removed in game before removing the mod.
But custom items will just disappear and the game mostly handles it ok.

Traveller's Rest Modding Guide
Here are DrStalker's notes on modding Traveler's Rest.