AshValheimMod

A custom Valheim mod created for the AshValheimMod project.

AshValheimMod adds custom gameplay, UI, and summoning functionality to Valheim using BepInEx and Jötunn.

Status: Development / Private Release

This mod is primarily intended for use by the AshValheimMod development team and friends.

---

Requirements

AshValheimMod requires:

• BepInExPack for Valheim
• Jötunn
• Valheim

The required versions of BepInEx and Jötunn may change as the mod develops.

---

Installation (Manual)

1. Install BepInEx

Install BepInExPack for Valheim into your Valheim installation.

A typical Steam installation is:

C:\Program Files (x86)\Steam\steamapps\common\Valheim

After installing BepInEx, your Valheim directory should contain a BepInEx folder.

2. Install Jötunn

Install Jötunn into:

Valheim\BepInEx\plugins\Jotunn\

The Jötunn installation documentation provides the current installation procedure and dependencies.

3. Install AshValheimMod

Copy the AshValheimMod plugin into:

Valheim\BepInEx\plugins\AshValheimMod\

The final structure should look approximately like:

Valheim
└── BepInEx
    └── plugins
        ├── Jotunn
        │   └── Jotunn.dll
        │
        └── AshValheimMod
            └── AshValheimMod.dll

4. Launch Valheim

Start Valheim through the normal BepInEx-enabled installation.

Check the BepInEx console/log if you need to verify that AshValheimMod loaded successfully.

---

Features

Ash Summoning

Summon Ash into the world using the configured summon key.

The summon system uses Jötunn to integrate custom content with Valheim.

Custom Ash UI

AshValheimMod includes a custom in-game UI for displaying Ash-related messages and information.

Configurable Controls

Important mod controls are configurable through the mod's configuration settings.

The default summon key is currently:

"Left Alt + Y"

Custom Assets

The mod uses custom Valheim assets and prefabs to provide its Ash-related functionality.

Development Features

The mod includes logging and development functionality to assist with testing and debugging.

Additional features are actively being developed.

---

Multiplayer

AshValheimMod is currently being developed with multiplayer use in mind.

Whether the mod is required on the dedicated server, the client, or both depends on the functionality being used.

For multiplayer games, all players should use the same AshValheimMod version unless a specific release states otherwise.

Important: Do not assume that connecting to a server will automatically install the mod. BepInEx plugins normally need to be installed on the appropriate game installations manually or through a mod manager.

---

Configuration

After the mod has been launched once, its configuration can be found in the BepInEx configuration directory:

Valheim\BepInEx\config\

Configuration options may change as development continues.

---

Changelog

Unreleased

• Initial private development release
• Added Ash summoning functionality
• Added custom Ash UI
• Added configurable summon key
• Added Jötunn integration
• Added custom Ash prefab
• Added development and diagnostic logging

---

Known Issues

This is an active development project. Bugs and compatibility issues are expected.

Known issues will be documented here as they are identified.

Current known issues:

• Features and configuration options may change between releases.
• Multiplayer compatibility is still being tested.
• Mod functionality may depend on the current Valheim, BepInEx, and Jötunn versions.
• Additional client/server requirements may apply as multiplayer functionality is expanded.

---

Development

AshValheimMod is developed in C# using:

• Unity / Valheim
• BepInEx
• Jötunn
• C#
• Visual Studio

The project is currently under active development.

---

Credits

BepInEx A general-purpose Unity modding framework.

Jötunn The Valheim modding library used by AshValheimMod.

Thanks to the Valheim modding community and the developers of these projects for making Valheim mod development possible.

---

Source Code

The source code for AshValheimMod can be found on GitHub:

GitHub: [Add GitHub repository URL here]

---

License

See the repository for license information.