AppFeed/templates/ich777sRepository/ich777/Valheim.xml
2021-03-15 06:02:55 -04:00

179 lines
11 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<Container version="2">
<Name>Valheim</Name>
<Repository>ich777/steamcmd:valheim</Repository>
<Registry>https://hub.docker.com/r/ich777/steamcmd/</Registry>
<Network>bridge</Network>
<Shell>sh</Shell>
<Privileged>false</Privileged>
<Support>https://forums.unraid.net/topic/79530-support-ich777-gameserver-dockers/</Support>
<Project>https://www.valheimgame.com/</Project>
<Overview>This Docker will download and install SteamCMD. It will also install Valheim and run it.&#13;
&#13;
ATTENTION: First Startup can take very long since it downloads the gameserver files!&#13;
&#13;
SERVER BROWSER: It could take really long that the server shows up in the in game server list, if you want to connect directly simply go to the Steam Server Browser - View -&gt; Servers -&gt; Favourites -&gt; Add Server -&gt; SERVERIP:SERVERPORT+1 (eg: if the server port is 2456 then you have to enter something like: 192.168.0.1:2457) -&gt; click on Add -&gt; click on more time on Refresh, after that you can connect to the server with a double click.&#13;
&#13;
Update Notice: Simply restart the container if a newer version of the game is available.&#13;
&#13;
You can also run multiple servers with only one SteamCMD directory!</Overview>
<WebUI></WebUI>
<Icon>https://raw.githubusercontent.com/ich777/docker-templates/master/ich777/images/valheim.png</Icon>
<ExtraParams>--restart=unless-stopped</ExtraParams>
<PostArgs></PostArgs>
<CPUset></CPUset>
<DonateText>If you like my work please </DonateText>
<DonateLink>https://www.paypal.me/chips777</DonateLink>
<Networking>
<Mode>bridge</Mode>
<Publish>
<Port>
<HostPort>2456-2458</HostPort>
<ContainerPort>2456-2458</ContainerPort>
<Protocol>udp</Protocol>
</Port>
</Publish>
</Networking>
<Data>
<Volume>
<HostDir>/mnt/user/appdata/steamcmd</HostDir>
<ContainerDir>/serverdata/steamcmd</ContainerDir>
<Mode>rw</Mode>
</Volume>
<Volume>
<HostDir>/mnt/cache/appdata/valheim</HostDir>
<ContainerDir>/serverdata/serverfiles</ContainerDir>
<Mode>rw</Mode>
</Volume>
</Data>
<Environment>
<Variable>
<Value>896660</Value>
<Name>GAME_ID</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value></Value>
<Name>GAME_PARAMS</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value></Value>
<Name>USERNAME</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value></Value>
<Name>VALIDATE</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value></Value>
<Name>PASSWRD</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value>Valheim Docker</Value>
<Name>SRV_NAME</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value>Dedicated</Value>
<Name>WORLD_NAME</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value>Docker</Value>
<Name>SRV_PWD</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value>1</Value>
<Name>PUBLIC</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value>2456</Value>
<Name>GAME_PORT</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value>true</Value>
<Name>UPDATE_CHECK</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value></Value>
<Name>ENABLE_VALHEIMPLUS</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value></Value>
<Name>ENABLE_BEPINEX</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value>true</Value>
<Name>BACKUP_FILES</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value>62</Value>
<Name>BACKUP_INTERVAL</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value>24</Value>
<Name>BACKUP_TO_KEEP</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value>99</Value>
<Name>UID</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value>100</Value>
<Name>GID</Name>
<Mode></Mode>
</Variable>
<Variable>
<Value>false</Value>
<Name>DEBUG_OUTPUT</Name>
<Mode></Mode>
</Variable>
</Environment>
<Config Name="SteamCMD" Target="/serverdata/steamcmd" Default="" Mode="rw" Description="Container Path: /serverdata/steamcmd" Type="Path" Display="always" Required="true" Mask="false">/mnt/user/appdata/steamcmd</Config>
<Config Name="ServerFiles" Target="/serverdata/serverfiles" Default="" Mode="rw" Description="Container Path: /serverdata/serverfiles" Type="Path" Display="always" Required="true" Mask="false">/mnt/cache/appdata/valheim</Config>
<Config Name="GAME_ID" Target="GAME_ID" Default="" Mode="" Description="The GAME_ID that the container download at startup.&#13;&#10;(https://developer.valvesoftware.com/wiki/Dedicated_Servers_List)" Type="Variable" Display="always" Required="true" Mask="false">896660</Config>
<Config Name="GAME_PARAMS" Target="GAME_PARAMS" Default="" Mode="" Description="Enter your extra start up commands for the server here otherwise leave empty." Type="Variable" Display="always" Required="false" Mask="false"></Config>
<Config Name="Steam-Username" Target="USERNAME" Default="" Mode="" Description="Your Steam username goes here if you want to install a game that needs a valid account, otherwise leave it blank (ATTENTION: You have to disable Steam Guard)." Type="Variable" Display="always-hide" Required="false" Mask="false"></Config>
<Config Name="Validate Installation" Target="VALIDATE" Default="" Mode="" Description="Set the Variable to 'true' if you want to validate the installation otherwise leave it blank." Type="Variable" Display="always-hide" Required="false" Mask="false"></Config>
<Config Name="Steam-Password" Target="PASSWRD" Default="" Mode="" Description="Your Steam password goes here if you want to install a game that needs a valid account, otherwise leave it blank (ATTENTION: You have to disable Steam Guard)." Type="Variable" Display="always-hide" Required="false" Mask="true"></Config>
<Config Name="Server Name" Target="SRV_NAME" Default="" Mode="" Description="Name of the Server" Type="Variable" Display="always" Required="true" Mask="false">Valheim Docker</Config>
<Config Name="World Name" Target="WORLD_NAME" Default="" Mode="" Description="Name of the Server World" Type="Variable" Display="always" Required="true" Mask="false">Dedicated</Config>
<Config Name="Server Password" Target="SRV_PWD" Default="" Mode="" Description="Server Password - ATTENTION: the minimum length is 5 characters!" Type="Variable" Display="always" Required="true" Mask="false">Docker</Config>
<Config Name="Public Server" Target="PUBLIC" Default="" Mode="" Description="List Server as Public (set to '0' to disable or set to '1' to enable)." Type="Variable" Display="always" Required="false" Mask="false">1</Config>
<Config Name="UDP - Game Port Range" Target="2456-2458" Default="" Mode="udp" Description="UDP Game Ports (If you need another port delete this Entry and create a new UDP port mapping with the corresponding port range | GAME_PORT +2 | also don't forget to click on show more and change the GAME_PORT)" Type="Port" Display="always" Required="false" Mask="false">2456-2458</Config>
<Config Name="Automatically Update Game" Target="UPDATE_CHECK" Default="" Mode="" Description="If set to 'true' (without quotes) the container will automatically check every 60 minuts if there is an update available and restart the container if a update is found (please keep in mind if you enable the auto update function the container will automatically restart if a newer version is found, set to 'false' without quotes to disable the update check)." Type="Variable" Display="always" Required="true" Mask="false">true</Config>
<Config Name="ValheimPlus" Target="ENABLE_VALHEIMPLUS" Default="" Mode="" Description="If you want to enable ValheimPlus set this variable to 'true' (without quotes). For more help please refer to this site: https://github.com/nxPublic/ValheimPlus" Type="Variable" Display="always" Required="false" Mask="false"></Config>
<Config Name="BepInEx for Valheim" Target="ENABLE_BEPINEX" Default="" Mode="" Description="If you want to enable BepInEx for Valheim set this variable to 'true' (without quotes). For more help please refer to this site: https://valheim.thunderstore.io/package/denikson/BepInExPack_Valheim/" Type="Variable" Display="always" Required="false" Mask="false"></Config>
<Config Name="Backup" Target="BACKUP_FILES" Default="" Mode="" Description="Set this value to 'true' (without quotes) to enable the automated backup function from the container, you find the Backups in '.../valheim/Backups/'. Set to 'false' (without quotes) to disable the backup function." Type="Variable" Display="always" Required="true" Mask="false">true</Config>
<Config Name="Backup Interval (in minutes)" Target="BACKUP_INTERVAL" Default="" Mode="" Description="The backup interval in minutes (set to 62 minutes because the game automatically saves the database every 30 minutes)&#13;&#10;ATTENTION: The first backup will be triggered after the set interval in this variable after the start/restart of the container)." Type="Variable" Display="always" Required="true" Mask="false">62</Config>
<Config Name="Backups to keep" Target="BACKUP_TO_KEEP" Default="" Mode="" Description="Number of backups to keep (by default set to 24 to keep the last backups of the last 24 hours)." Type="Variable" Display="always" Required="true" Mask="false">24</Config>
<Config Name="GAME_PORT" Target="GAME_PORT" Default="" Mode="" Description="Only change if you know what you are doing (intital GAME_PORT | Dont forget to create create a new UDP port mapping with the corresponding port range and delete the default port range | GAME_PORT +2)" Type="Variable" Display="advanced" Required="true" Mask="false">2456</Config>
<Config Name="UID" Target="UID" Default="" Mode="" Description="Only change if you know what you are doing!" Type="Variable" Display="advanced-hide" Required="true" Mask="false">99</Config>
<Config Name="GID" Target="GID" Default="" Mode="" Description="Only change if you know what you are doing!" Type="Variable" Display="advanced-hide" Required="true" Mask="false">100</Config>
<Config Name="Debug Log Output" Target="DEBUG_OUTPUT" Default="" Mode="" Description="Only change if you know what you are doing!" Type="Variable" Display="advanced" Required="false" Mask="false">false</Config>
<Description>This Docker will download and install SteamCMD. It will also install Valheim and run it.&#13;
&#13;
ATTENTION: First Startup can take very long since it downloads the gameserver files!&#13;
&#13;
SERVER BROWSER: It could take really long that the server shows up in the in game server list, if you want to connect directly simply go to the Steam Server Browser - View -&gt; Servers -&gt; Favourites -&gt; Add Server -&gt; SERVERIP:SERVERPORT+1 (eg: if the server port is 2456 then you have to enter something like: 192.168.0.1:2457) -&gt; click on Add -&gt; click on more time on Refresh, after that you can connect to the server with a double click.&#13;
&#13;
Update Notice: Simply restart the container if a newer version of the game is available.&#13;
&#13;
You can also run multiple servers with only one SteamCMD directory!</Description>
<templatePath>/tmp/GitHub/AppFeed/templates/ich777sRepository/ich777/Valheim.xml</templatePath>
</Container>