WorldSnapshot Guide

This page introduces WorldSnapshot as a public staff guide. It focuses on what the tool does, how authorized staff get started, and which commands are useful.

What It Does

WorldSnapshot is a read-only operational tool for recording what the server thinks each loaded world looks like right now.

How Staff Use It

Start with /worldsnapshot. The sections below explain what WorldSnapshot is for, which commands authorized staff can use, and what its output means.

Available features include:

• Captures Paper world settings for each loaded included world.
• Captures all gamerules through Paper’s current game-rule registry.
• Captures selected volatile runtime fields such as time, storm, players, and loaded chunks for display.
• Excludes volatile runtime fields from diffs by default so time/weather/player movement does not create noisy diffs.
• Scans selected CMI YAML files for world-related and operational toggle paths.
• Shows a compact world list with environment, difficulty, the animal spawn limit, monster spawning, autosave, and distance settings.
• Shows detailed entries for one world with pagination.
• Compares the current state against the stored baseline.

Quick Start

1. Start with /worldsnapshot to open or view WorldSnapshot.
2. Use /worldsnapshot status to check your current progress, settings, or state.
3. Use /worldsnapshot help when you want the in-game help or a short explanation.
4. Try /worldsnapshot refresh when you are ready to use one of the feature actions.

Commands

Command	What it does	Example
/worldsnapshot	Opens or shows the main WorldSnapshot player view.	/worldsnapshot
/worldsnapshot help	Shows the WorldSnapshot commands available to you.	/worldsnapshot help
/worldsnapshot status	Shows your current WorldSnapshot status.	/worldsnapshot status
/worldsnapshot refresh	Runs the WorldSnapshot refresh action.	/worldsnapshot refresh
/worldsnapshot list [page]	Lists available WorldSnapshot entries.	/worldsnapshot list
/worldsnapshot world <world> [page]	Runs the WorldSnapshot world action.	/worldsnapshot world example
/worldsnapshot diff [world|all] [page]	Runs the WorldSnapshot diff action.	/worldsnapshot diff
/worldsnapshot dump	Runs the WorldSnapshot dump action.	/worldsnapshot dump

Aliases

• /wsnapshot
• /wrules

Examples

• /worldsnapshot
• /worldsnapshot status
• /worldsnapshot list
• /worldsnapshot world spawn
• /worldsnapshot diff
• /worldsnapshot diff spawn
• /worldsnapshot dump

Good To Know

• This is a permission-gated staff or server-management feature, not a normal player feature.
• Review the full reference before changing settings or using any command that can write data.

Full Reference

The full synced WorldSnapshot reference is available for exact technical details.