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.

Windows

Install and play

Use the Windows launcher, install the hook, create support packs, and move your Player Passport.

Hosts

Run a crew session

Start the Server GUI, publish a world, copy invites, package a friend build, and check session health.

Discovery

Publish to the server viewer

Advertise reachable servers to the main-site viewer at /servers.html with live slots, password flag, version, and world label.

Linux

Dedicated server

Set up a small Ubuntu or Debian host with Node.js, systemd, UDP gameplay, and TCP world sync.

Reference

Commands and hotkeys

Browse player commands, host commands, overlay hotkeys, and server-side Lua resource features.

Scripting

Create server scripts

Add simple Lua resources for welcome messages, crew commands, markers, checkpoints, teams, and activities.

Help

Support and rollback

Create sanitized support packs, export a Passport, and restore a local world backup when needed.

Release features

What hosts and players get.

Viewer

Main-site server list

The public viewer lives at /servers.html. Reachable hosts can publish live slots, password status, version, and world label without exposing secrets.

Host

Public-host guard

Server GUI blocks public listing startup for loopback, private, reserved, path-like, and host-with-port values so failed listings are visible immediately.

Sync

Crew sync check

Use Auto second player or /secondplayer after one real player joins to verify snapshots, radar, and cleanup without asking another friend to connect.

Private session proof

Multiplayer presence is already visible.

These private session captures show two connected player signals in the overlay radar, live session messages in chat, and the command browser running inside the game. The core loop is visible: connect, stream a player, communicate, and use session tools without leaving the game.

CaretakerMP private session with two connected players visible on the overlay radar — Two-player private sessionRadar, chat, and in-game world state running together in a private session.

CaretakerMP command browser with player commands — Command browserPlayer-facing commands are discoverable from the overlay.

CaretakerMP chat overlay with join and stream-in messages — Chat overlaySession events and player messages appear inside the game.

Scripting

Customize your private server.

01

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.

02

Place it in resources

Put the folder under dist/windows-x64/resources or the custom resources folder selected in Server GUI.

03

Run Resource Check

Use Server GUI to check scripts before guests join. Then start or reload the resource without repackaging the whole server.

Open the scripting guide

Player flow

Join without guessing.

01

Get the pack

Extract the host's Friend Pack, then run CaretakerMP.Launcher.exe from the CaretakerMP folder.

02

Import invite

Copy the host's cmp://join invite, click Import Invite, and let the launcher create the server profile.

03

Run Preflight

Check runtime files, game path, SaveGames folder, hook files, server version, and world availability before launch.

04

Preview world

Use Preview World to see added, overwritten, unchanged, and local-only SaveGames files before anything is changed.

05

Install world

The launcher verifies the bundle, creates a World Safety Vault backup, installs the hosted world, and records the expected save label.

06

Start game

Smart Launch Guard checks that the installed world matches the selected server, then starts Bridge, the game, and the overlay tied to the exact game PID.

Host flow

Run a private crew server.

01

Open Server GUI

Set host, ports, max players, resources folder, save folder, and a private server password.

02

Run host Preflight

Check files, resources, ports, server health, version, and protocol before inviting friends.

03

Publish world

Choose a SaveGames folder, enter a shared world name, in-game save label, note, and uploader, then publish.

04

Copy invite

Create a cmp://join invite and decide whether the private password should be included for trusted friends.

05

Friend Pack

Build a clean ZIP with exes, assets, resources, hook template, docs, quickstart, manifest, and checksums.

06

Support Pack

Create a sanitized diagnostics ZIP when a player reports trouble. Passwords, private connection values, paths, and identities are redacted.

07

Crew sync check

Enable Auto second player or run /secondplayer Echo me from the host chat to confirm snapshots, radar, and Bridge player updates before inviting more players.

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.

Ctrl+MRadar

Open Radar/Minimap for live local transform, nearby players, streamed entities, markers, checkpoints, and colshape zone markers.

Optional support

Support the project.

CaretakerMP is free to use. A donation is never required and does not unlock anything; it helps cover hosting, tooling, verification time, and the routine maintenance that keeps releases usable.

Support on Buy Me a Coffee

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.