GeyserWebsite/_site/geyser/geyser-command-line-arguments-and-system-properties/index.html

<!doctype html>
<html lang="en" data-bs-theme="dark">
  <head>
    <meta charset="utf-8">
	<meta http-equiv='X-UA-Compatible' content='IE=edge'>
    <meta name="viewport" content="width=device-width, initial-scale=1">

    <title>GeyserMC Wiki: Geyser Command Line Arguments and System Properties</title>

    <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.0-alpha1/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-GLhlTQ8iRABdZLl6O3oVMWSktQOp6b7In1Zl3/Jr59b6EGGoI1aFkw7cmDA6j6gD" crossorigin="anonymous">
	<link href="https://cdn.jsdelivr.net/npm/bootstrap-icons@1.10.3/font/bootstrap-icons.css" rel="stylesheet">
	<link href="https://fonts.googleapis.com/css?family=Montserrat&display=swap" rel="stylesheet">
	<link rel="stylesheet" href="/css/style.css">
	<link rel="stylesheet" href="/css/darcula.css">

	<meta name="author" content="GeyserMC">
	<meta name="description" content="This is the wiki for all of GeyserMC's projects.">
	<meta name="theme-color" content="#2b3035">

	<meta property="og:type" content="website">
	<meta property="og:url" content="http://localhost:4000">
	<meta property="og:title" content="GeyserMC Wiki: Geyser Command Line Arguments and System Properties">
	<meta property="og:description" content="This is the wiki for all of GeyserMC's projects.">
	<meta property="og:image" content="/android-chrome-192x192.png">

	<link rel="shortcut icon" type="image/x-icon" href="/favicon.ico">
	<link rel="icon" type="image/x-icon" href="/favicon.ico">

	<link rel="icon" type="image/png" sizes="16x16" href="/favicon-16x16.png">
	<link rel="icon" type="image/png" sizes="32x32" href="/favicon-32x32.png">
	<link rel="icon" type="image/png" sizes="192x192" href="/android-chrome-192x192.png">
	<link rel="apple-touch-icon" href="/apple-touch-icon.png">
	<link rel="mask-icon" href="/safari-pinned-tab.svg" color="#248f00">
  </head>
  <body>
	<header>
		<nav class="navbar navbar-expand-lg bg-body-tertiary fixed-top">
			<div class="container-fluid">
				<a class="navbar-brand" href="/"><img src="/android-chrome-512x512.png" alt="geyser logo" height="32"> GeyserMC Wiki</a>
				<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbarLinks" aria-controls="navbarLinks" aria-expanded="false" aria-label="Toggle navigation">
				  <span class="navbar-toggler-icon"></span>
				</button>
				<div class="collapse navbar-collapse" id="navbarLinks">
					<ul class="navbar-nav ms-auto mb-2 mb-lg-0">
						<li class="nav-item">
							<a class="nav-link" href="https://geysermc.org/"><i class="bi bi-house pe-1"></i> Home</a>
						</li>
						<li class="nav-item">
							<a class="nav-link" href="https://geysermc.org/download"><i class="bi bi-download pe-1"></i> Download</a>
						</li>
					</ul>
					<form class="d-flex" role="search" action="/search/">
						<div class="input-group">
							<button class="btn btn-outline-secondary" type="submit" id="button-search"><i class="bi bi-search"></i></button>
							<input type="text" name="q" class="form-control" placeholder="Search the site..." aria-label="Search the site..." aria-describedby="button-search">
						</div>
					</form>
				</div>
			</div>
		</nav>
	</header>
	<div id="page-content" class="container-fluid">
		<div class="row">
			<div class="col-12 col-md-3 col-xl-2">
				<div class="sticky-top">
					<div class="sidebar py-2 text-break">
						<nav class="navbar navbar-expand-md">
	<div class="container-fluid">
		<div class="d-block d-md-none">Wiki Navigation</div>
		<button class="navbar-toggler mb-2" type="button" data-bs-toggle="collapse" data-bs-target="#sidebarNav" aria-controls="sidebarNav" aria-expanded="false" aria-label="Toggle navigation">
			<span class="navbar-toggler-icon"></span>
		</button>
		<div class="collapse navbar-collapse flex-column align-items-start" id="sidebarNav">




			<div class="nav-item dropdown">
				<a class="nav-link dropdown-toggle fw-bold show" href="#" role="button" data-bs-toggle="dropdown" data-bs-auto-close="false" aria-expanded="false">Geyser Documentation</a>
				<ul class="pe-3 pt-0 dropdown-menu position-relative border-0 list-disc show">

						<li class="ms-4">
							<a href="/geyser/setup/">Setting up Geyser</a>

								<ul>

										<li>
											<a href="/geyser/supported-hosting-providers/">Supported Hosting Providers</a>
										</li>

										<li>
											<a href="/geyser/using-geyser-with-consoles/">Using Geyser with Consoles</a>
										</li>

										<li>
											<a href="/geyser/playit-gg/">Using playit.gg with Geyser</a>
										</li>

										<li>
											<a href="/geyser/creating-a-startup-script/">Creating a Startup Script</a>
										</li>

								</ul>

						</li>

						<li class="ms-4">
							<a href="/geyser/common-issues/">Common Issues</a>

								<ul>

										<li>
											<a href="/geyser/fixing-unable-to-connect-to-world/">Fixing 'Unable to Connect to World'</a>
										</li>

								</ul>

						</li>

						<li class="ms-4">
							<a href="/geyser/understanding-the-config/">Configuring Geyser</a>

								<ul>

										<li>
											<a href="/geyser/commands/">Commands</a>
										</li>

										<li>
											<a href="/geyser/geyser-command-line-arguments-and-system-properties/">Geyser Command Line Arguments and System Properties</a>
										</li>

								</ul>

						</li>

						<li class="ms-4">
							<a href="/geyser/faq/">FAQ</a>

								<ul>

										<li>
											<a href="/geyser/anticheat-compatibility/">Anticheat Compatibility</a>
										</li>

										<li>
											<a href="/geyser/current-limitations/">Current Limitations</a>
										</li>

								</ul>

						</li>

						<li class="ms-4">
							<a href="/geyser/custom-items/">Custom items with Geyser</a>

								<ul>

										<li>
											<a href="/geyser/custom-items/#json-mappings">JSON mappings</a>
										</li>

										<li>
											<a href="/geyser/custom-items/#geyser-extensions">Geyser extensions</a>
										</li>

										<li>
											<a href="/geyser/custom-items/#resource-pack">Resource pack</a>
										</li>

								</ul>

						</li>

						<li class="ms-4">
							<a href="/geyser/custom-blocks/">Custom blocks with Geyser</a>

								<ul>

										<li>
											<a href="/geyser/custom-blocks/#enabling-custom-blocks">Enabling custom blocks</a>
										</li>

										<li>
											<a href="/geyser/custom-blocks/#json-mappings">JSON mappings</a>
										</li>

										<li>
											<a href="/geyser/custom-blocks/#geyser-extensions">Geyser extensions</a>
										</li>

								</ul>

						</li>

						<li class="ms-4">
							<a href="/geyser/custom-skulls/">Custom skulls with Geyser</a>

								<ul>

										<li>
											<a href="/geyser/custom-skulls/#enabling-custom-skulls">Enabling custom skulls</a>
										</li>

										<li>
											<a href="/geyser/custom-skulls/#custom-skullsyml">custom-skulls.yml</a>
										</li>

								</ul>

						</li>

						<li class="ms-4">
							<a href="/geyser/api/">Geyser API</a>

								<ul>

										<li>
											<a href="/geyser/getting-started-with-the-api/">Getting Started</a>
										</li>

										<li>
											<a href="/geyser/api/#short-overview-of-the-geyser-api">Overview</a>
										</li>

										<li>
											<a href="/geyser/events/">Events</a>
										</li>

										<li>
											<a href="/geyser/forms/">Forms and Cumulus</a>
										</li>

								</ul>

						</li>

						<li class="ms-4">
							<a href="/geyser/extensions/">Geyser Extensions</a>

								<ul>

										<li>
											<a href="/geyser/extensions/#creating-the-main-class">Main class</a>
										</li>

										<li>
											<a href="/geyser/extensions/#creating-commands-with-geyser-extensions">Creating Commands</a>
										</li>

								</ul>

						</li>

						<li class="ms-4">
							<a href="/geyser/global-api/">Global API</a>

						</li>

				</ul>
			</div>




			<div class="nav-item dropdown">
				<a class="nav-link dropdown-toggle fw-bold" href="#" role="button" data-bs-toggle="dropdown" data-bs-auto-close="false" aria-expanded="false">Floodgate Documentation</a>
				<ul class="pe-3 pt-0 dropdown-menu position-relative border-0 list-disc">

						<li class="ms-4">
							<a href="/floodgate/setup/">Setup</a>

						</li>

						<li class="ms-4">
							<a href="/floodgate/issues/">Issues</a>

						</li>

						<li class="ms-4">
							<a href="/floodgate/faq/">FAQ</a>

						</li>

						<li class="ms-4">
							<a href="/floodgate/features/">Features</a>

								<ul>

										<li>
											<a href="/floodgate/features/#whitelist-command">Whitelist command</a>
										</li>

										<li>
											<a href="/floodgate/commands/">Commands</a>
										</li>

										<li>
											<a href="/floodgate/features/#what-is-skin-uploading">Skin Uploading</a>
										</li>

								</ul>

						</li>

						<li class="ms-4">
							<a href="/floodgate/api/">Floodgate API</a>

								<ul>

										<li>
											<a href="/floodgate/player/">FloodgatePlayer</a>
										</li>

										<li>
											<a href="/geyser/forms/">Forms and Cumulus</a>
										</li>

								</ul>

						</li>

						<li class="ms-4">
							<a href="/floodgate/linking/">Linking</a>

								<ul>

										<li>
											<a href="/floodgate/linking/#what-is-global-linking">Global Linking</a>
										</li>

										<li>
											<a href="/floodgate/linking/#local-linking">Local Linking</a>
										</li>

								</ul>

						</li>

				</ul>
			</div>




			<div class="nav-item dropdown">
				<a class="nav-link dropdown-toggle fw-bold" href="#" role="button" data-bs-toggle="dropdown" data-bs-auto-close="false" aria-expanded="false">Other</a>
				<ul class="pe-3 pt-0 dropdown-menu position-relative border-0 list-disc">

						<li class="ms-4">
							<a href="/other/geyseroptionalpack/">GeyserOptionalPack</a>

						</li>

						<li class="ms-4">
							<a href="/other/hurricane/">Hurricane</a>

						</li>

						<li class="ms-4">
							<a href="/other/geyserconnect/">GeyserConnect</a>

						</li>

						<li class="ms-4">
							<a href="/other/community-geyser-projects/">Community Geyser Projects</a>

						</li>

						<li class="ms-4">
							<a href="/other/test-server/">Test Server</a>

						</li>

						<li class="ms-4">
							<a href="/other/developer-guide/">Developer Guide</a>

						</li>

						<li class="ms-4">
							<a href="/other/discord-bot-usage/">Geyser Discord Bot Usage</a>

						</li>

				</ul>
			</div>

		</div>
	</div>
</nav>
					</div>
				</div>
			</div>
			<main class="col-12 col-md-9 col-xl-8" role="main">
				<nav aria-label="breadcrumb">
    <ol class="breadcrumb">




                <li class="breadcrumb-item"><a href="http://localhost:4000/geyser/">Geyser</a></li>




                <li class="breadcrumb-item active" aria-current="page">Geyser Command Line Arguments and System Properties</li>


    </ol>
</nav>

<h1 id="geyser-command-line-arguments-and-system-properties">Geyser Command Line Arguments and System Properties</h1>
<p>Geyser offers a few command line arguments/system properties to allow you to configure Geyser without editing the config files.
Additionally, you can suppress some warnings that may be printed to the console.</p>

<h3 id="configuration-system-properties">Configuration system properties</h3>
<p>You can set Geyser to automatically bind to a specific address and port by using the following command line arguments. <br />
This is primarily aimed at server hosting providers to automatically configure servers for users.</p>

<div class="alert alert-info" role="alert">
    Note: the Geyser specific properties are prioritized over the plugin properties!
</div>

<ul>
  <li><code class="language-plaintext highlighter-rouge">-DgeyserUdpPort=server</code> or <code class="language-plaintext highlighter-rouge">-DpluginUdpPort=server</code>
    <ul>
      <li><code class="language-plaintext highlighter-rouge">-1</code> means UDP is not supported and will forcibly stop Geyser.</li>
      <li><code class="language-plaintext highlighter-rouge">server</code> means to match the port of the TCP server.</li>
      <li>any other number means to use that specific port</li>
    </ul>
  </li>
  <li><code class="language-plaintext highlighter-rouge">-DgeyserUdpAddress=server</code> or <code class="language-plaintext highlighter-rouge">-DpluginUdpAddress=server</code>
    <ul>
      <li><code class="language-plaintext highlighter-rouge">server</code> means to match the bind address of the TCP server</li>
      <li>any other string will be used as-is for the bind address.</li>
    </ul>
  </li>
</ul>

<h3 id="disabling-warnings-and-advanced-configuration">Disabling warnings and advanced configuration</h3>
<p>You may disable some warnings that may be printed to the console by using the following command line arguments:</p>

<div class="alert alert-danger" role="alert">
    Warning: Disabling Geyser warnings from being logged will not fix the real issue! Only disable them if you know what you are doing.
</div>

<ul>
  <li><code class="language-plaintext highlighter-rouge">-DGeyser.PrintSecureChatInformation=true</code>
    <ul>
      <li>Allows you to disable the warning about secure chat being disabled.
Since the warning is sent when the server sends the warning, this option does not do much anymore.</li>
    </ul>
  </li>
  <li><code class="language-plaintext highlighter-rouge">-DGeyser.ShowScoreboardLogs=true</code>
    <ul>
      <li>Allows you to disable warnings related to scoreboards, such as “Tried to update score without the existence of its requested objective”.</li>
    </ul>
  </li>
  <li><code class="language-plaintext highlighter-rouge">-DGeyser.ShowResourcePackLengthWarning=true</code>
    <ul>
      <li>Allows you to disable the warning about a resource pack having too long paths. Disabling this warning will not fix the underlying issue!
Console players might not be able to join your server at all if you have a resource pack with paths exceeding the 80 character limit.</li>
    </ul>
  </li>
  <li><code class="language-plaintext highlighter-rouge">-DGeyser.PrintPingsInDebugMode=true</code>
    <ul>
      <li>Controls if pings are being logged in debug mode.</li>
    </ul>
  </li>
  <li><code class="language-plaintext highlighter-rouge">-DGeyser.UseDirectAdapters=true</code>
    <ul>
      <li>Allows you to disable the usage of NMS adapters. Disabling will result in a performance penalty and should only be used for debugging.
This is Spigot-only and will not work on other platforms.</li>
    </ul>
  </li>
  <li><code class="language-plaintext highlighter-rouge">-DGeyser.BedrockNetworkThreads=8</code>
    <ul>
      <li>Allows you to set the number of threads used for the Bedrock networking. This is not set to a specific number by default, but is instead calculated based on the available resources.</li>
    </ul>
  </li>
  <li><code class="language-plaintext highlighter-rouge">-DGeyser.AddTeamSuggestions=true</code>
    <ul>
      <li>Allows you to turn off suggestions for teams in the scoreboard command. This is enabled by default, disabling this can help with performance if there are a lot of teams defined.
Setting “command-suggestions” to false in the config will also disable this.</li>
    </ul>
  </li>
</ul>

<h2 id="geyser-standalone-specific-options">Geyser-Standalone specific options:</h2>

<h4 id="--config-file"><code class="language-plaintext highlighter-rouge">--config [file]</code></h4>
<ul>
  <li><strong>Alias: <code class="language-plaintext highlighter-rouge">-c</code></strong></li>
  <li>Points to an alternative config file to use.</li>
</ul>

<h4 id="--gui----nogui"><code class="language-plaintext highlighter-rouge">--gui</code> / <code class="language-plaintext highlighter-rouge">--nogui</code></h4>
<ul>
  <li><strong>Alias: <code class="language-plaintext highlighter-rouge">gui</code> / <code class="language-plaintext highlighter-rouge">nogui</code></strong>:</li>
  <li>Forces GUI or non-GUI usage, depending on context.</li>
</ul>

<h3 id="overriding-specific-config-values">Overriding specific config values</h3>
<p>Overriding a standard config option (e.g. <code class="language-plaintext highlighter-rouge">command-suggestions</code>):</p>

<p><code class="language-plaintext highlighter-rouge">--command-suggestions=false</code></p>

<p>Overriding a nested config option(e.g. the <code class="language-plaintext highlighter-rouge">remote</code> section with <code class="language-plaintext highlighter-rouge">address</code>):</p>

<p><code class="language-plaintext highlighter-rouge">--remote.address=test.geysermc.org</code></p>


			</main>
			<div class="col-2 d-none d-xl-block">
				<div class="sticky-top">
					<div class="sidebar py-2">
						<a class="d-block text-decoration-none" href="https://github.com/GeyserMC/GeyserWiki/edit/master/_docs/geyser/geyser-command-line-arguments-and-system-properties.md" target="_blank"><i class="bi bi-pencil"></i> Edit this page</a>
<a class="d-block text-decoration-none" href="https://github.com/GeyserMC/GeyserWiki/issues/new?labels=question&title=Question:&body=Question on: _docs/geyser/geyser-command-line-arguments-and-system-properties.md" target="_blank"><i class="bi bi-github"></i> Create Wiki issue/bug report</a>
<a class="d-block text-decoration-none" href="/issues/new" target="_blank"><i class="bi bi-list-check"></i> Create Geyser issue/bug report</a>

<div id="page-nav" class="py-3 "></div>

					</div>
				</div>
			</div>
		</div>
	</div>
	<!-- <footer class="p-4 text-center bg-body-tertiary">
		&copy; 2023 GeyserMC
	</footer> -->
    <script src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.0-alpha1/dist/js/bootstrap.bundle.min.js" integrity="sha384-w76AqPfDkMBDXo30jS1Sgez6pr3x5MlQ1ZAGC+nuZB+EYdgRZgiwxhTBTkF7CXvN" crossorigin="anonymous"></script>
	<script src="/js/page-nav.js"></script>
  </body>
</html>