alihan/valheim-docker-server-2
1
0
Fork 0
mirror of https://github.com/mbround18/valheim-docker.git synced 2021-10-22 21:53:54 +03:00
Code Issues Projects Releases Wiki Activity

#272 Mod Support (#276)

Browse Source 
* Added nexus mods and downloader

* Mod downloader ready

* Modified to follow redirect information

* Slimmed down env

* Running with type message fix

* dynamic fetch of latest bepinex version

* Refactored file

* Changes

* Dont use barrow

* Added support for downloading dll and cfg

* Added exit for non zip file
This commit is contained in:
Michael
2021-03-14 18:39:11 -07:00
committed by GitHub
parent 8c5f642da7
commit 29f272ff7f
20 changed files with 870 additions and 360 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
docs/getting_started_with_mods.md
View File

@@ -4,10 +4,36 @@
## Steps
1. Download the mod file, for our example we want the `UnixServer.zip` from `https://github.com/nxPublic/ValheimPlus/releases`
2. Place the file in your server volume mount. `cp UnixServer.zip /home/youruser/valheim/server`
3. Unzip the archive `unzip UnixServer.zip -d .` hit A to replace all as needed.
4. Restart your server.
1. Set the variable `TYPE` to be ONne of the following:
| Type | What it installs |
|-------------|------------------|
| Vanilla | Default value and the most common installation type. This will run Valheim normally. |
| BepInEx | This will install [BepInEx from this package](https://valheim.thunderstore.io/package/denikson/BepInExPack_Valheim/) and is purely just BepInEx with minimally needed components. |
| BepInExFull | This will install [BepInEx Full from this package](https://valheim.thunderstore.io/package/1F31A/BepInEx_Valheim_Full/) and contains a modern set of components with some extras for expanded mod compatibility. |
| ValheimPlus | This will install [Valheim Plus from this repository](https://github.com/valheimPlus/ValheimPlus) and included BepInEx as a basic version with the most common set of components |
2. If you wish do not with to use additional mods, you can skip this step. Otherwise, in order to install additional mods you can use the `MODS` variable.
Example of MODS, this example is slimmed down to go over the `TYPE` and `MODS` variable.
```yaml
version: "3"
services:
valheim:
image: mbround18/valheim:latest
environment:
# The Type variable is used to set which type of server you would like to run.
- TYPE=ValheimPlus
# The Mods variable is a comma and newline separated string.
# It MUST be a link with a command and a new line at the end to be valid.
- "MODS=
https://cdn.thunderstore.io/live/repository/packages/abearcodes-SimpleRecycling-0.0.10.zip,
https://cdn.thunderstore.io/live/repository/packages/abearcodes-CraftingWithContainers-1.0.9.zip
"
```
3. Now that you have your compose setup, run `docker-compose up`
> Odin automatically detects if you are running with BepInEx and adds the environment variables appropriately.
>
@@ -20,4 +46,5 @@
## Valheim Updated Help!!!!
Mod development is slow, and the more mods you have the more complicated it will be to keep everything up to date.
It is a suggestion that you turn off the AUTO_UPDATE variable when you are using mods and refrain from updating your local client until all your mods have been updated.
It is a suggestion that you turn off the AUTO_UPDATE variable when you are using mods and refrain from updating your local client until all your mods have been updated.
Some mods break on new updates of Valheim while others do not. Be on the look out for mod issues if you update your server.