Files
Commonwealth-Online-Server/README.md
T
NomadsReach 0accc17b66 Retire the Qt/C++ host; ship the Avalonia host
Delete the Qt host (src/, cmake/, CMakeLists.txt, find-qt.bat, check-setup.bat,
build.bat, deploy.bat) now that the Avalonia host in host/ covers it on the same
dotnet toolchain. Add a self-hosted host-build CI job and a host README, and
rewrite the top-level README for the C# server + Avalonia host layout.
2026-08-16 18:24:14 -04:00

43 lines
1.3 KiB
Markdown

# Commonwealth Online — Server & Host
The dedicated server and its host GUI for Commonwealth Online (Fallout 4
multiplayer). Everything now builds on one .NET 8 toolchain.
## Components
- **[`server/`](server/README.md)** — the dedicated relay server
(`CommonwealthOnline.Server`, a .NET 8 console app). Run it with
`server/start.sh` / `server/start.bat`, or `CommonwealthOnline.Server serve`.
- **[`host/`](host/README.md)** — the **Avalonia** cross-platform host GUI:
start/stop the server, edit config, watch the log, and manage players
(kick/ban). Replaces the former Qt/C++ host.
## Quick start — server
```bash
cd server
./start.sh # Linux / macOS
start.bat # Windows
```
Needs the .NET 8 runtime (or the SDK for a source checkout). Allow TCP `7777`
(and optionally UDP `7778` for LAN discovery) through the firewall. `0.0.0.0`
is a bind address, not the address players join.
## Quick start — host GUI
```bash
dotnet run --project host/CommonwealthOnline.Host.csproj
```
## Build
```bash
dotnet build server/CommonwealthOnline.Server.csproj -c Release
dotnet build host/CommonwealthOnline.Host.csproj -c Release
```
> The Qt/C++ host and its CMake build were retired in favour of the Avalonia
> host. `SETUP.md` / `DEVELOPMENT.md` / `DEPLOYMENT.md` are from the Qt era and
> are pending a refresh.