Skip to main content
The Minecraft Web Client can be configured using URL query parameters. These allow you to customize behavior, pre-configure connections, and enable special features.
Press Y in-game to set query parameters to the URL based on your current game state.

​
General Parameters

​
Setting Configuration

​
setting
string
default:"undefined"
Set and lock specific settings on load. Can be used multiple times for multiple settings.Format: setting=<setting_name>:<setting_value>Examples:
?setting=autoParkour:true
?setting=renderDistance:4&setting=fov:90
Settings configured via URL parameters are locked and cannot be changed in-game until the parameter is removed.
​
modal
string
default:"undefined"
Open a specific modal on page load. Use , as path separator for nested modals.Examples:
?modal=keybindings
?modal=options,video
To get the currently opened modal, type in console: activeModalStack.at(-1).reactType

​
Replay Session

​
replayFileUrl
string
default:"undefined"
Load and start a packet replay session from a URL. The file must be CORS enabled.Example:
?replayFileUrl=https://example.com/replay.dat
Use with other replay parameters for fine-tuned control:
  • replayFilter - Filter packets by name pattern
  • replaySpeed - Playback speed multiplier
  • replayValidateClient - Validate client state
  • replayStopOnError - Stop on validation errors
  • replaySkipMissingOnTimeout - Skip missing packets
  • replayPacketsSenderDelay - Delay between packets (ms)

​
Multiplayer Parameters

These parameters configure multiplayer connections.

​
Server Connection

​
ip
string
default:"undefined"
Pre-fill server address in the connect screen. Port can be added with :<port>.Examples:
?ip=play.example.com
?ip=192.168.1.100:25565
​
name
string
default:"undefined"
Set the server name for saving to the server list.Example:
?ip=play.example.com&name=My%20Favorite%20Server
​
version
string
default:"undefined"
Set the Minecraft version to use for the connection.Examples:
?version=1.20.4
?version=1.19.4
​
proxy
string
default:"undefined"
Set the proxy server address to use for connecting to Java servers.Examples:
?proxy=https://proxy.example.com
?proxy=http://localhost:8080
The proxy server bridges WebSocket connections from the browser to TCP Minecraft servers.
​
username
string
default:"undefined"
Pre-fill the username for the connection.Example:
?username=Steve

​
Connection Control

​
lockConnect
boolean
default:"false"
Only works when ip parameter is set. Disables cancel/save buttons and all inputs in the connect screen.Use case: Embedded iframes where you want to force specific server connection.Example:
?ip=play.example.com&version=1.20.4&lockConnect=true
​
autoConnect
boolean
default:"false"
Automatically connect to the specified server. Requires ip and version parameters, and allowAutoConnect must be enabled in config.json.Example:
?ip=play.example.com&version=1.20.4&autoConnect=true
Auto-connect must be explicitly enabled in the app configuration for security reasons.
​
serversList
string
default:"undefined"
Load a custom server list from a comma-separated list or URL.Formats:
  • Inline: ip:version,ip:version
  • JSON URL: URL to array of servers
  • Text URL: Line-delimited list of IPs
Examples:
?serversList=play.hypixel.net:1.20.4,mc.mineplex.com:1.19.4
?serversList=https://example.com/servers.json
?serversList=https://example.com/servers.txt
​
addPing
number
default:"0"
Add artificial latency to both sides of the connection for testing.Example:
?addPing=100
This adds 200ms total to your ping (100ms each way).

​
Singleplayer Parameters

These parameters control singleplayer world loading and creation.

​
Quick Start

​
singleplayer
boolean
default:"false"
Create an empty world on load. Nothing will be saved to browser storage.Aliases: spExamples:
?singleplayer=1
?sp=1&version=1.20.4
​
loadSave
string
default:"undefined"
Load a saved world by folder name (not title) on page load.Example:
?loadSave=MyWorld-2024

​
World Loading

​
map
string
default:"undefined"
Load a world from a ZIP file URL. The URL must be CORS enabled.Example:
?map=https://example.com/world.zip
ZIP files are loaded entirely into RAM. There is a ~300 MB file limit on iOS.
​
mapDir
string
default:"undefined"
Load a world from a file descriptor. This is the recommended and fastest way to load worlds but requires setup.Format: URL to JSON file or base64 encoded JSONJSON Structure:
{
  "baseUrl": "https://example.com/world/",
  "index": {
    "level.dat": null,
    "region": {
      "r.-1.-1.mca": null,
      "r.-1.0.mca": null,
      "r.0.-1.mca": null,
      "r.0.0.mca": null
    }
  }
}
Examples:
?mapDir=https://example.com/world/index.json
?mapDir=data:application/json;base64,eyJiYXNlVXJsIjoi...
​
mapDirBaseUrl
string
default:"undefined"
Specify the base URL for fetching files when using base64 encoded mapDir.Example:
?mapDir=data:application/json;base64,...&mapDirBaseUrl=https://example.com/world/
​
mapVersion
string
default:"undefined"
Specify the Minecraft version for the loaded map.Example:
?map=https://example.com/world.zip&mapVersion=1.19.4

​
Server Configuration

​
serverSetting
string
default:"undefined"
Set local server options. Can be used multiple times.Format: serverSetting=<key>:<value>Example:
?serverSetting=noInitialChunksSend:true
?serverSetting=gameMode:1&serverSetting=difficulty:2
See space-squid options for available settings.
​
noSave
boolean
default:"false"
Disable auto-save on unload/disconnect/export. Only manual save with /save command will work.Example:
?singleplayer=1&noSave=true

​
Resource Packs

​
texturepack
string
default:"undefined"
Load a specific texture pack on startup.Example:
?texturepack=faithful32x

​
Development Parameters

These parameters are only available in development mode.
​
reconnect
boolean
default:"false"
Automatically reconnect to the server on page reloads. Very useful for server testing.Example:
?reconnect=true
​
playground
boolean
default:"false"
Load the world renderer playground for testing.

​
Peer Connection Parameters

​
connectPeer
string
default:"undefined"
Connect to a peer-hosted world using their peer ID.Example:
?connectPeer=abc123-def456
​
peerVersion
string
default:"undefined"
Specify the version for peer connection.Example:
?connectPeer=abc123&peerVersion=1.20.4

​
Benchmark Parameters

​
openBenchmark
boolean
default:"false"
Open the benchmark tool on load.
​
benchmarkMapZipUrl
string
default:"undefined"
URL to a world ZIP file for benchmarking.
​
benchmarkPosition
string
default:"undefined"
Starting position for the benchmark (format: x,y,z).
​
downloadBenchmark
boolean
default:"false"
Automatically download benchmark results.

​
Advanced Parameters

​
command
string
default:"undefined"
Execute a command on startup. Can be used multiple times.Example:
?command=/time set day
​
viewerConnect
string
default:"undefined"
Connect to a remote bot viewer session.
​
onlyConnect
boolean
default:"false"
Show only the connect screen, hiding other options.
​
connectText
string
default:"undefined"
Custom text to display on the connect screen.
​
freezeSettings
boolean
default:"false"
Prevent settings from being changed.
​
parentFrameMods
boolean
default:"false"
Enable parent frame modifications (for embedded usage).

​
Examples

https://mcraft.fun/?ip=mc.hypixel.net&version=1.20.4&autoConnect=true

​
See Also

Build docs developers (and LLMs) love

Get started for freeTalk to us