MoreVanillaBuildPrefabs
MoreVanillaBuildPrefabs is a Valheim mod to make all vanilla prefabs buildable with the hammer (survival way) while allowing you to configure the requirements to build them.
Acknowledgements
This mod was inspired by MoreVanillaBuilds by Galathil and PotteryBarn by ComfyMods and the core functionality of the code is based on those two mods.
Key Feature
Because all the added build pieces are pre-existing vanilla prefabs, any pieces you build with this mod will persist in your world even if you uninstall the mod. This means that pieces you build on a server will also be visible for players without the mod and any builds using the pieces from this mod will load for players without the mod.
Instructions
If you are using a mod manager for Thunderstore simply install the mod from there and skip to step 3 below.
If you are not using a mod manager then, you need a modded instance of Valheim (BepInEx) and Jötunn plugin installed.
- Download the MoreVanillaBuildPrefabs.dll from the Publish/Thunderstore directory.
- Place the MoreVanillaBuildPrefabs.dll into your BepInEx\plugins folder
- Launch the game and enter a world to generate the configuration files. The plugin searches for prefabs in the game loading screen.
- (Optional) Quit the game. Find the file Searica.Valheim.MoreVanillaBuildPrefabs.cfg in your BepInEx\config folder, open it to customize mod configuration (see Configuration section for details).
- Play the game using the default configuration generated by the mod or your customized one.
Recommended: Install SearsCatalog (https://valheim.thunderstore.io/package/ComfyMods/SearsCatalog/) to extend the hammer build table and allow you to access all the pieces this mod adds even if there are too many added pieces for the vanilla build table.
Update Notice!
When updating to version 0.0.3 the mod will generate a new config file as I have changed the naming scheme to be automatic. Once the new config file generates you can just copy paste the contents of your old config file into the new one if you have customized any of the prefabs. My apologies for the inconvience, future updates will not modify the config file name.
Configuration
You need to edit the configuration file with client/server off! If you use an in-game configuration manager, you need to restart the game/server to apply configuration.
For each detected prefab in the game you can:
- Enable/Disable it from the hammer.
- Define custom recipe to build the prefab in-game.
- Set the required crafting station to build and deconstruct the prefab.
- Set whether the prefab is allowed to be built inside of dungeons.
_Global Section Configuration:
- EnableMod. Default = true.
- Globally enable or disable this mod (restart required).
- forceAllPrefabs. Default = false.
- Setting to true overrides individual configuration for all prefabs and enables them all for building with the hammer.
- verboseMode. Default = false.
- You should keep it to false. This configuration displays debug information in the console (and slows down game performances)
Prefab Configuration Sections:
The rest of the configuration files contains [xxxxxx] sections to configure each prefab. Each section contains:
- isEnable = false
- Change it to true to show the prefab in the hammer. Note that if forceAllPrefabs is set to true, this config is ignored.
- AllowedInDungeons = false
- Whether the piece can be built inside of dungeons, set to true to allow building it in dungeons.
- Category = CreatorShop
- This sets tab the prefab should appear. Vanilla categories are: Misc | Crafting | Building | Furniture. This mod adds a fifth category "CreatorShop", see section on CreatorShop pieces.
- CraftingStation =
- Set the required crafting station. Vanilla crafting station IDs are: piece_workbench | forge | piece_stonecutter | blackforge. Leaving it empty means that it can be built and deconstructed without a crafting station.
- Requirements =
- The resources required to build the prefab. Currently only some prefabs have default resource requirements while the rest require no resources. When entering requirements the format is item_id,amount;item_id,amount. Each requirement contain the item_id and the quantity separated by a comma (,). Each requirement is then separated by a semicolon (;).rated by semicolons. You can find itemID on Valheim Wiki or on this link : https://valheim-modding.github.io/Jotunn/data/objects/item-list.html. For example: requirements = Wood,5;Stone,2 would mean the prefab requires 5 wood and 2 stone to build. Finally, you can technically add an arbitrary number of requirements but the vanilla UI does not show more than 4 of them (at least in the crafting menu).
Default Prefab Configuration
The mod comes with a default configuration that sets the crafting requirements for many of the prefab pieces when generating the configuration file. The defaults also enable a number of pre-configured pieces for building. These configurations are based on my preferences and intended to ensure that someone playing with the mod will only unlock various build pieces after encountering them in the world. The default configuration also means that the mod can simply be installed and used immediately to get a sense of how it works. You are of course able to change these default configurations however you please.
Default Enabled Pieces
Click to see a general list of enabled pieces (contains spoilers.)
- Most black marble pieces used in Dvergr builds.
- All Dvergr furniture.
- Most Dvergr wooden structures.
- Dvergr demisters.
- Various rocks.
- Extra furniture and decorations.
- Turf roofs.
- Statues.
- Wood ledge.
See the PrefabConfig.cs file in the source code for the full default configuration or install the mode and check the generated configuration file.
Implementation Notes
The prefabs enabled by this mod were not necessarily intended to be built by players, so they may lack some of the things required to place them or build them such as proper collision or snap points.
All of the pieces that are enabled by default have been patched to have snap points and fix collision issues to ensure they can be used similarly to existing vanilla pieces. For the prefabs that are not enabled by default, while many of them have been patched not all of them have as the process of patching them is currently entirely manual. This means that if you enable prefabs other than the ones enabled by default there is no guarantee they will behave nicely.
If you are having issues with a prefab you would like to build with but it won't appear when you try to place it the issue is likely due to missing colliders that have not been patched yet. A work around for some prefabs is to install either Snap Points Made Easy by MathiasDecrock or the mod Extra Snap Points Made Easy by Searica (that's me). Both of these mods allow you to manually select the snap points on the piece you are placing and the piece you are snapping to. Manually selecting the snap points can allow you to place a prefab that otherwise does not show up due to missing colliders. Some prefabs used for making dungeons can also behave unexpectedly such as being able to open a door but not close it. If there is piece you would really like to build with that is buggy feel free to open an issue on Github requesting it to be patched (see contributions section).
TLDR: Some prefabs other than the ones enabled by default may be buggy, please adjust your expectations accordingly.
Differences from MoreVanillaBuilds by Galathil
First, MoreVanillaBuilds by Galathil has been archived on Github and has not been updated for Hildir's Request, while this mod was built for Hildir's Request. Second, the code used to allow placing added pieces for MoreVanillaBuilds had the additional effect of bypassing all placement restrictions for all pieces, which meant that it was possible to build pieces in locations that it was not possible to deconstruct them. In contrast, this mod always respect placement restrictions (such as the no build zone at spawn) to prevent issues with being unable to deconstruct pieces by using code based on PotteryBarn.
Deconstructing Pieces
Since this mod adds more prefabs to the hammer, that means you can deconstruct more pieces. As of version 0.0.3, world-generated pieces will only drop their default drops, while player-built pieces will only drop the resources used to build them.
CreatorShop Pieces
Prefabs set to the custom CreatorShop category on the hammer will behave differently than pieces from other categories with respect to deconstructing them.
Specifically, when a piece is set to the CreatorShop category player's can only deconstruct instances of that piece that they have placed themselves. This prevents player's from deconstructing world-generated prefabs like trees while still allowing you to build and deconstruct player-placed trees. If multiple player's have this mod enabled they can still only deconstruct CreatorShop pieces that they have placed themselves.
Known Issues
Placing armor on the Male Armor Stand and Female Armor Stand prefabs have clipping issues where not all of the armor is displayed. I have not been able to fix this as of yet.
Planned Improvements
- Add a configuration option for each prefab that enables a generic collision patch to allow users to possibly fix placing prefabs that have not been custom patched yet.
- Figure out if I can implement server-sync with this mod so configurations can be enforced on servers.
Compatibility
This is a non-exhaustive list.
Incompatible Mods
Likely incompatible with other mods that add Vanilla prefabs to the build hammer unless you disable the prefabs from this mod that overlap with the other one since conflicting build requirements can cause unexpected behavior.
- MoreVanillaBuilds (by Galathil)
- PotteryBarn (by ComfyMods)
Compatible Mods
- AdventureBackpacks (by Vapok)
- Aegir (by blbrdv)
- AAACrafting (by Azumatt)
- AzuCraftyBoxes (by Azumatt)
- AzuMapDetails (by Azumatt)
- AzuAreaRepair (by Azumatt)
- AzuClock (by Azumatt)
- AzuExtendedPlayerInventory (by Azumatt)
- AzuSkillTweaks (by Azumatt)
- Backpacks (by Smoothbrain)
- Better Beehives (by MaxFoxGaming)
- BetterArchery (by ishid4)
- BetterCarts (by TastyChickenLegs)
- BetterPickupNotifications (by Pfhoenix)
- BetterUI Reforged (by the defside)
- BowsBeforeHoes (by Azumatt)
- BuildRestrictionTweaks (any version that is a reupload of Aedenthorn)
- ComforTweaks (by Smoothbrain)
- ComfySigns (by ComfyMods)
- CraftingFilter (by Aedenthorn)
- DeathPinRemoval (by Azumatt)
- DeezMistyBalls (by Azumatt)
- DodgeShortcut Reupload (by NetherCrowCSOLYOO)
- EmoteWheel (by virtuaCode)
- EulersRuler (by ComfyMods)
- Evasion (by Smoothbrain)
- Extra Snap Points Made Easy (by Searica)
- FascinatingCarryWeight (by kangretto)
- FastTeleport (by GemHunter1)
- FastTools (by Crystal)
- Gizmo (by ComfyMods)
- HeyListen (by ComfyMods)
- ImFRIENDLY DAMMIT (by Azumatt)
- Instantly Destroy Boats and Carts (by GoldenRevolver)
- InstantRuneText (by Azumatt)
- MapTeleport (by Numenos)
- Mead Base Icon Fix (by Sulyvana)
- MultiUserChest (by MSchmoecker)
- Minimal UI (by Azumatt)
- NoSmokeStayList (by TastyChickenLegs)
- OdinsFoodBarrels (by OdinPlus)
- PassivePowers (by Smoothbrain)
- Pathfinder (by Crystal)
- Perfect Placement (by Azumatt)
- PlanBuild (by MathiasDecrock)
- PlantEasily (by Advize)
- PlantEverything (by Advize)
- ProfitablePieces (by Azumatt)
- QoLPins (by Tekla)
- Queue Me Maybe (by Azumatt)
- Quick Stack Store Soft Trash Restock (by Goldenrevolver)
- QuickConnect (by bdew)
- QuietyPortals (by Neobotics)
- Ranching (by Smoothbrain)
- RepairAll (by LoadedGun)
- Sailing (by Smoothbrain)
- SearsCatalog (by ComfyMods)
- Server devcommands (by JereKuusela)
- ShieldMeBruh (by Vapok)
- SilenceTameWolfCub (by GetOffMyLawn)
- Snap Points Made Easy (by MathiasDecrock)
- SNEAKer (by black7ar)
- Sorted Menus Cooking Crafting and Skills Menu (by Goldenrevolver)
- SpeedyPaths (by Nextek)
- StackedBars (by Azumatt)
- StaminRegenerationFromFood (by Smoothbrain)
- SuperConfigurablePickupRadius (by TastyChickenLegs)
- TargetPortal (by Smoothbrain)
- ToggleMovementMod (by GetOffMyLawn)
- Veinmine (by WiseHorrer)
- Venture Location Reset (by VentureValheim)
- VikingsDoSwim (by blacks7ar)
- WieldEquipmentWhileSwimming (by blacks7ar)
- Probably even more, it's pretty compatible.
Source Code
Github: https://github.com/searica/MoreVanillaBuildPrefabs
Contributions
You are welcome to open issues on the Github repository to provide suggestions, feature requests, compatibility issues, and bug reports. Over time I will slowly patch more prefabs and hopefully come up with a more generalizable method of patching them, but if you'd really like a specific prefab to work better just open an issue letting me know. I'm a grad student and have a lot of personal responsibilities on top of that so I can't promise I will respond quickly though, but I do intend to maintain and improve the mod in my free time.
