oci/docker-vintagestory
2
0
Fork 0
mirror of https://github.com/Merith-TK/docker-vintagestory synced 2025-01-18 14:20:26 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

updated README

Browse source
This commit is contained in:
Maik Laschober 2023-05-05 07:43:01 +02:00
parent 558e4aa364
commit 972de4cdab
1 changed files with 40 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

49
README.md
View file

@ -1,7 +1,34 @@
# Run this image
To run this image you can use `docker run -pd 42420:42420 --name VintageStoryServer devidian/vintagestory`, but you may want to use a customized version for your needs so see following instructions.
# About this image
This image can be used to run a dedicated server for [Vintage Story](https://www.vintagestory.at/)
## Run this image with docker run
To run this image you can use `docker run -pd 42420:42420 --name VintageStoryServer devidian/vintagestory:latest`, but you may want to use a customized version for your needs so see following instructions.
## Run this image with docker compose
To run this image with docker compose you can start using the following file:
```yaml
version: '3.8'
services:
vsserver:
image: devidian/vintagestory:latest
container_name: vsserver
restart: always
volumes:
# • your world will be in /appdata/vintagestory/vs by default (/gamedata/vs on the container)
# • if you run multiple servers just change the left part
# • you could also use docker volumes instead of host path
- /appdata/vintagestory:/gamedata
ports:
- 42420:42420
```
## Custom build
# Custom build
You can either copy files from `https://github.com/Devidian/docker-vintagestory/tree/master/build-custom-example` or follow these steps:
- create a `serverconfig.json` with your settings
@ -34,7 +61,7 @@ CMD mono VintagestoryServer.exe --dataPath ${VS_DATA_PATH}
```
## docker-compose.yml
### docker-compose.yml
```yml
version: '3.8'
@ -57,14 +84,18 @@ volumes:
gamedata:
```
# Using unstable versions
### Using unstable versions
To use unstable versions just replace tag `latest` with `unstable` in `Dockerfile`
# Updating container
### Updating container
To update to the latest version call `docker pull devidian/vintagestory` first, this will download the newest latest base image. Then execute `docker-compose up -d --build` if you have not changed any other files it should not override them (did not for me)
# Copy/Override files
### Copy/Override files
To copy and override files use `docker exec vsserver cp [local path] [docker-path]` where `docker-path` is starting with `/gamedata/vs-custom/..` for the example composer file. This is useful to update white/blacklists manually or update `serversettings.json`
# Troubleshooting / Help / Issues
If you encounter any Problems or want some help feeel free to contact me on Discord (`Devidian#1334`) on my Discord Server (https://discord.gg/8h3yhUT) or write an issue at GitHub (https://github.com/Devidian/docker-vintagestory)
## Troubleshooting / Help / Issues
If you encounter any Problems or want some help feeel free to contact me on Discord (`Devidian#1334`) on my Discord Server (<https://discord.gg/8h3yhUT>) or write an issue at GitHub (<https://github.com/Devidian/docker-vintagestory>)