Obenseuer/Modding: Difference between revisions
m Mod loader installation update for new branches |
mNo edit summary |
||
| Line 1: | Line 1: | ||
{{breadcrumb}} | |||
Custom Unity files for [[Obenseuer]] can be loaded using the [https://github.com/BepInEx/BepInEx BepInEx]. Additional modding libraries, the [https://github.com/leonarudo/Lavender Lavender] created by leonarudo and the [https://github.com/ObenseuerModding/GreenMushLib GreenMushLib] created by RobynLlama, are also available. | Custom Unity files for [[Obenseuer]] can be loaded using the [https://github.com/BepInEx/BepInEx BepInEx]. Additional modding libraries, the [https://github.com/leonarudo/Lavender Lavender] created by leonarudo and the [https://github.com/ObenseuerModding/GreenMushLib GreenMushLib] created by RobynLlama, are also available. | ||
''A more detailed modding documentation can be [https://obenseuermodding.github.io/Information/ found here]'' and the needed resources ''[https://github.com/ObenseuerModding found here]'' | ''A more detailed modding documentation can be [https://obenseuermodding.github.io/Information/ found here]'' and the needed resources ''[https://github.com/ObenseuerModding found here]'' | ||
==Getting started== | == Getting started == | ||
===Mod loader installation=== | === Mod loader installation === | ||
# Download the latest stable release of BepInEx - ''[https://github.com/BepInEx/BepInEx/releases/tag/v5.4.23.2 Download BepInEx]'' | # Download the latest stable release of BepInEx - ''[https://github.com/BepInEx/BepInEx/releases/tag/v5.4.23.2 Download BepInEx]'' | ||
# On Steam, open game properties of Obenseuer and navigate to '''Local Files''' and '''Browse them'''. Extract files from the downloaded .ZIP archive into the root folder of the Obenseuer you have just opened | # On Steam, open game properties of Obenseuer and navigate to '''Local Files''' and '''Browse them'''. Extract files from the downloaded .ZIP archive into the root folder of the Obenseuer you have just opened | ||
| Line 10: | Line 11: | ||
# To install new mods, from the root folder of the Obenseuer, navigate to <code>..\BepInEx\plugins</code> and place the downloaded files there | # To install new mods, from the root folder of the Obenseuer, navigate to <code>..\BepInEx\plugins</code> and place the downloaded files there | ||
==List of available mods== | == List of available mods == | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
! Name !! Author !! Requires BepInEx !! Type !! Description !! Download | |||
|- | |- | ||
| | | GreenMushLib | ||
| style="width: 9%;" | RobynLlama | |||
| style="width: 0;" | ✓ || Library || Has prefab manager and command manager | |||
| style="width: 9%;" | [https://github.com/ObenseuerModding/GreenMushLib/releases On GitHub] | |||
|- | |- | ||
| | | Lavender || leonarudo || ✓ || Library || Easier addition of new furniture, runtime loader for .OBJ and .PNG/.JPG files || [https://github.com/leonarudo/Lavender/releases On GitHub] | ||
|- | |- | ||
| | | PowerSourceFix || RobynLlama || ✓ || Bugfix || Fixes the ability to add fuel to the solid-fuel based furnaces || [https://github.com/ObenseuerModding/PowerSourceFix/releases On GitHub] | ||
|- | |- | ||
| | | PrisonPackageFix || RobynLlama || ✓ || Bugfix || Adds a Can Opener to every rations package in prison || [https://github.com/ObenseuerModding/PrisonPackageFix/releases On GitHub] | ||
|- | |- | ||
| | | Skill Craft Speed || hiemas-lerastad || ✓ || Mod || Shortens the crafting time based on how high the player's skill is || [https://github.com/hiemas-lerastad/OS-SkillCraftSpeed/releases On GitHub] | ||
|- | |- | ||
||More Cooking Recipes||hiemas-lerastad||✓||Mod||Adds a production chain for Cheese, allows to obtain Milk from Rats, adds recipes to craft Hot Dog Buns and Hamburger Buns<br>''Requires '''Lavender''' library''||[https://github.com/hiemas-lerastad/OS-MoreCookingRecipes/releases On GitHub] | | Mass Yeast Extraction || hiemas-lerastad || ✓ || Mod || Allows to extract yeast in larger quantities of 5L, 10L and 20L<br>''Requires '''Lavender''' library'' || [https://github.com/hiemas-lerastad/OS-MassYeastExtraction/releases On GitHub] | ||
|- | |||
| More Cooking Recipes || hiemas-lerastad || ✓ || Mod || Adds a production chain for Cheese, allows to obtain Milk from Rats, adds recipes to craft Hot Dog Buns and Hamburger Buns<br>''Requires '''Lavender''' library'' || [https://github.com/hiemas-lerastad/OS-MoreCookingRecipes/releases On GitHub] | |||
|} | |} | ||
==Adding new furniture== | == Adding new furniture == | ||
Furnitures are made out of two prefabs, the furniture prefab and the preview prefab. | Furnitures are made out of two prefabs, the furniture prefab and the preview prefab. | ||
===Furniture prefab=== | === Furniture prefab === | ||
Rendered on user layer <code>12</code>, named as <code>Placeable</code>. | Rendered on user layer <code>12</code>, named as <code>Placeable</code>. | ||
Component structure: | Component structure: | ||
<pre> | |||
< | |||
Prefab (FurniturePlaceable.cs) | |||
-> rotate (empty object) | |||
-> Stuff (components, like the MeshRenderer, of the furniture) | |||
</pre> | |||
===Preview prefab=== | === Preview prefab === | ||
Rendered on user layer <code>11</code>, named as <code>ItemPreview</code>. | Rendered on user layer <code>11</code>, named as <code>ItemPreview</code>. | ||
Component structure: | Component structure: | ||
<pre> | |||
< | |||
Preview Prefab | |||
-> rotate (ObjectPreview.cs) | |||
-> Stuff + Collision (Rigidbody(kinematic), Box Collider(trigger), InsideTrigger.cs) | |||
</pre> | |||
==Layers== | == Layers == | ||
* Layer 08: IgnoreCamera | * Layer 08: IgnoreCamera | ||
* Layer 09: Ragdoll | * Layer 09: Ragdoll | ||