You are viewing a potentially older version of this package. View Latest Version

Install with App

Date Uploaded

2 weeks ago

Downloads

1.7K

Size

5.2MB

Download

Details Required (1)Versions

EnhancedValheimVRM

This mod requires BepInEx to be installed.

This mod is actively developed and maintained. If you need help, want to request a feature, or found a bug; Head on over to the discord.

Notes

If the model has MToon shaders you should not have ssao on, this is true even if you do not have MToon stuff enabled in the settings. You can set AttemptTextureFix to true, it will convert shaders to standard at game runtime.

How to install

Download the latest release and extract it. There will be a folder called release, copy the folders inside (BepInEx,valheim_Data) into your valheim install directory. The folders are set up to put the files where they need to go.

First time install

make sure to copy / rename all files that end with .example into the correct corresponding file. E.G.
settings____Default.txt.example -> settings____Default.txt.

Settings File

The name of the character in the game needs to correspond to a VRM and settings file like so.

Character: Midnight Nova
Settings File: settings_Midnight Nova.txt
VRM: Midnight Nova.vrm

Default Settings and avatar for people you do not have custom stuff for.

Settings File: settings____Default.txt
VRM: ___Default.vrm

NOTE: settings____Default.txt has 4 underscores, and ___Default.vrm has 3.

Whats in the settings file

settings_Example.txt.example has everything with comments, but the short version.

ModelScale, ModelBrightness, UseMToonShader, AttemptTextureFix, EnablePlayerFade, FixCameraHeight
the model stuff. AttemptTextureFix converts the textures to the games shader so it gets lit like everything else (and ssao works).
ShaderForTextureFix picks the game shader it converts to, player (default, the normal character shader) or creature (the animal shader).
TextureFixEmission (0 to 1) makes the avatar glow a bit with its own colors so it does not go black in shadow. only works with creature. 0.15 default.
RightHandItemPos / LeftHandItemPos / RightHandBackItemPos / LeftHandBackItemPos and the matching *Rot ones
nudge where weapons sit. Pos is in meters along the sockets axes and scales with the avatar height, Rot is euler degrees.
weapon lines, see the next section.
HelmetVisible, HelmetScale, HelmetOffset
vanilla helmet on or off and where it sits.
ChestVisible, ShouldersVisible, UtilityVisible, LegsVisible
show the vanilla armor on top of the vrm. off by default because it usually looks wrong.
SpringBoneStiffness, SpringBoneGravityPower
multipliers on what the vrm author set. 1.0 = leave it alone.
InteractionDistanceScale
how far you can reach, small avatars might want a bit more.
AllowShare
false means other people do not get your avatar. you still get theirs.

Moving specific weapons

The Pos/Rot lines above move everything in a slot. If only one kind of weapon sits wrong you add a line for it, as many lines as you want.
The number is <left/right, up/down, forward/back> in meters (0.02 = 2cm), Rot is degrees.

all bows on your back, move up 2cm

BowPos=<0, 0.02, 0>

all bows on your back, tilt 15 degrees

BowRot=<0, 0, 15>

just one bow. put the items name in front of the number. this one wins over the plain Bow line for that bow.

BowPos=BowDraugrFang,<0, 0.03, 0>

weapon while you are holding it. put Hand in the key.

SwordHandPos=<0, -0.01, 0>
KnifeHandRot=<0, 10, 0>
AxeHandPos=AxeBlackMetal,<0.01, 0, 0>

the words you can use in front of Pos/Rot/HandPos/HandRot:

Bow Crossbow Sword Knife Club Axe Spear Polearm Staff Shield Tool Pickaxe Torch Fist

Mace works for Club, Atgeir for Polearm, Hammer for Tool, Dagger for Knife.
Item names are in WEAPONS.md, sorted by class, together with the few rigged weapons these lines can not move.
Turn on /vrm settings auto on, save the file, and the weapon moves while you look at it.

Sizing is automatic, it measures the avatar head to feet and shoulder to shoulder and sizes the collider off that.
/vrm settings reload in chat reloads the file while in game. if the reload fails you keep the old avatar.
/vrm settings auto on watches the settings and outfit files and reloads whichever one you save, every second, so you can tune offsets live. /vrm settings auto off stops it. Model/interaction scale must be > 0, brightness and spring values can not be negative, anything that doesnt parse fails the reload.

Outfits

Optional. Lets you turn meshes on and off and set blendshapes, and switch between sets in game.
The file is outfits_<vrm filename in lowercase>.txt next to the vrm. so Midnight.vrm -> outfits_midnight.txt
outfits_Example.txt.example shows the format.

each [Section] is an outfit, name it whatever. exactly one needs Default=True, that is the one you spawn with.
mesh:<renderer name>=True/False
blendshape:<renderer name>:<blendshape name>=0 to 100
names have to match the vrm exactly, spaces and caps included. Missing ones get logged, they dont break the avatar.

/vrm outfit generate writes a starting file with every mesh in it if you dont have one. it will not overwrite an existing file.

Chat commands (F5 console works too, without the slash)

/vrm outfit list
/vrm outfit next
/vrm outfit set <name>
/vrm outfit reload
/vrm outfit generate
/vrm toggle <mesh>
/vrm blend <blendshape> <0-100>
/vrm settings reload
/vrm settings auto on | off

toggle and blend are quick overrides, they dont touch the file and reset when you pick an outfit.
Outfit changes show up for other players right away, they only need to have your avatar already.

Avatar sharing

Other players get your avatar automatically, but ONLY on a dedicated server running this mod. Player hosted worlds dont share, local avatars still work there.

install the same release on the dedicated server and on every client.
the server needs a TCP port open. set it in the servers config under [Sharing] ServerPort (default 6067) and open that port on the box / in your hosting panel.
clients get the port from the server automatically, the ServerPort in a clients config is ignored.
if your server is only reachable through steam relay, set ServerHost in the clients config to the servers real address.
the first time somebody joins with a big avatar it takes a while. 6 Mbps upload default, change UploadMbps in the config if your connection can do more.

Config keys that matter (BepInEx/config/com.rawrtastic.plugins.enhancedvalheimvrm.cfg)

[General]  EnableVrmSharing = true      turn sharing off entirely on this machine
[Sharing]  UploadMbps = 6               your upload rate
[Sharing]  ServerPort = 6067            server only
[Sharing]  EnableServer = true          server only
[Sharing]  DedicatedDownloadMbps = 25   server only, per download
[Sharing]  DedicatedDownloadSlots = 4   server only, downloads at once
[Sharing]  MaxBundleMiB = 384           server only, biggest avatar it will accept

Downloaded avatars are cached in EnhancedValheimVRM/Shared, the server keeps them in EnhancedValheimVRM/Server. Delete those to force a redownload. If you put someones vrm and settings file in your folder yourself, that is used instead of the shared one.

Usefull Info

If you have a shader compile error you probably need to use the old shader bundle.
the newer current bundle should work, but JIC ive included the old one still
Its in General settings. ShaderBundle=<old,current>. Note that this will affect all models.
if the mod says sharing is unavailable because the server did not answer, the server and clients are on different versions. update all of them and restart.

Technical Stuff for maintaining this repo

You might need to build an Asset Bundle of shaders to stay inline with UniVrm. This is probably a non issue unless Valheim Updates Unity. - see next point.
Current UniVrm version is 121, for Unity 2022. UniVrm was 111 previous to Valheim Patch 0.217.46. 111 is the last version to support Unity 2020.
Most Recent AssetBundle of shaders is UniVrm.shaders. This has shaders that are required since version 67 - 70(I dont know exactly when).
You will need to install UniVrm into a blank project (create the shader asset bundle there too) once that's done(install from git the assetBundle Browser), you will need to build the Unity Project. Find the (build folder)_Data and set that as a system Path. I called my project "UniVrm v121" so the data folder would be UniVrm v121_Data - UNIVRM_UNITY_LIBS
inside your UniVrm Project you will need to install UnityAsyncImageLoader https://github.com/aMidnightNova/UnityAsyncImageLoader
Set your Valheim Folder as a system path. VALHEIM_INSTALL
Build without deploying with dotnet build EnhancedValheimVRM/EnhancedValheimVRM.csproj -p:DeployToGame=false. Normal builds deploy the mod to BepInEx/plugins of VALHEIM_INSTALL; Release builds also create artifacts/EnhancedValheimVRM-<version>.zip.
Tests: dotnet run --project SharingTests/SharingTests.csproj (add -- --zip-only or -- --rpc-only for the focused sets) and dotnet run --project LoadingTests/LoadingTests.csproj.
If you bump the sharing protocol (Protocol in SharingRpc.cs) the server and every client have to update together.
If for whatever reason you are targeting 111 still, Make sure in Unity you have Mono and .NET 4.x selected.