search

valheimPlus / ValheimPlus

A HarmonyX Mod aimed at improving the gameplay and quality of life of the game Valheim.
http://valheim.plus
GNU Affero General Public License v3.0
967 stars 236 forks source link

Add development setup to the readme #7

Closed avivbiton closed 3 years ago

avivbiton commented 3 years ago

I think it will allow more programmers to contribute and expend the mod if you add some sort of instructions to the readme on how to setup a development env

nxPublic commented 3 years ago

I appreciate the feedback, how ever that's literally already in there at the bottom of the README.md

Valheim Plus Compiler Requirements

You will be dependent on a package of stripped .net/mono Unity files from the Valheim directory. How to get BepInEx working:

  1. Download this package:

https://mega.nz/file/0UAlxQwK#47InGOb8ViI6GyBDArpbhkbMTBklXdyRSmAc4-BZpJY

  1. Unpack into your Valheim root folder and overwrite every file when asked.

  2. Add all dll's of "\Valheim\valheim_Data\Managed" folder as references to the project.

(Except : "mscorlib.dll", "System.Configuration.dll", "System.Core.dll", "System.dll", "System.Xml.dll")

  1. Add all BepInEx dll's ("Valheim\BepInEx\core") as refernces to the project.

(Except : "0Harmony.dll", "0Harmony20.dll")

  1. Add Ini-parser and HarmonyX via nu-get
avivbiton commented 3 years ago

Was hoping for something more about the env itself and not about just compiler but nevermind, it is not critical. This will do for now @nxPublic