|
| 1 | +[size=6][b]Recipe Mod for Rune Factory 5[/b][/size] |
| 2 | +Rune Factory 5 BepInEx plugin for loading custom recipes. |
| 3 | + |
| 4 | +[size=5]Installation[/size] |
| 5 | +[list=1] |
| 6 | +[*]Install [url=https://github.com/Lyall/RF5Fix]RF5Fix mod[/url] (BepInEx included there). |
| 7 | +[*]Download this mod [url=https://github.com/PurplefinNeptuna/RF5.RecipeMod/releases]here.[/url] |
| 8 | +[*]Extract RF5.RecipeMod.zip file to [b][font=Courier New]<GameDirectory>\BepInEx\plugins[/font][/b]. |
| 9 | +[*]([i]Recommended[/i]) Make folder for each plugins so it will be easier to manage plugins. |
| 10 | +[/list] |
| 11 | +[img]https://user-images.githubusercontent.com/23467102/184843956-07f70c2f-2088-440f-ab0e-390f5e986a5d.png[/img] |
| 12 | +[img]https://user-images.githubusercontent.com/23467102/184843357-2c22a72c-cd37-40c8-b518-3afe6e1ea361.png[/img] |
| 13 | + |
| 14 | +[size=5]What this mod do[/size] |
| 15 | +Load custom recipes data (in JSON format) from [b][font=Courier New]Custom Recipes[/font][/b] folder. |
| 16 | +This mod has 2 custom recipes files included |
| 17 | +- [b][font=Courier New]ClipAndMag.json[/font][/b] contains recipes for clipper and magnifying glass |
| 18 | +- [b][font=Courier New]LargeCrystals.json[/font][/b] contains recipes for all large crystals |
| 19 | +[img]https://user-images.githubusercontent.com/23467102/184844622-b5fb636e-6818-4b39-8992-9680ac1af859.png[/img] |
| 20 | +[img]https://user-images.githubusercontent.com/23467102/184845039-88475772-538e-4ae8-9d11-b621b8040afb.png[/img] |
| 21 | + |
| 22 | +[size=5](Advanced) Create custom recipes files[/size] |
| 23 | +You can create your own custom recipes by creating new JSON file inside [b][font=Courier New]Custom Recipes[/font][/b] folder (e.g. [b][font=Courier New]MyCustomRecipes.json[/font][/b]). |
| 24 | + |
| 25 | +[size=4][b][b]JSON File Structure[/b][/b][/size] |
| 26 | +Inside your new JSON file: |
| 27 | +[code] |
| 28 | +[ |
| 29 | + { |
| 30 | + //Recipe 1 |
| 31 | + }, |
| 32 | + { |
| 33 | + //Recipe 2 |
| 34 | + }, |
| 35 | + { |
| 36 | + //Recipe 3 and so on |
| 37 | + } |
| 38 | +] |
| 39 | +[/code] |
| 40 | +Remember that JSON file doesn't support comments, it is used now just for visualization. |
| 41 | +Also don't forget to remove any trailing commas. |
| 42 | +Basically, your file contain [b]an array of [font=Courier New]CustomRecipe[/font] objects[/b]. |
| 43 | + |
| 44 | +[size=4][b][b][font=Courier New]CustomeRecipe[/font] object[/b][/b][/size] |
| 45 | +[b][font=Courier New]CustomRecipe[/font][/b] contain these properties: |
| 46 | +Key|Requirement|Value|Example|Definition|Default Value |
| 47 | +---|---|---|---|---|--- |
| 48 | +[b][font=Courier New]"CraftCategoryID"[/font][/b]|Required|[b][font=Courier New]CraftCategoryId[/font][/b] or [b][font=Courier New]int[/font][/b]|[b][font=Courier New]"Drug"[/font][/b] or [b][font=Courier New]8[/font][/b]|Recipe's category|None |
| 49 | +[b][font=Courier New]"ResultItemID"[/font][/b]|Required|[b][font=Courier New]ItemID[/font][/b] or [b][font=Courier New]int[/font][/b]|[b][font=Courier New]"Item_Kin"[/font][/b] or [b][font=Courier New]2156[/font][/b]|Result item|None |
| 50 | +[b][font=Courier New]"IngredientItemIDs"[/font][/b]|Required|Array of [b][font=Courier New]ItemID[/font][/b] or [b][font=Courier New]int[/font][/b]|[b][font=Courier New]["Item_Gin", "Item_Gin"][/font][/b] or [b][font=Courier New][2155, 2155][/font][/b]|Item used for recipe, max 6 items|None |
| 51 | +[b][font=Courier New]"RecipeReleaseID"[/font][/b]|Optional|[b][font=Courier New]RecipeRelease[/font][/b] or [b][font=Courier New]int[/font][/b]|[b][font=Courier New]"Recipe_Drag_1_L"[/font][/b] or [b][font=Courier New]149[/font][/b]|Condition for recipe unlocks, recipe always unlocked if not defined|Internally set |
| 52 | +[b][font=Courier New]"SkillLevel"[/font][/b]|Optional|[b][font=Courier New]int[/font][/b]|[b][font=Courier New]25[/font][/b]|Used for RP usage|[b][font=Courier New]5[/font][/b] |
| 53 | +[b][font=Courier New]"SkillUnlockID"[/font][/b]|Optional|[b][font=Courier New]SkillID[/font][/b] or [b][font=Courier New]int[/font][/b]|[b][font=Courier New]"SKILL_MIX"[/font][/b] or [b][font=Courier New]20[/font][/b]|(Currently Unused)|[b][font=Courier New]SKILL_FARM[/font][/b] |
| 54 | +The properties doesn't need to be in order, but Required properties must always exist. |
| 55 | +[url=https://github.com/SinsofSloth/RF5-global-metadata/blob/main/_no_namespace/CraftCategoryId.cs]List of CraftCategoryId values[/url] |
| 56 | +[url=https://docs.google.com/spreadsheets/d/1LFkOEVQuJ-x1Lkn64Lt8Z7NvbVyUgqHP794Ehw3wbts/edit#gid=920483090]List of ItemID values[/url] |
| 57 | +[url=https://docs.google.com/spreadsheets/d/1LFkOEVQuJ-x1Lkn64Lt8Z7NvbVyUgqHP794Ehw3wbts/edit#gid=914955553]List of RecipeRelease values[/url] |
| 58 | + |
| 59 | +[size=4][b][b]Custom JSON file example[/b][/b][/size] |
| 60 | +[code][ |
| 61 | + { |
| 62 | + "CraftCategoryID": "Drug", |
| 63 | + "ResultItemID": "Item_Kin", |
| 64 | + "IngredientItemIDs": [ |
| 65 | + "Item_Gin", |
| 66 | + "Item_Gin" |
| 67 | + ], |
| 68 | + "RecipeReleaseID": "Recipe_Drag_1_L", |
| 69 | + "SkillLevel": 25, |
| 70 | + "SkillUnlockID": "SKILL_MIX" |
| 71 | + }, |
| 72 | + { |
| 73 | + "CraftCategoryID": 8, |
| 74 | + "ResultItemID": 2157, |
| 75 | + "SkillLevel": 25, |
| 76 | + "IngredientItemIDs": [ |
| 77 | + 2156, |
| 78 | + 2156 |
| 79 | + ] |
| 80 | + }, |
| 81 | + { |
| 82 | + "CraftCategoryID": 8, |
| 83 | + "ResultItemID": 2154, |
| 84 | + "IngredientItemIDs": [ |
| 85 | + 2152, |
| 86 | + 2152 |
| 87 | + ] |
| 88 | + } |
| 89 | +] |
| 90 | +[/code] |
| 91 | +First recipe is recipe to create Gold using 2 Silvers, most values are enum string. |
| 92 | +Second recipe is recipe to create Platinum using 2 Golds, all values are int. |
| 93 | +Third recipe is recipe to create Bronze using 2 Irons, created with only the required parameters. |
0 commit comments