Create a resource
A resource is a folder with resource.json and Lua files. It can add commands, events, timers, markers, teams, activities, and world metadata.
CaretakerMP Wiki
Install, join, host, recover.
User-facing release guide for private CaretakerMP sessions: Windows launcher setup, Linux hosting, invite import, synced-world install, overlay controls, support packs, player passports, and safe world rollback.
Players2-4
Game portUDP 7777
World portTCP 7778
Buildv0.1.0 / p1
Guides
Choose your path.
Players
Join a private server
Import an invite, run Preflight, install the hosted world, start the game, and use the overlay.
WindowsInstall and play
Use the Windows launcher, install the hook, create support packs, and move your Player Passport.
HostsRun a crew session
Start the Server GUI, publish a world, copy invites, package a friend build, and check session health.
LinuxDedicated server
Set up a small Ubuntu or Debian host with Node.js, systemd, UDP gameplay, and TCP world sync.
ReferenceCommands and hotkeys
Browse player commands, host commands, overlay hotkeys, and server-side Lua resource features.
ScriptingCreate server scripts
Add simple Lua resources for welcome messages, crew commands, markers, checkpoints, teams, and activities.
HelpSupport and rollback
Create sanitized support packs, export a Passport, and restore a local world backup when needed.
Scripting
Customize your private server.
Place it in resources
Put the folder under dist/windows-x64/resources or the custom resources folder selected in Server GUI.
Run Resource Check
Use Server GUI to check scripts before guests join. Then start or reload the resource without repackaging the whole server.
Player flow
Join without guessing.
Get the pack
Extract the host's Friend Pack, then run CaretakerMP.Launcher.exe from the release folder.
Import invite
Copy the host's cmp://join invite, click Import Invite, and let the launcher create the server profile.
Run Preflight
Check runtime files, game path, SaveGames folder, hook files, server version, and world availability before launch.
Preview world
Use Preview World Install to see added, overwritten, unchanged, and local-only SaveGames files before anything is changed.
Install world
The launcher verifies the bundle, creates a World Safety Vault backup, installs the hosted world, and records the expected save label.
Start game
Smart Launch Guard checks that the installed world matches the selected server, then starts Bridge, overlay, and the game.
Host flow
Run a private crew server.
Open Server GUI
Set host, ports, max players, resources folder, save folder, and a private server password.
Run host Preflight
Check files, resources, ports, server health, version, and protocol before inviting friends.
Publish world
Choose a SaveGames folder, enter a shared world name, in-game save label, note, and uploader, then publish.
Copy invite
Create a cmp://join invite and decide whether the private password should be included for trusted friends.
Friend Pack
Build a clean ZIP with exes, assets, resources, hook template, docs, quickstart, manifest, and checksums.
Support Pack
Create a sanitized diagnostics ZIP when a player reports trouble. Passwords, private connection values, paths, and identities are redacted.
Overlay
In-session controls.
F12 / Ctrl+FChat
Open the chat input panel while the passive chat feed stays click-through.
Ctrl+TabCrew
Open the connected-player menu with role, playtime, ping, dimension, and identity details.
Ctrl+ACommands
Open the command browser and see what the current session allows you to use.
Ctrl+HHUD
Open Crew HUD for server status, ping quality, command availability, and recent presence.
Ctrl+DSignal
Open Signal Doctor for Bridge, inbox, snapshot, command, chat, and control-pipe health.
Ctrl+QQuick actions
Send common session commands from one-click controls.
Ctrl+JJournal
Search recent chat, commands, server updates, and player events.
Optional support
Help keep CaretakerMP moving.
CaretakerMP is free to use. A donation is never required and does not unlock anything; it simply helps cover hosting, tooling, and the time that keeps the project polished.
Boundaries
Keep the package clean.
CaretakerMP does not ship game binaries, extracted assets, keys, decrypted content, DRM bypasses, anti-cheat bypasses, or proprietary mappings. Use it with a legitimate local game install.