Obenseuer/Modding: Difference between revisions

From Stalburg Wiki
Jump to navigation Jump to search
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
! Name !! Author !! Requires BepInEx !! Type !! Description !! Download
|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]
| 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]
|-
|-
|PowerSourceFix||RobynLlama||✓||Bugfix||Fixes the ability to add fuel to the solid-fuel based furnaces||[https://github.com/ObenseuerModding/PowerSourceFix/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]
|-
|-
|PrisonPackageFix||RobynLlama||✓||Bugfix||Adds a Can Opener to every rations package in prison||[https://github.com/ObenseuerModding/PrisonPackageFix/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]
|-
|-
|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]
| PrisonPackageFix || RobynLlama || ✓ || Bugfix || Adds a Can Opener to every rations package in prison || [https://github.com/ObenseuerModding/PrisonPackageFix/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]
| 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)
Prefab (FurniturePlaceable.cs)
      -> Stuff (components, like the MeshRenderer, of the furniture)
  -> 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)
Preview Prefab
      -> Stuff + Collision (Rigidbody(kinematic), Box Collider(trigger), InsideTrigger.cs)
  -> 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

Revision as of 16:26, 25 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

Mod loader installation

  1. Download the latest stable release of BepInEx - Download BepInEx
  2. 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
  3. Run the Obenseuer game for the mod loader to generate all the needed configuration files
  4. To install new mods, from the root folder of the Obenseuer, navigate to ..\BepInEx\plugins and place the downloaded files there

List of available mods

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

Furnitures are made out of two prefabs, the furniture prefab and the preview prefab.

Furniture prefab

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

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

  • 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
Retrieved from "https://stalburg.net/index.php?title=Obenseuer/Modding&oldid=9364"