evert/stardew-multiplayer-docker
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Improve README formatting and update Dockerfile

Browse Source 
Made formatting changes to README.md for improved readability and updated Dockerfile to use Debian 11 as base image, and fetch correct version of dotnet-sdk. `.gitignore` file has been updated to ignore more unnecessary files. Changes reflect more updated development environment and recent build processes.
This commit is contained in:
norimicry 2024-03-24 14:11:06 -04:00
parent f2ae8e9fc5
commit 7091e273b6
3 changed files with 86 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
.gitignore vendored
View File

@ -1 +1,27 @@
valley_saves
# Docker project generated files to ignore
# if you want to ignore files created by your editor/tools,
# please consider a global .gitignore https://help.github.com/articles/ignoring-files
.vagrant*
bin
docker/docker
.*.swp
a.out
*.orig
build_src
.flymake*
.idea
.DS_Store
docs/_build
docs/_static
docs/_templates
.gopath/
.dotcloud
*.test
bundles/
.hg/
.git/
vendor/pkg/
pyenv
Vagrantfile
valley_saves

71
README.md
View File

@ -4,15 +4,18 @@ This project aims to autostart a Stardew Valley Multiplayer Server as easy as po
## Notes
- Updating to most recent version requires a rebuild: `docker-compose build --no-cache`
- Although I'm trying to put out updates, I don't have the time for testing thoroughly, so if you find issues, including game updates, please put in an issue request and I will try to help.
- Thanks printfuck for the base code and baolatui for helping with hosting files.
- Updating to most recent version requires a rebuild: `docker-compose build --no-cache`
- Although I'm trying to put out updates, I don't have the time for testing thoroughly, so if you find issues, including
game updates, please put in an issue request and I will try to help.
- Thanks printfuck for the base code and baolatui for helping with hosting files.
## Setup
### Configuration
Edit the docker-compose.yml with your desired configuration settings. Setting values are quite descriptive as to what they set.
Edit the docker-compose.yml with your desired configuration settings. Setting values are quite descriptive as to what
they set.
```
environment:
- "VNC_PASSWORD=insecure"
@ -133,7 +136,7 @@ environment:
```
### Docker-Compose
```
git clone https://github.com/norimicry/stardew-multiplayer-docker.git
@ -142,13 +145,19 @@ docker-compose up
## Game Setup
Intially, you have to create or load a game once via VNC or web interface. After that, the Autoload Mod jumps into the previously loaded game save everytime you restart or rebuild the container. The AutoLoad Mod config file is by default mounted as a volume, since it keeps the state of the ongoing game save, but you can also copy your existing game save to the `Saves` volume and define the game save's name in the environment variables. Once started, press the Always On Hotkey (default F9) to enter server mode.
Intially, you have to create or load a game once via VNC or web interface. After that, the Autoload Mod jumps into the
previously loaded game save everytime you restart or rebuild the container. The AutoLoad Mod config file is by default
mounted as a volume, since it keeps the state of the ongoing game save, but you can also copy your existing game save to
the `Saves` volume and define the game save's name in the environment variables. Once started, press the Always On
Hotkey (default F9) to enter server mode.
### VNC
Use a VNC client like `TightVNC` on Windows or plain `vncviewer` on any Linux distribution to connect to the server. You can modify the VNC Port and IP address and Password in the `docker-compose.yml` file like this:
Use a VNC client like `TightVNC` on Windows or plain `vncviewer` on any Linux distribution to connect to the server. You
can modify the VNC Port and IP address and Password in the `docker-compose.yml` file like this:
Localhost:
```
# Server is only reachable on localhost on port 2342...
ports:
@ -158,21 +167,36 @@ Localhost:
- VNCPASS=insecure
```
### Web Interface
### Web Interface
On port 5900 (mapped to 5902 by default) inside the container is a web interface. This is a bit easier and more accessible than just the VNC interface. Although you will be asked for the vnc password, I wouldn't recommend exposing the port to the outside world.
On port 5900 (mapped to 5902 by default) inside the container is a web interface. This is a bit easier and more
accessible than just the VNC interface. Although you will be asked for the vnc password, I wouldn't recommend exposing
the port to the outside world.
![img](https://store.eris.cc/uploads/859865e1ab5b23fb223923d9a7e4806b.PNG)
## Accessing the server
- Friends List: Your Steam or GoG friends should be able to see your game and join at will the same way they would normally.
- Direct IP: If you want to set a up direct IP access over the internet "Join LAN Game" you need to open (or forward) port 24642. Or use Server Port Changer to choose a different port.Then give people your external IP.
- Invite Code: Invite Code connections are routed through Steam/GoG . I've provided two methods for delivering your game's current invite code to players:
Invite Code Auto Copy/Paste: The server will copy the most up-to-date invite code to the clipboard (on by default in the config.json file) whenever it changes. You can then use a macro program of your choice to paste that code into the chat service of your choice so that your non-steam friends can always have access to the most up-to-date invite code even when you are not there. For your convenience I've included an AutoHotkey script under the Files Tab> Optional Files here on Nexus that you can use. Run the Game Server>Run the AutoHotKey Script>Open Discord or other chat service and click into the chatbox of that service. The current invite code for your game will be pasted and sent every two minutes. Do not close the chat window of your chat service or click out of the chat box or it will not work. When the game server is turned off it will no longer copy the key so be sure to turn off AutoHotKey as well.
Invite Code Bot: The server will copy the invite code to an "InviteCode.txt" file in the same folder as the mod. You can use this to make a bot for a chat service/website/etc. I've provided the code for a node.js Discord bot in the "Discord Bots" section at the bottom of this page.
- Friends List: Your Steam or GoG friends should be able to see your game and join at will the same way they would
normally.
- Direct IP: If you want to set a up direct IP access over the internet "Join LAN Game" you need to open (or forward)
port 24642. Or use Server Port Changer to choose a different port.Then give people your external IP.
- Invite Code: Invite Code connections are routed through Steam/GoG . I've provided two methods for delivering your
game's current invite code to players:
Invite Code Auto Copy/Paste: The server will copy the most up-to-date invite code to the clipboard (on by default in
the config.json file) whenever it changes. You can then use a macro program of your choice to paste that code into the
chat service of your choice so that your non-steam friends can always have access to the most up-to-date invite code
even when you are not there. For your convenience I've included an AutoHotkey script under the Files Tab> Optional
Files here on Nexus that you can use. Run the Game Server>Run the AutoHotKey Script>Open Discord or other chat
service and click into the chatbox of that service. The current invite code for your game will be pasted and sent
every two minutes. Do not close the chat window of your chat service or click out of the chat box or it will not work.
When the game server is turned off it will no longer copy the key so be sure to turn off AutoHotKey as well.
Invite Code Bot: The server will copy the invite code to an "InviteCode.txt" file in the same folder as the mod. You
can use this to make a bot for a chat service/website/etc. I've provided the code for a node.js Discord bot in the "
Discord Bots" section at the bottom of this page.
(Taken from mod description. See [Always On Server](https://www.nexusmods.com/stardewvalley/mods/2677?tab=description) for more info.)
(Taken from mod description. See [Always On Server](https://www.nexusmods.com/stardewvalley/mods/2677?tab=description)
for more info.)
## Mods
@ -189,16 +213,25 @@ Invite Code Bot: The server will copy the invite code to an "InviteCode.txt"
### Waiting for Day to End
Check VNC just to make sure the host hasn't gotten stuck on a prompt.
Check VNC just to make sure the host hasn't gotten stuck on a prompt.
### Error Messages in Console
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.
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.
### VNC
Access the game via VNC to initially load or start a pre-generated savegame. You can control the server from there or edit the config.json files in the configs folder.
Access the game via VNC to initially load or start a pre-generated savegame. You can control the server from there or
edit the config.json files in the configs folder.
## Disclaimer
This multiplayer server container is designed to distribute game files for the purpose of facilitating multiplayer gaming experiences. By utilizing this server container, you acknowledge and agree that you are expected to possess a legal copy of the game for which the files are being distributed. These files are intended solely for the purpose of running a multiplayer server and should not be used in any other manner. The distributed game files are to be strictly used for the operation of multiplayer servers. Any other use, including but not limited to reproduction, modification, or distribution for personal or commercial gain, is strictly prohibited. The distribution of these game files does not imply endorsement or sponsorship by the creators or owners of the game. We are solely providing a platform for multiplayer gaming experiences.
This multiplayer server container is designed to distribute game files for the purpose of facilitating multiplayer
gaming experiences. By utilizing this server container, you acknowledge and agree that you are expected to possess a
legal copy of the game for which the files are being distributed. These files are intended solely for the purpose of
running a multiplayer server and should not be used in any other manner. The distributed game files are to be strictly
used for the operation of multiplayer servers. Any other use, including but not limited to reproduction, modification,
or distribution for personal or commercial gain, is strictly prohibited. The distribution of these game files does not
imply endorsement or sponsorship by the creators or owners of the game. We are solely providing a platform for
multiplayer gaming experiences.

15
docker/Dockerfile
View File

@ -1,5 +1,5 @@
# Pull base image.
FROM jlesage/baseimage-gui:debian-10
FROM jlesage/baseimage-gui:debian-11-v4
# Set the name of the application.
ENV APP_NAME="StardewValley"
@ -16,16 +16,15 @@ RUN mkdir -p /data/Stardew && \
tar xf /data/latest.tar.gz -C /data/Stardew && \
rm /data/latest.tar.gz
RUN wget -qO dotnet.tar.gz https://download.visualstudio.microsoft.com/download/pr/6788a5a5-1879-4095-948d-72c7fbdf350f/c996151548ec9f24d553817db64c3577/dotnet-sdk-5.0.402-linux-x64.tar.gz \
#RUN wget -qO dotnet.tar.gz https://download.visualstudio.microsoft.com/download/pr/95352809-7f41-40f3-974d-8d530321a8e4/0024d7bf0c872f176ceba7a63a34915b/dotnet-runtime-6.0.0-linux-musl-x64.tar.gz \
&& tar -zxf dotnet.tar.gz -C /usr/share/dotnet \
&& rm dotnet.tar.gz \
&& ln -s /usr/share/dotnet/dotnet /usr/bin/dotnet
RUN wget -qO dotnet.tar.gz https://download.visualstudio.microsoft.com/download/pr/d4b71fac-a2fd-4516-ac58-100fb09d796a/e79d6c2a8040b59bf49c0d167ae70a7b/dotnet-sdk-5.0.408-linux-arm64.tar.gz &&\
tar -zxf dotnet.tar.gz -C /usr/share/dotnet &&\
rm dotnet.tar.gz &&\
ln -s /usr/share/dotnet/dotnet /usr/bin/dotnet
RUN wget https://mirror.cloudcraft.info/SMAPI_latest.zip -qO /data/nexus.zip && \
unzip /data/nexus.zip -d /data/nexus/ && \
/bin/bash -c "SMAPI_NO_TERMINAL=true SMAPI_USE_CURRENT_SHELL=true echo -e \"2\n\n\" | /data/nexus/SMAPI\ 4.0.1\ installer/internal/linux/SMAPI.Installer --install --game-path \"/data/Stardew/game\"" || :
SMAPI_INSTALLER=$(find /data/nexus -name 'SMAPI*.installer' -type f | head -n 1) && \
/bin/bash -c "SMAPI_NO_TERMINAL=true SMAPI_USE_CURRENT_SHELL=true echo -e "2\n\n" | $SMAPI_INSTALLER --install --game-path "/data/Stardew/game"" || :
# Add Mods & Scripts
COPY ["mods/", "/data/Stardew/game/Mods/"]