Setup Development Environment with .NET and BepInEx

alekho77 commented 10 months ago

This task involves setting up the development environment required for the Epic Valheim Mods Pack. The environment should support C# development with the latest .NET Framework and integrate the BepInEx modding platform for Valheim.

Definition of Ready (DoR)

Access to the latest version of Valheim is available.
System requirements for .NET Framework and BepInEx are understood and met.
Necessary permissions for software installations are granted.

Definition of Done (DoD)

.NET Framework is installed and configured correctly.
BepInEx is installed within the Valheim game directory and verified to be working.
A simple "Hello World" mod using BepInEx is created to validate the setup.
Documentation is updated with setup instructions and troubleshooting tips.

Tasks

[ ] Install and configure the latest .NET Framework.
[ ] Download and install BepInEx for Valheim.
[ ] Create a basic mod to test the development environment.
[ ] Update project documentation with detailed setup instructions.

Testing

Ensure that the "Hello World" mod loads correctly with Valheim.
Validate that no errors are thrown during the game launch.

Notes

Documentation should include steps for both Windows and Linux setups, if applicable.
All installations should be verified against the latest versions available.

alekho77 commented 10 months ago

.net sdk 7 .net framework 4.7.2 or later

alekho77 commented 10 months ago

To determine whether .NET 8.0 is compatible with the current versions of Valheim and Unity, we need to consider the compatibility of Unity with .NET versions and Valheim's use of the Unity engine.

Unity uses the .NET platform, supporting a range of languages and API libraries. It tries to support as much of the .NET ecosystem as possible, but there are exceptions to parts of the .NET system libraries that Unity explicitly doesn’t support【8†source】【9†source】. Unity supports two .NET profiles: .NET Standard and .NET Framework. The .NET Standard profile is recommended for new projects due to its smaller API surface, better cross-platform support, and compatibility with more runtime environments【10†source】【31†source】. However, Unity's support for .NET Core, which would include .NET 8.0, is limited. Specifically, managed plug-ins compiled for .NET Core are not supported in Unity【33†source】.

Valheim, on the other hand, has recently upgraded to Unity 2022, which includes multiple performance enhancements【18†source】【19†source】. While this information indicates an upgrade in the game engine, it doesn't directly address the compatibility with .NET 8.0. Given that .NET 8.0 was released on November 14, 2023【25†source】, and considering the limitations of Unity's support for .NET Core, it's not clear whether .NET 8.0 would be fully compatible with Unity 2022 and, by extension, the current version of Valheim.

In summary, while Unity does support a range of .NET profiles, its limited support for .NET Core versions suggests that .NET 8.0 may not be fully compatible with Unity 2022, and thus, its compatibility with the current version of Valheim is uncertain. For the most accurate and up-to-date information, it would be best to consult the official Unity and Valheim documentation or contact their support teams.

alekho77 commented 10 months ago

https://github.com/BepInEx/BepInEx

alekho77 / epic-valheim-mod