Quick Start
Run authoritative, headless Schedule I servers and build server/client mods against the same in-repo documentation set.
Download the Release
- Download the latest release from GitHub Releases.
- Use
Mono-Server.zipfor Mono dedicated server installs. - Use
Mono-Client.zipfor Mono game installs that will connect to dedicated servers. - Use
Il2cpp_Server.zipfor IL2CPP dedicated server installs. - Use
Il2cpp_Client.zipfor IL2CPP game installs that will connect to dedicated servers.
Compatibility
- Server and client should use matching Schedule I builds.
- Supported MelonLoader versions are
0.6.x,0.7.0, and0.7.2+. - Avoid MelonLoader
0.7.1. 0.9.0-betaadds initial IL2CPP support for both dedicated-server and client installs. Expect rough edges, and report IL2CPP issues on the GitHub issue tracker with logs and reproduction steps.- Windows is the primary target for server hosting. Linux hosting typically requires Wine or Proton.
Host Sizing Baseline
The smallest host size currently known to run a mostly idle server is a VPS with:
2vCPUs at around2.0 GHz4 GBRAM
That baseline has only been observed to handle a server with 0-1 connected players, at roughly 72% average CPU usage and about 3.0 GB RAM in use. Treat it as a bare-minimum starting point, not as a comfortable production target.
If you expect multiple players, CPU spikes during save/load, extra mods, or virtualization overhead from a budget VPS, provision more headroom.
Docker Deployment
For containerized hosting, use the Docker release package and follow Docker Deployment.
Docker.zip intentionally contains only the Docker template files. Copy Mods/DedicatedServerMod_Mono_Server.dll from Mono-Server.zip into that Docker folder before running docker build.
Docker deployment currently targets the Mono server artifact; use Il2cpp_Server.zip for native IL2CPP installs outside Docker.
Create a Server Install
- Copy your Schedule I game folder to a new location. This becomes the dedicated server install.
- Extract
Mono-Server.zipinto that server install for Mono, orIl2cpp_Server.zipfor IL2CPP. - Confirm that
Mods/merged into the install andstart_server.batwas placed at the install root. - Run
start_server.batonce so the mod generatesserver_config.toml, then close it. - Edit
server_config.tomland setsaveGamePath. - Start the server again with
start_server.bat.
For save path details, see Save Path.
Prepare a Client Install
- Use your main game install, or another separate client copy.
- Extract
Mono-Client.zipfor Mono orIl2cpp_Client.zipfor IL2CPP so the includedMods/contents merge into that install. - Launch the game normally and connect to the server.
After First Boot
- Overview
- Configuration to harden and tune the server
- Authentication
- Host Console for panel-hosted stdin/stdout administration
- Web Panel for local browser-based administration
- Troubleshooting if startup or connection fails
- API Reference