Skip to content

Latest commit

 

History

History
102 lines (71 loc) · 6.69 KB

File metadata and controls

102 lines (71 loc) · 6.69 KB

logo

ValleyServer

A Multiplayer Server Solution for Stardew Valley
简体中文 | English

visitors license stars

📋 Project Overview

ValleyServer keeps your Stardew Valley farm running unattended and provides a stable multiplayer server solution. It is split into 2.x and 3.x mainlines:

🧩 2.x — MOD-Based Unattended + Docker

  • Principle: Custom MODs (e.g. ALOS) automate the farm owner — auto sleeping, auto skipping cutscenes, closing dialogs, etc., so the game keeps running without human interaction.
  • Form: Runs MODs on top of a real Stardew Valley + SMAPI client, packaged with a stable Docker deployment for a ready-to-use server.
  • Recommended: The most mature, out-of-the-box solution. Code lives under Mods/; deployment docs: oneclick-script.
  • Versioning: released as v2.x.

🧬 3.x — Reverse-Engineered / Mock Protocol Server (Experimental)

  • Principle: A standalone headless server (code under src/ValleyServerREADME) that loads the decompiled game assemblies and uses reflection/mocking to run without a full game client or GUI.
  • Status: Experimental. It currently still depends on the downloaded Content assets and lacks complete game logic (farming, seasons, NPCs, etc.). See TODO below.
  • Versioning: released as v3.x.

💡 For a full 2.x / 3.x comparison, see docs/version-guide.md (Chinese).

Notes: This repository collects various server hosting solutions, as well as related MODs for running and maintaining unattended servers.
Please do not open issues asking developers to adapt to specific management panels or containerization technologies — those needs are community-driven and out of scope for this repo.
We may support them in the future, but not in this repository.
If you already have a mature deployment solution, you can submit a PR to add your repo to this documentation.
The issues section here only accepts MOD-related feature requests.


✨ Features

  • SMAPI Supported: Compatible with SMAPI, allowing you to add MODs. However, some MODs may have limited compatibility (e.g., may fail to skip cutscenes).
  • Active Development: The community is constantly improving and developing new features.
    Issues and PRs are welcome! Compared to other unattended MOD solutions, ours is the most up-to-date and comprehensive.
  • WebUI + WebVNC Control Panel: The latest Docker deployment ships a simple, clean WebUI and WebVNC to control and manage the server.
  • 3.x Protocol Server (Experimental): A standalone headless server in src/ValleyServer that reverse-engineers and mocks the game protocol. See TODO below.

🌻 Quick Start

  • 2.x (recommended): Use the Docker deployment — see oneclick-script cookbook.
  • 3.x: The reverse-engineered/mock server is still experimental and not recommended for production.

📚 Community Tutorials

🧸 MOD in this repo

MOD Name Description
ALOS Run the game unattended — auto sleep, skip cutscenes, and perform automated actions.
ServerCMD Execute control commands in a headless (no-GUI) server environment.
ChatCommand Run console commands directly from the in-game chat box.
CommandWebUI Use the SMAPI console from a web browser.
ChangeServerPort Change the Stardew Valley server port.

😘 Community

🐧 QQ Groups

QQ Group QQ Group#3 QQ Group#2 QQ Group#1
QQ Channel (Version Release) QQ Group#3

🧰 Acknowledgements

  • SMAPI — for providing modding and game injection capabilities

🎯 TODO

  • 3.x mainline: Write a real protocol server instead of depending on a headless client (we are building an agent to analyze the Stardew Valley source and document the protocol — join us via QQ group or issue). The current src/ValleyServer achieves a headless server via decompile + reflection/mocking, but still requires the downloaded Content assets and lacks full game logic (farming, seasons, NPCs, etc.).
  • 2.x mainline: No near-term expansion of existing MODs, but we hope to add other online "no-co-op" play styles (e.g. HayDay-like), while the MOD-based unattended solution stays as the long-term stable default.

🧮 Star History

Star History Chart

🥰 Contributors


💰 Donate