ValheimRAFT

This mod aims to continue support for Water based features of the original ValheimRAFT mod and incorporate more vehicle items and mechanics within the mod and further extends its capabilities.

:warning: Warning. If you are reading this readme on the ValheimMods/ValheimRAFT repo :warning:

• There likely will be features listed that do not yet exist within the game.
• Always read the readme from the latest official releases instead
  • thunderstore page Quickest way is to look at the last readme post on thunderstore.
  • Releases Alternatively look at the release source code. TBD this may be made easier.

Background

This repo is a ValheimRaft fork that works with latest Valheim.

The original mod owner Sarcen stopped maintaining the mod August 2023. They gave permission to maintain and open source the mod on 12/25/2023.

Contents

• ValheimRAFT
  • Background
  • Contents
  • Features
  • Community
  • Prefabs
    • Installation Guide
      • Current logos
    • Hull Mechanics
  • Client/Server/SinglePlayer Support
  • Config
  • Issues
  • Mod Support
  • FAQs
    • Help My Raft is A Box
    • Help My Raft Turns into a Box when I load the area
    • Help My Raft went underground
    • Help My Raft Is Sinking When I Build Hulls
    • My Bed does not update
  • Graphics
  • Contributing
  • Maintainers
  • Attribution
  • Support Open Source
  • Logging Metrics
    • What information will be collected

Features

• Build a RAFT on the water using Valheim's building prefabs.
• Adds a climbable ladder
• Add piers that reach the ocean floor (stone and log)
• Adds anchors
• Adds custom sails (requires meshes to be working)
  • Players can add their own patterns to the meshes folder FYI, you can have more than the stack or pirate logo, just add what you want.
• Adds ropes (requires meshes to be working)
• Sails now will each contribute to the total shipShip.Speed. Custom Sails do an area calculation while Tier 1-3 sails are preset values.
• Vehicles can be made to Fly.
• Vehicles can go underwater [>=2.4.0]
• There are tools to hide water. It looks pretty cool, but unrealistic for now

Community

Join us on discord to get the latest information, upcoming features, and discontain other mods.

Discord Link

Prefabs

Name	Icon	Description
Hull (Wood)		V2 Raft Hull. See more info on Hull Mechanics
Hull (Iron)		V2 Raft Hull Iron, See more info on Hull Mechanics
Hull Slab (Wood)		V2 Raft Hull Slab 2x2 and 4x4 variants. See more info on Hull Mechanics
Hull Slab (Iron)		V2 Raft Hull Slab Iron 2x2 and 4x4 variants. See more info on Hull Mechanics.
Hull Wall (Wood)		V2 Raft Hull Wall 2x2 and 4x4 variants. See more info on Hull Mechanics.
Hull Rib Side (Wood) (Iron)		V2 Raft Hull Rib, a curved hull wall going for 0-90 degrees a combo of 3 hull walls. See more info on Hull Mechanics.
Ship Prow (Wood 2x, Wood 4x, Iron 2x, 4x)		Allows for creating a front/back of the ship. Pairing this with a Rib side and a rib corner will seal the ship completely.
Ship Hull-Rib Corner (Wood left & right, Iron left & right)		Allows for sealing a hull for a ship. Useful when adding hull sides and prow pieces to seal a ship from all directions.
Hull Rib (Iron)		V2 Raft Hull Rib, a curved hull wall going for 0-90 degrees a combo of 3 hull walls. See more info on Hull Mechanics.
Rudder Basic		Basic Raft Rudder, turns with wheel. First rudder on ship will also move ship's wake effects to it's location. Future updates may add functionality
Rudder Advanced (Iron)		Advanced Rudder, a larger rudder that turns with the ship. First rudder on ship will also move ship's wake effects to it's location. No other functionality.
Rudder Advanced (Wood)		Advanced Rudder, a larger rudder that turns with the ship. First rudder on ship will also move ship's wake effects to it's location. No other functionality.
Rudder Advanced Twin (Wood)		Advanced Rudder, a larger rudder that turns with the ship. First rudder on ship will also move ship's wake effects to it's location. No other functionality.
Rudder Advanced Twin (Iron)		Advanced Rudder, a larger rudder that turns with the ship. First rudder on ship will also move ship's wake effects to it's location. No other functionality.
Steering Wheel		Steer the vehicle. Steering will be fast on slow speed, medium on half speed, and slow on fast speed. Previously all steering was slow. The direction it faces will determine the direction the boat sails.
Raft Sail		Tier 1 Raft Sail. Offers modest sailing power.
Karve Sail		Tier 2 Karve Sail offers mid-level sailing power.
Viking Sail		Tier 3 Viking Sail offers high-level sailing power.
Drakkal Sail		Tier 4 Drakkal Sail offers high sailing sailing power and looks great.
Custom Sail (3) or (4) corners		Tier 1 Custom Sail, Offers a customizable sail of 3 points or 4 point sails. Each sail cubic foot is counted for sailing force. The sails are a balanced at tier1 sailing.
Rope Anchor		Connect an infinite number of ropes from this anchor point to the target prefab's center position. To disconnect grab a rope from the anchor point and re-attach to the already attached prefab. It should disconnect the rope. Ropes will not have any affect on physics. They do not anchor the ship.
Rope Ladder		Connect a rope ladder to a boat or any building to allow for climbing from the ground up to the building. Will automatically extend to seafloor or ground every couple seconds if the terrain changes.
Boarding Ramp (normal, Wide)		Boarding ramp can extend out from 1 - 50+ units. Each unit adds an additional expanded plank. There are no resource costs to increasing the extension bridge size. Boarding ramps collide with the sea so they will effectively hover over the sea. Ramps require network connection in multiplayer to properly work if the player is not the owner.
Dirt Floor (1x1, 2x2)		Allows for growing vanilla Valheim crops. Currently does not support mods that utilize heightmaps to determine placement. Each dirt section is not a heightmap.
Ram Stake (Wood,Iron) (1x2 2x4)		Allows for ramming ships, destroying rocks, and hitting monsters/characters. Rams impact within an area. A ram stake is better for piercing damage but will not do any slash or hurt trees.
Ram Blade (Iron-Only) (left, right, top, bottom)		Has the largest area of effect hit, will crush rocks and by design is meant to be used as armor to bash and shred enemy ships. This ram is inspired (and part of) the nautilus project
Watermask creator - hides water		Hides water, can be used to see through water from inside and outside. Allows for placing custom cubic shapes and other ships. Ships are generated via a point system each point creates a Bounds and each additional point increases the bounds. Final output is a volume which then is applied to the shape (Cube) or other ones if picked. Cube is only stable one working right now. Place 8 points. To generate the custom water mask

Experimental Prefabs

These prefabs are not fully ready or may be broken into smaller pieces. Please follow the description when using these prefabs and please be mindful that they are only available early so people can test them out and/or have fun with them. They are not meant to be balanced.

Name	Icon	Description
Nautilus		Nautilus is inspired by Jules Verne's 20,000 Leagues Under The Sea. Built with original assets by RacerX and given free to Zolantris on discord. This Prefab has all the meshes from the boat included, but the hatch is pulled back to players can enter the boat. It's not meant for serious play, and the recipe needs to be more balanced + the ship needs to be fully rigged for propulsion (propellers do not move, nor do the fins)

Installation Guide

:warning: The Raft Mod must be installed correctly in order to resolve Custom Sail materials. :warning:

• Folder must be placed within <ValheimGameFolder>/BepInEx/plugins/
• The folder must be named ValheimRAFT or zolantris-ValheimRAFT and contain a Assets folder

Noting that in future updates this may not be required, however loading custom textures will always be supported. This allows players to drag and drop their favorite logos or custom sail textures and see them in game.

Current logos

Name	Image
Stag Logo
Pirate Logo

Hull Mechanics

These mechanics apply only to V2 WaterVehicles. The older V1 rafts will never support this feature.

Every piece of hull added to a ship will adjust the ship's floatation. Floatation is determined by the key HullFloatationColliderLocation.

Client/Server/SinglePlayer Support

Server support may or may not work. In >=1.6.2 ships and loading were mainly fixed by adding some threading optimization. There is also a config called ServerRaftUpdateZoneInterval this allows users to tweak the update frequency of checks.

The following has been tested:

• SinglePlayer
  • boats will load
  • FPS issues with giant ships
• Client only with a server IE (connecting to server without mod),
  • creating a boat and logging on and off the server does not destroy the boat.
  • sailing and teleporting does not destroy the boat.
  • The client will still be able to create items and the server will keep those raft items. (unless you have mods that garbage collect unused ZDOs)
  • restarting/stopping/starting server keeps the boat.
  • Removing the ValheimRAFT mod from the client will make the server glitch out the boat items.
  • joining back (after adding the mod again) will render the items correctly.
  • Loading a ship into view will possibly
• Server & Client
  • Loading a 4500 build plan ship. Traveling around a couple sectors. The ship remained as built.
  • Moving away from the ship until it unloaded. Moving back immediately and attempting to land on the ship while it renders. It works and still loads. Looks a bit funny as it spawns.
    • Warning to anyone that builds property next to a large ship, when it renders it's possible a wave could briefly flip it and the top part of the ship rolls and hits property.

Config

ValheimRAFT has extensive config. If you do not like the current balance, you are capable of editing this config and setting thing the way you like.

Please feel free to share the config if you feel it is more balanced than default. Maintainers will need to test it before accepting it as the default though.

Please download the mod Official BepInEx Configuration Manager to be able to edit ValheimRAFT config while playing. Most of the config can be set while playing.

Excludes

• prefabs
• patches
• zone related content or first render content

There is auto-documentation for this config at this link. Please go here to read up on all the config. config auto-generated document

Commands

ValheimRAFT has many commands. Please read below to see what is possible. All Commands start with vehicle and then have a argument. IE vehicle debug will open some debug menus.

I highly recommend installing Server DevCommands by Jere if you want to get code completion for these scripts. (I believe it's this mod that does this. Also allows flight and other hacks on servers and automating it if you want to debug a build.)

Issues

If you have a bug, please create an issue under the repo's issues section.

• Player.log is required to properly debug many issues. Otherwise, you will not be providing enough information for maintainers to help. Please copy paste the log or /drag drop it into the github issue.
  • Player.log can be found under the User directory's AppData path for valheim (Same location as worldsaves). This path should work if copy pasting into Windows explorer %USERPROFILE%\AppData\LocalLow\IronGate\Valheim\
  • Full path example C:\Users\bob_smith\AppData\LocalLow\IronGate\Valheim\Player.log
    • bob_smith - is the example username.
    • Use the %USERPROFILE% to skip having to add your username or drive path before it. (more detailed)
• Please respect the form. Adding the relevant information makes it easier to triage the problem.

Click here to create an issue now.

Mod Support

In 1.6.0+ this mod supports PlanBuild a popular blueprinting mod.

Support is added via a patch that makes PlanBuild use the Raft localPosition instead of world position which each item could be moving/swaying and updating as the PlanBuild iterated through the items. This easily breaks the Plan save.

• Hopefully this logic can be incorporated within PlanBuild directly. There is a config toggle to turn this patch off to future-proof things.
• Alternative approaches for this could be doing a detection if the game object is attached to a parent object and calculating coordinates of the items after all object positions have been fetched.

Noting that Planbuild does not register well with harmony so searching for it is not possible (from what I saw). There is a path resolution and a config flag to enable coordinate fixes. Disable the config value fixPlanBuildPositionIssues and it should no longer cause errors for not having PlanBuild installed.

FAQs

Please read these if you are experiencing trouble.

Help My Raft is A Box

1. Did you install the ValheimRAFT mod correctly?
   • No? Install it correctly following this guide, otherwise the commands may not work or sails will not be generated.
2. Did you upgrade from v1.x.x to >=v2.0.0?
   • Run vehicle recover this command works in >=2.0.2
   • v2.0.0 had to make a plugin GUID change which likely broke the prefab registry of the v1 raft. This GUID change was in order to reset older mods from pointing to the updated ValheimRAFT and breaking features.
3. Are you manually installing?
   • A: Yes? Don't do it.
     • Install r2modman and have it manage your mods. This prevent a bunch of installation problems with raft and other mods especially as valheim updates.
     • https://thunderstore.io/package/ebkr/r2modman/
   • No: Good Job, debugging the problem should be as simple as unchecking your mods, automatically updating things, and editing your configs.
4. Did you install a mod that is crashing the bepinex plugins?
   • Try to remove mods that are older. Many mods are not meant to endure updates from valheim and need a fix to make their code stable again. Disable all older mods and only include ValheimRAFT, Jotunn, and BepInEx.
5. Did you install a mod that overrides ValheimRAFT code?
   • Mods that override Player.PlacePiece will cause problems with piece placement.
     • Example Gizmos overrides the rotations and angles of pieces so it is not compatible for a boat in motion. Use vehicle creative or raftcreative to make the ship stop moving and place pieces.
   • Mods that override Player.GetControlledShip will cause the boat to be unable to interact or update hud or be controlled.
   • Mods that adjust or change Ship Values from Valheim will no longer affect the V2 WaterVehicle. This means the Vehicle is much more resilient and more compatible with mods that add new ships but also means it has it's own logic so the ship will not benefit OR break from those mods.

Help My Raft Turns into a Box when I load the area

1. Are you on a dedicated server?
   • No? Switch to a dedicated server. The raft mod may not be stable when hosting from a LAN IP. This likely was fixed in >=2.0.0. But will continue to be an issue if you are using a v1 raft.
   • No, But I'm on single player...
     • Submit a bug report. Single player should render correctly. If you only have ValheimRAFT + Jotunn and absolutely trust your mod list.

Help My Raft went underground

• For now there is no command to save your raft.

1. Download Unity Explorer

2. Under Object list search for WaterVehicleShip it should show up as ValheimVehicles_WaterVehicleShip

• ValheimVehicles is a prefix for anything related to V2 RAFT/Vehicles mod.
• If you see multiple ships, make sure you click the green box to Enable/disable them to confirm you are changing the correct ship.

1. Change the height of the vehicle by clicking on the Object and within inspector - another pannel, click on local position and change the Y coordinate to +20 height or more.
   • Make sure you never change the x or z positions otherwise the boat might be removed from rendering and be sent to the other side of the world.
   • Example Position 1600.084 29.7749 1685.39 Set to 1600.084 50 1685.39

Help My Raft Is Sinking When I Build Hulls

1. Please read the guide on Vehicle Hulls? Each Hull affects the floatation of the vehicle.
2. Select the correct config and add or remove a piece to see the ship update based on the new config value.

My Bed does not update

This is a known issue do the following work-around.

• Every time the raft is moved and then stopped. Rebuild your bed and then set your spawn again.

This may be resolved in future updates.

Graphics

This project supports both Vulkan and Direct3D11 as of >=1.6.11. Previously it only supported Direct3D11.

Contributing

1. Please fork the codebase and make a pull request via your fork branch.
2. Changes need to be feature based IE keep the changes minimal and single focused. Larger changes are welcome, but they have higher chance of breaking other things and are harder to maintain.
3. If you want to directly get involved. Reach out on discord.
4. Please read the Contributing.md document for more information

Maintainers

Attribution

Support Open Source

Videos and Promos

• 2.4.0 ValheimRAFT Water overhaul nautilus
• 2.4.0 ValheimRAFT Water overhaul demo

Logging Metrics

NOT APPLICABLE YET.

These packages may contain logging. Logging can be opted out by any user by unchecking enableMetrics. If you choose to opt-out, please be aware, this will make it more difficult to troubleshoot issues.

• Logging does not do anything without a SentryUnityPlugin package that has not been made available to the community (yet). In future updates Sentry logging will be recommended to beta testing players so benchmarks can be collected related to Vehicle performance.

What information will be collected

• Paths related to Valheim Game directory
• Paths related to ValheimRAFT / ValheimVehicles plugin directory such as symlinked directories from vortex mod installer or directories created by r2modman or thunderstore.
• Health related to the ValheimRAFT mod. It will track performance, slowdowns, and bottlenecks making it significantly easier to debug.

This logging has yet to be implemented.