Obenseuer/Modding: Difference between revisions

(25 intermediate revisions by 6 users not shown)

Line 1:

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 library, the [https://github.com/leonarudo/Lavender Lavender] created by leonarudo, is 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]''

==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

* Download unstripped assemblies - ''[https://unity.bepinex.dev/corlibs/2019.4.40.zip Download Core Files]'' · ''[https://unity.bepinex.dev/libraries/2019.4.40.zip Download Libraries]''

# Run the Obenseuer game for the mod loader to generate all the needed configuration files

* 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

# To install new mods, from the root folder of the Obenseuer, navigate to <code>..\BepInEx\plugins</code> and place the downloaded files there

* 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

==Adding new furniture==

== List of available mods ==

{| class="wikitable"

|-

! Name !! Author !! Requires BepInEx !! Type !! Description !! Download

|-

| Lavender

| style="width: 9%;" | leonarudo

| style="width: 0;" | ✓ || Library || Easier addition of new furniture, new items, new recipes, console commands and runtime loader for .OBJ and .PNG/.JPG files

| style="width: 10%;" | [https://github.com/leonarudo/Lavender/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 || '''Outdated:''' Allows to extract yeast in larger quantities of 5L, 10L and 20L ''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 and Cats, adds recipes to craft Vinegar and Hot Chocolate ''Requires '''Lavender''' library'' || [https://github.com/hiemas-lerastad/OS-MoreCookingRecipes/releases On GitHub]

|-

| Stubo's Always Show Needs || StuboUK || ✓ || Mod || Shows the character needs all the time regardless of their percentage || [https://github.com/StuboUK/os-StubosAlwaysShowNeeds/releases On GitHub]

|-

| Stubo's Show XP Gain || StuboUK || ✓ || Mod || Shows the skill experience gain notification every time player receives some || [https://github.com/StuboUK/os-StubosShowXPGain/releases On GitHub]

|-

| SnippitySnappity || shiggityshaggs || ✓ || Mod || Adds furniture snapping functionality to all furniture and removes building restrictions || [https://github.com/shiggityshaggs/ObenseuerSnippitySnappity/releases On GitHub]

|-

| Fix My Choo || norbby42 || ✓ || Fix || When a minitrain is deleted during Tenement Mine Depo renovation, it will be respawned in its original location and still work || [https://github.com/norbby42/FixMyChoo/releases On GitHub]

|-

| DirectUse || shiggityshaggs || ✓ || Mod || Allows to interact with consumable items directly in-the-world by pressing {{ButtonRM}} button, and drink from fluid containers

| [https://github.com/shiggityshaggs/ObenseuerDirectUse/releases On GitHub]

|-

| TaskFix || shiggityshaggs || ✓ || Fix || Fixes the renovations being unavailable to complete after save migration between different versions || [https://github.com/shiggityshaggs/ObenseuerTaskFix/releases On GitHub]

|-

| Smuggler's Pack || norbby42 || ✓ || Mod || Adds a Smuggler's Pack Insert item that once crafted, can be placed in the last slot of any backpack to turn the bottom item row into a hidden pocket for storage of stolen items that police cannot look into ''Requires '''Lavender''' library'' || [https://github.com/norbby42/SmugglersPack/releases On GitHub]

|-

| ConfigurableItemDespawn || norbby42 || ✓ || Mod || Allows to change, via a configuration file, how long items dropped onto the ground will stay before disappearing || [https://github.com/norbby42/ConfigurableItemDespawn/releases On GitHub]

|-

| Webinator || shiggityshaggs || ✓ || Mod || Removes spider webs from the world || [https://github.com/shiggityshaggs/ObenseuerWebinator/releases On GitHub]

|-

| Toy Need || Poppie360 || ✓ || Mod || Overhauls the Duck Addiction into a Joy Obsession which uses any toy-like items to satisfy the joy need, including plushies, minitrain miniatures and metal ducks, each with different strenght of effects. Player character gets bored of the same toys over time and variety helps. || [https://www.nexusmods.com/obeseuer/mods/8?tab=files On Nexus Mods]

|-

| MinitrainHobbyist || norbby42 || ✓ || Mod || Adds ability to study Minitrain Miniatures to create your own replicas, that can be sold to Mikkel Purola. ''Requires '''Lavender''' library'' || [https://github.com/norbby42/MinitrainHobbyist/releases On GitHub]

|-

| RecipeHacker-0-4-17 || norbby42 || ✓ || Mod || A bugfix for the 0.4.17 version of Obenseuer that adds a way of obtaining recipes that are otherwise unobtainable. ''Requires '''Lavender''' library'' || [https://github.com/norbby42/RecipeHacker-0-4-17 On GitHub]

|-

| ObenCursor || shiggityshaggs || ✓ || Mod || Makes the mouse cursor retain a high visibility against the background. Allows to use a custom cursor image by replacing default.png or cursor.png in the mod files. || [https://github.com/shiggityshaggs/ObenCursor/releases On GitHub]

|}

== For modders ==

=== Adding new furniture ===

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>.

Component structure:

<~~code~~>

<pre>

Prefab (FurniturePlaceable.cs)

<

-> rotate (empty object)

Prefab (FurniturePlaceable.cs)

-> Stuff (components, like the MeshRenderer, of the furniture)

-> rotate (empty object)

</~~code~~>

-> 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>.

Component structure:

<~~code~~>

<pre>

Preview Prefab

<

-> rotate (ObjectPreview.cs)

Preview Prefab

-> Stuff + Collision (Rigidbody(kinematic), Box Collider(trigger), InsideTrigger.cs)

-> rotate (ObjectPreview.cs)

</~~code~~>

-> Stuff + Collision (Rigidbody(kinematic), Box Collider(trigger), InsideTrigger.cs)

</pre>

==~~Layers~~==

=== Rendering layers ===

* Layer 08: IgnoreCamera

* Layer 09: Ragdoll

Line 56:

Line 101:

* Layer 25: PlayerClip

=== ID Allocations ===

Item and Recipes are identified via integer values. This, unfortunately, means that conflicts between mods are possible if we (as a community) do not communicate and document which mod(ders) use which ID regions.

When a modder starts creating items or recipes for a published mod, please update this table and reserve yourself a free ID range:

{| class="wikitable"

|+

!Modder

!Item ID Range

!Recipe ID Range

!Active

!Notes

|-

|hiemas-lerastad

|30000-39999

|Yes

|

|-

|hiemas-lerastad

| -

|100001-100003

|??

|Mass Yeast Extraction

|-

|norbby42 (Quackers)

|400000-409999

|Yes

|

|-

|cellizel (Chicken Deli Man)

|122000-126000

|Yes

|C-Coffee Mod

|}

[[Category:Community Content]]

@@ Line 1: / Line 1: @@
-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.
+{{breadcrumb}}
+Custom Unity files for [[Obenseuer]] can be loaded using the [https://github.com/BepInEx/BepInEx BepInEx]. Additional modding library, the [https://github.com/leonarudo/Lavender Lavender] created by leonarudo, is 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]''
-==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
-* Download unstripped assemblies - ''[https://unity.bepinex.dev/corlibs/2019.4.40.zip Download Core Files]'' · ''[https://unity.bepinex.dev/libraries/2019.4.40.zip Download Libraries]''
+# Run the Obenseuer game for the mod loader to generate all the needed configuration files
-* 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
+# To install new mods, from the root folder of the Obenseuer, navigate to <code>..\BepInEx\plugins</code> and place the downloaded files there
-* 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
-==Adding new furniture==
+== List of available mods ==
+{| class="wikitable"
+|-
+! Name !! Author !! Requires BepInEx !! Type !! Description !! Download
+|-
+| Lavender
+| style="width: 9%;" | leonarudo
+| style="width: 0;" | ✓ || Library || Easier addition of new furniture, new items, new recipes, console commands and runtime loader for .OBJ and .PNG/.JPG files
+| style="width: 10%;" | [https://github.com/leonarudo/Lavender/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 || '''Outdated:''' 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 and Cats, adds recipes to craft Vinegar and Hot Chocolate<br>''Requires '''Lavender''' library'' || [https://github.com/hiemas-lerastad/OS-MoreCookingRecipes/releases On GitHub]
+|-
+| Stubo's Always Show Needs || StuboUK || ✓ || Mod || Shows the character needs all the time regardless of their percentage || [https://github.com/StuboUK/os-StubosAlwaysShowNeeds/releases On GitHub]
+|-
+| Stubo's Show XP Gain || StuboUK || ✓ || Mod || Shows the skill experience gain notification every time player receives some || [https://github.com/StuboUK/os-StubosShowXPGain/releases On GitHub]
+|-
+| SnippitySnappity || shiggityshaggs || ✓ || Mod || Adds furniture snapping functionality to all furniture and removes building restrictions || [https://github.com/shiggityshaggs/ObenseuerSnippitySnappity/releases On GitHub]
+|-
+| Fix My Choo || norbby42 || ✓ || Fix || When a minitrain is deleted during Tenement Mine Depo renovation, it will be respawned in its original location and still work || [https://github.com/norbby42/FixMyChoo/releases On GitHub]
+|-
+| DirectUse || shiggityshaggs || ✓ || Mod || <p>Allows to interact with consumable items directly in-the-world by pressing {{ButtonRM}} button, and drink from fluid containers</p>
+| [https://github.com/shiggityshaggs/ObenseuerDirectUse/releases On GitHub]
+|-
+| TaskFix || shiggityshaggs || ✓ || Fix || Fixes the renovations being unavailable to complete after save migration between different versions || [https://github.com/shiggityshaggs/ObenseuerTaskFix/releases On GitHub]
+|-
+| Smuggler's Pack || norbby42 || ✓ || Mod || Adds a Smuggler's Pack Insert item that once crafted, can be placed in the last slot of any backpack to turn the bottom item row into a hidden pocket for storage of stolen items that police cannot look into<br>''Requires '''Lavender''' library'' || [https://github.com/norbby42/SmugglersPack/releases On GitHub]
+|-
+| ConfigurableItemDespawn || norbby42 || ✓ || Mod || Allows to change, via a configuration file, how long items dropped onto the ground will stay before disappearing || [https://github.com/norbby42/ConfigurableItemDespawn/releases On GitHub]
+|-
+| Webinator || shiggityshaggs || ✓ || Mod || Removes spider webs from the world || [https://github.com/shiggityshaggs/ObenseuerWebinator/releases On GitHub]
+|-
+| Toy Need || Poppie360 || ✓ || Mod || Overhauls the Duck Addiction into a Joy Obsession which uses any toy-like items to satisfy the joy need, including plushies, minitrain miniatures and metal ducks, each with different strenght of effects. Player character gets bored of the same toys over time and variety helps. || [https://www.nexusmods.com/obeseuer/mods/8?tab=files On Nexus Mods]
+|-
+| MinitrainHobbyist || norbby42 || ✓ || Mod || Adds ability to study Minitrain Miniatures to create your own replicas, that can be sold to Mikkel Purola.<br>''Requires '''Lavender''' library'' || [https://github.com/norbby42/MinitrainHobbyist/releases On GitHub]
+|-
+| RecipeHacker-0-4-17 || norbby42 || ✓ || Mod || A bugfix for the 0.4.17 version of Obenseuer that adds a way of obtaining recipes that are otherwise unobtainable.<br>''Requires '''Lavender''' library'' || [https://github.com/norbby42/RecipeHacker-0-4-17 On GitHub]
+|-
+| ObenCursor || shiggityshaggs || ✓ || Mod || Makes the mouse cursor retain a high visibility against the background. Allows to use a custom cursor image by replacing default.png or cursor.png in the mod files. || [https://github.com/shiggityshaggs/ObenCursor/releases On GitHub]
+|}
+== For modders ==
+=== Adding new furniture ===
 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>.
 Component structure:
- <code>
+<pre>
- Prefab (FurniturePlaceable.cs)
+<
-   -> rotate (empty object)
+Prefab (FurniturePlaceable.cs)
-      -> Stuff (components, like the MeshRenderer, of the furniture)
+  -> rotate (empty object)
- </code>
+     -> 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>.
 Component structure:
- <code>
+<pre>
- Preview Prefab
+<
-   -> rotate (ObjectPreview.cs)
+Preview Prefab
-      -> Stuff + Collision (Rigidbody(kinematic), Box Collider(trigger), InsideTrigger.cs)
+  -> rotate (ObjectPreview.cs)
- </code>
+     -> Stuff + Collision (Rigidbody(kinematic), Box Collider(trigger), InsideTrigger.cs)
+</pre>
-==Layers==
+=== Rendering layers ===
 * Layer 08: IgnoreCamera
 * Layer 09: Ragdoll
@@ Line 56: / Line 101: @@
 * Layer 25: PlayerClip
+=== ID Allocations ===
+Item and Recipes are identified via integer values.  This, unfortunately, means that conflicts between mods are possible if we (as a community) do not communicate and document which mod(ders) use which ID regions.
+When a modder starts creating items or recipes for a published mod, please update this table and reserve yourself a free ID range:
+{| class="wikitable"
+|+
+!Modder
+!Item ID Range
+!Recipe ID Range
+!Active
+!Notes
+|-
+|hiemas-lerastad
+|30000-39999
+|30000-39999
+|Yes
+|
+|-
+|hiemas-lerastad
+| -
+|100001-100003
+|??
+|Mass Yeast Extraction
+|-
+|norbby42 (Quackers)
+|400000-409999
+|400000-409999
+|Yes
+|
+|-
+|cellizel (Chicken Deli Man)
+|122000-126000
+|122000-126000
+|Yes
+|C-Coffee Mod
+|}
 [[Category:Community Content]]