Obenseuer/Modding: Difference between revisions
Jump to navigation
Jump to search
| (One intermediate revision by one other user not shown) | |||
| Line 5: | Line 5: | ||
==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]'' | |||
# 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 | |||
# Download unstripped assemblies '''<u>(Skip steps 3, 4 and 5 if you are on the public playtesting branch!)</u>''' - ''[https://unity.bepinex.dev/corlibs/2019.4.40.zip Download Core Files]'' · ''[https://unity.bepinex.dev/libraries/2019.4.40.zip Download Libraries]'' | |||
# Inside the root folder of the Obenseuer, create a new folder called <code>unstripped</code> and extract files from both the downloaded .ZIP archives into that <code>unstripped</code> folder | |||
# Inside the root folder of the Obenseuer, open the file called <code>doorstop_config.ini</code> to edit it and find the <code>find dll_search_path_override = </code> property, change that property to <code>find dll_search_path_override = unstripped</code> | |||
# Run the Obenseuer game for the mod loader to generate all the needed configuration files | |||
# 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== | ||
| Line 17: | Line 17: | ||
!Name!!Author!!Requires BepInEx!!Type!!Description!!Download | !Name!!Author!!Requires BepInEx!!Type!!Description!!Download | ||
|- | |- | ||
|GreenMushLib||RobynLlama||✓||Library||Has prefab manager and command manager||[https://github.com/ObenseuerModding/GreenMushLib/releases On GitHub] | |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] | |Lavender||leonarudo||✓||Library||Easier addition of new furniture, runtime loader for .OBJ and .PNG/.JPG files||[https://github.com/leonarudo/Lavender/releases On GitHub] | ||
| Line 27: | Line 30: | ||
|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] | |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] | ||
|- | |- | ||
|Mass Yeast Extraction||hiemas-lerastad||✓||Mod||Allows to extract yeast in larger quantities of 5L, 10L and 20L||[https://github.com/hiemas-lerastad/OS-MassYeastExtraction/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||[https://github.com/hiemas-lerastad/OS-MoreCookingRecipes/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] | ||
|} | |} | ||
| Line 39: | Line 42: | ||
Component structure: | Component structure: | ||
< | < | ||
Prefab (FurniturePlaceable.cs) | Prefab (FurniturePlaceable.cs) | ||
-> rotate (empty object) | -> rotate (empty object) | ||
| Line 49: | Line 52: | ||
Component structure: | Component structure: | ||
< | < | ||
Preview Prefab | Preview Prefab | ||
-> rotate (ObjectPreview.cs) | -> rotate (ObjectPreview.cs) | ||
Latest revision as of 19:36, 4 January 2025
Custom Unity files for Obenseuer can be loaded using the BepInEx. Additional modding libraries, the Lavender created by leonarudo and the GreenMushLib created by RobynLlama, are also available.
A more detailed modding documentation can be found here and the needed resources found here
Getting started[edit | edit source]
Mod loader installation[edit | edit source]
- Download the latest stable release of BepInEx - 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
- Download unstripped assemblies (Skip steps 3, 4 and 5 if you are on the public playtesting branch!) - Download Core Files · Download Libraries
- Inside the root folder of the Obenseuer, create a new folder called
unstrippedand extract files from both the downloaded .ZIP archives into thatunstrippedfolder - Inside the root folder of the Obenseuer, open the file called
doorstop_config.inito edit it and find thefind dll_search_path_override =property, change that property tofind dll_search_path_override = unstripped - Run the Obenseuer game for the mod loader to generate all the needed configuration files
- To install new mods, from the root folder of the Obenseuer, navigate to
..\BepInEx\pluginsand place the downloaded files there
List of available mods[edit | edit source]
| Name | Author | Requires BepInEx | Type | Description | Download |
|---|---|---|---|---|---|
| GreenMushLib | RobynLlama | ✓ | Library | Has prefab manager and command manager | On GitHub |
| Lavender | leonarudo | ✓ | Library | Easier addition of new furniture, runtime loader for .OBJ and .PNG/.JPG files | On GitHub |
| PowerSourceFix | RobynLlama | ✓ | Bugfix | Fixes the ability to add fuel to the solid-fuel based furnaces | On GitHub |
| PrisonPackageFix | RobynLlama | ✓ | Bugfix | Adds a Can Opener to every rations package in prison | On GitHub |
| Skill Craft Speed | hiemas-lerastad | ✓ | Mod | Shortens the crafting time based on how high the player's skill is | On GitHub |
| Mass Yeast Extraction | hiemas-lerastad | ✓ | Mod | Allows to extract yeast in larger quantities of 5L, 10L and 20L Requires Lavender library |
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 Requires Lavender library |
On GitHub |
Adding new furniture[edit | edit source]
Furnitures are made out of two prefabs, the furniture prefab and the preview prefab.
Furniture prefab[edit | edit source]
Rendered on user layer 12, named as Placeable.
Component structure:
<
Prefab (FurniturePlaceable.cs)
-> rotate (empty object)
-> Stuff (components, like the MeshRenderer, of the furniture)
Preview prefab[edit | edit source]
Rendered on user layer 11, named as ItemPreview.
Component structure:
<
Preview Prefab
-> rotate (ObjectPreview.cs)
-> Stuff + Collision (Rigidbody(kinematic), Box Collider(trigger), InsideTrigger.cs)
Layers[edit | edit source]
- Layer 08: IgnoreCamera
- Layer 09: Ragdoll
- Layer 10: Player
- Layer 11: ItemPreview
- Layer 12: Placeable
- Layer 13: Wall
- Layer 14: NotWalkableSurfaceAI
- Layer 15: NPC
- Layer 16: OnlyWorldCollision
- Layer 17: Usable
- Layer 18: PostProcessing
- Layer 19: PostProcessingWasteland
- Layer 20: 3DSkybox
- Layer 21: UI
- Layer 22: DontHideFirstPerson
- Layer 23: UsableStatic
- Layer 24: FirstPerson
- Layer 25: PlayerClip