Update README.md

This commit is contained in:
norimicry 2024-04-30 19:29:24 -04:00 committed by GitHub
parent c1b64a8d3b
commit a15a89effc
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -4,27 +4,18 @@ Update: Previous versions provided game files to create the server with the Dock
intellectual property law, this will no longer be the case. Users will still be allowed to use their own copy of the game, however. For now, intellectual property law, this will no longer be the case. Users will still be allowed to use their own copy of the game, however. For now,
I will simply be disabling the sharing of game files which will render the Dockerfile incomplete. Those with more advanced Docker I will simply be disabling the sharing of game files which will render the Dockerfile incomplete. Those with more advanced Docker
knowledge will be able to make alterations. Life is busy so I appreciate patience while I work to update instructions on how to use knowledge will be able to make alterations. Life is busy so I appreciate patience while I work to update instructions on how to use
your own game files. I welcome pull requests to aid in this effort. your own game files. I welcome pull requests to aid in this effort. See Steam Setup section for running through Steam.
This project aims to autostart a Stardew Valley Multiplayer Server as easy as possible. This project aims to autostart a Stardew Valley Multiplayer Server as easy as possible.
## Notes ## Notes
- Updating to most recent version requires a rebuild: `git pull` and `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 - 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. 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. - Thanks printfuck for the base code and baolatui for helping with hosting files.
## Setup ## Setup
### Docker-Compose
```
git clone https://github.com/norimicry/stardew-multiplayer-docker.git
docker-compose up
```
### Configuration ### Configuration
Edit the docker-compose.yml with your desired configuration settings. Setting values are quite descriptive as to what Edit the docker-compose.yml with your desired configuration settings. Setting values are quite descriptive as to what
@ -252,4 +243,4 @@ running a multiplayer server and should not be used in any other manner. The dis
used for the operation of multiplayer servers. Any other use, including but not limited to reproduction, modification, 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 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 imply endorsement or sponsorship by the creators or owners of the game. We are solely providing a platform for
multiplayer gaming experiences. multiplayer gaming experiences.