stardew-multiplayer-docker/README.md

59 lines
2.1 KiB
Markdown
Raw Normal View History

2019-04-09 17:02:27 +00:00
# Stardew Valley Multiplayer Docker Compose
This project aims to autostart a Stardew Valley Multiplayer Server as easy as possible.
2019-04-13 00:29:00 +00:00
## Setup
### Docker-Compose
2019-04-09 17:04:45 +00:00
```
2019-04-09 17:02:27 +00:00
git clone https://github.com/printfuck/stardew-multiplayer-docker
docker-compose up
2019-04-09 17:04:45 +00:00
```
2019-04-13 00:29:00 +00:00
### Ansible
Create an inventory file with your hosts
```
ansible -i <your_inventori> playbook.yml
```
### Terraform (with Hetzner Cloud)
2020-04-07 04:19:12 +00:00
Enter your API Token in `terraform/vars.auto.tfvars` and the resource section in `main.tf` run the following script:
2019-04-13 00:29:00 +00:00
```
./terra.sh
```
## Game Setup
2019-04-09 17:02:27 +00:00
2019-04-12 21:39:04 +00:00
Intially you have to create or load a game once after first startup. After that the Autoload Mod jump starts into the previously loaded savegame everytime you rerun the container. You can also edit the config file of the Autoload Mod to archieve similar behaviour.
## How it works
2019-04-09 17:02:27 +00:00
2020-04-07 04:19:12 +00:00
The game, the modloader (SMAPI), and the "Always On" Mod is pulled from my servers (I'll assume you already own the game - since you're looking for a multiplayer - so please don't rip it from there) to minimize version conflicts. Afterwards everything will be unpacked into the right places. The `docker-entrypoint.sh` script will start `Xvfb` and `x11vnc` before starting the game. You can control the game via vnc with the settings within the `docker-compose.yml` file.
2019-04-12 21:39:04 +00:00
## Why Docker
This should be simple and easily deployable, so there are only a few options.
2020-04-07 02:43:42 +00:00
## Used Mods
* [AutoLoadGame](https://www.nexusmods.com/stardewvalley/mods/2509)
* [Always On](https://community.playstarbound.com/threads/updating-mods-for-stardew-valley-1-4.156000/page-20#post-3353880)
* [Unlimited Players](https://www.nexusmods.com/stardewvalley/mods/2213)
2020-04-07 02:51:45 +00:00
## Troubleshooting
### Error Messages in Console
2020-04-07 04:19:12 +00:00
Usually you should be able to ignore any message there. If the game doesn't start or any errors appear, you should look for messages like "cannot open display", which would most likely indicate permission errors.
2020-04-07 02:51:45 +00:00
### VNC
2020-04-07 04:19:12 +00:00
Access the game via VNC to initially load or start a pregenerated savegame. You can control the Server from there or edit the config.json files in the configs folder.
2020-04-07 02:51:45 +00:00