<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Creating a Launch Script — Sponge 6.0.0 documentation</title>
<link rel="shortcut icon" href="../../_static/favicon.ico"/>
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../_static/spongedocs.css" type="text/css" />
<link rel="index" title="Index"
href="../../genindex.html"/> <link rel="search" title="Search" href="../../search.html"/> <link rel="top" title="Sponge 6.0.0 documentation" href="../../index.html"/> <link rel="up" title="Getting Started" href="index.html"/> <link rel="next" title="Port Forwarding" href="port-forward.html"/> <link rel="prev" title="Installing SpongeVanilla" href="implementations/spongevanilla.html"/>
<!-- Google Analytics -->
<script>
(function(S,p,o,n,g,i,e){S['GoogleAnalyticsObject']=g;S[g]=S[g]||function(){
(S[g].q=S[g].q||[]).push(arguments)},S[g].l=1*new Date();i=p.createElement(o),
e=p.getElementsByTagName(o)[0];i.async=1;i.src=n;e.parentNode.insertBefore(i,e)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-59476017-2', 'auto');
ga('send', 'pageview');
</script>
<script src="../../_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<div id="sp-logo-container" class="page-scroll">
<a class="logo" href="../../index.html">
<img src="../../_static/spongie-mark-dark.svg">
<span>Sponge</span>
<i class="fa fa-fw fa-chevron-down"></i>
</a>
<div id="sp-logo-menu">
<ul id="sp-logo-dropdown">
<li><a href="https://www.spongepowered.org"><i class="fa-fw fa fa-home"></i>Homepage</a></li>
<li><a href="https://forums.spongepowered.org"><i class="fa-fw fa fa-comments"></i>Forums</a></li>
<li><a href="https://github.com/SpongePowered"><i class="fa-fw fa fa-code"></i>Code</a></li>
<li class="active"><a href="https://docs.spongepowered.org"><i class="fa-fw fa fa-book"></i>Docs</a></li>
<li><a href="https://jd.spongepowered.org"><i class="fa-fw fa fa-graduation-cap"></i>Javadocs</a></li>
<li><a href="https://forums.spongepowered.org/c/plugins/plugin-releases"><i class="fa-fw fa fa-plug"></i>Plugins</a></li>
<li><a href="https://www.spongepowered.org/downloads"><i class="fa-fw fa fa-download"></i>Downloads</a></li>
<li><a href="https://www.spongepowered.org/chat"><i class="fa-fw fa fa-comment"></i>Chat</a></li>
</ul>
</div>
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div> </div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../index.html">Creating a Server</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="index.html">Getting Started</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="jre.html">Installing Java</a></li>
<li class="toctree-l3"><a class="reference internal" href="migrating.html">Migrating to Sponge</a></li>
<li class="toctree-l3"><a class="reference internal" href="implementations/index.html">Choosing an Implementation</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">Creating a Launch Script</a></li>
<li class="toctree-l3"><a class="reference internal" href="port-forward.html">Port Forwarding</a></li>
<li class="toctree-l3"><a class="reference internal" href="bungeecord.html">Using Sponge with BungeeCord</a></li>
<li class="toctree-l3"><a class="reference internal" href="configuration/index.html">Configuring Sponge</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../management/index.html">Server Management</a></li>
<li class="toctree-l2"><a class="reference internal" href="../spongineer/index.html">Becoming an Expert Spongineer</a></li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../preparing/index.html">Preparing for Development</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../plugin/index.html">Creating a Plugin</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../ore/index.html">Ore Documentation</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../contributing/index.html">Contributing to Sponge</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../about/index.html">About the Sponge Project</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../index.html">Sponge</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../index.html">Docs</a> »</li>
<li><a href="../index.html">Creating a Server</a> »</li>
<li><a href="index.html">Getting Started</a> »</li>
<li>Creating a Launch Script</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/SpongePowered/SpongeDocs/blob/fix/https/source/server/getting-started/launch-script.rst" class="fa fa-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="creating-a-launch-script">
<h1>Creating a Launch Script<a class="headerlink" href="#creating-a-launch-script" title="Permalink to this headline">¶</a></h1>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">These instructions apply only if you plan to run your Minecraft server on your own machine. Most shared Minecraft
hosts will create a launch script for you.</p>
</div>
<div class="section" id="writing-a-launch-script">
<h2>Writing a Launch Script<a class="headerlink" href="#writing-a-launch-script" title="Permalink to this headline">¶</a></h2>
<p>First, open a text editor such as Atom, Sublime Text, or Notepad. Write (or paste) a launch script for your server.
Examples of simple launch scripts for Windows, macOS, and Linux have been provided below. Keep the RAM limitations
of your machine in mind.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">The following examples are generic. For a Forge server using Sponge (coremod), change <code class="docutils literal"><span class="pre">forge-1.8-XYZ-universal.jar</span></code>
to whatever your Forge version in the server directory is named. To launch a SpongeVanilla server, change
<code class="docutils literal"><span class="pre">forge-1.8-XYZ-universal.jar</span></code> to the name of the SpongeVanilla.jar file.</p>
</div>
<div class="section" id="windows">
<h3>Windows<a class="headerlink" href="#windows" title="Permalink to this headline">¶</a></h3>
<div class="highlight-none"><div class="highlight"><pre><span></span>java -Xms1G -Xmx2G -jar forge-1.8-XYZ-universal.jar
pause
</pre></div>
</div>
<p>Save your Windows launch script as <code class="docutils literal"><span class="pre">launch.bat</span></code>.</p>
</div>
<div class="section" id="macos">
<h3>macOS<a class="headerlink" href="#macos" title="Permalink to this headline">¶</a></h3>
<div class="highlight-none"><div class="highlight"><pre><span></span>#!/bin/bash
cd "$(dirname "$0")"
java -Xms1G -Xmx2G -jar forge-1.8-XYZ-universal.jar
</pre></div>
</div>
<p>Save your Mac launch script as <code class="docutils literal"><span class="pre">launch.command</span></code>.</p>
</div>
<div class="section" id="linux">
<h3>Linux<a class="headerlink" href="#linux" title="Permalink to this headline">¶</a></h3>
<div class="highlight-none"><div class="highlight"><pre><span></span>#!/bin/sh
cd "$(dirname "$(readlink -fn "$0")")"
java -Xms1G -Xmx2G -jar forge-1.8-XYZ-universal.jar
</pre></div>
</div>
<p>Save your Linux launch script as <code class="docutils literal"><span class="pre">launch.sh</span></code>.</p>
</div>
</div>
<div class="section" id="running-a-launch-script">
<h2>Running a Launch Script<a class="headerlink" href="#running-a-launch-script" title="Permalink to this headline">¶</a></h2>
<p>Ensure you are running your launch script out of a folder created especially for your server. This is for your own
sanity; unfortunately, Spongie is unable to soak up your tears if you do not do this.</p>
<p>You may run your launch script by double-clicking it. If you are using a console or terminal, navigate to the directory
of the script and run it. Keep in mind that you must agree to the Mojang EULA in order to run a server.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">The default Minecraft server GUI console is disabled by Sponge, because it is very processor-intensive.</p>
</div>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p>If you get a permissions error when attempting to launch your server on a Mac, try this:</p>
<ul class="last simple">
<li>Open the Terminal.</li>
<li>Type <code class="docutils literal"><span class="pre">chmod</span> <span class="pre">a+x</span></code>, with a space at the end.</li>
<li>Drag your launch script to the Terminal.</li>
<li>Press enter.</li>
</ul>
</div>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="port-forward.html" class="btn btn-neutral float-right" title="Port Forwarding" accesskey="n" rel="next">Next <span class="fa fa-angle-right"></span></a>
<a href="implementations/spongevanilla.html" class="btn btn-neutral" title="Installing SpongeVanilla" accesskey="p" rel="prev"><span class="fa fa-angle-left"></span> Previous</a>
</div>
<hr/>
<section id="license">
<p>Except where otherwise noted,
<a xmlns:dct="http://purl.org/dc/terms/" xmlns:cc="http://creativecommons.org/ns#" property="dct:title" rel="cc:attributionURL" href="https://github.com/SpongePowered/SpongeDocs">SpongeDocs</a>
is licensed under a <a rel="license" href="https://creativecommons.org/licenses/by-sa/4.0/">Creative Commons Attribution-ShareAlike 4.0 International License</a>.
</p>
<a id="license-icons" rel="license" href="https://creativecommons.org/licenses/by-sa/4.0/" title="CC-BY-SA" aria-hidden="true">cba</a>
</section>
</footer> </div>
</div>
</section>
</div>
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<i class="fa fa-book"> <span>SpongeDocs</span></i>
v: 6.0.0
<span class="fa fa-caret-down"></span>
</span>
<div id="versions" class="rst-other-versions">
<dl>
<dt>Contribute</dt>
<dd><a href="https://github.com/SpongePowered/SpongeDocs/blob/fix/https/source/server/getting-started/launch-script.rst">Source</a></dd>
<dd><a href="https://github.com/SpongePowered/SpongeDocs/edit/fix/https/source/server/getting-started/launch-script.rst">Edit</a></dd>
</dl>
</div>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../',
VERSION:'6.0.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
};
</script> <script type="text/javascript" src="../../_static/jquery.js"></script> <script type="text/javascript" src="../../_static/underscore.js"></script> <script type="text/javascript" src="../../_static/doctools.js"></script> <script type="text/javascript" src="../../_static/spongedocs.js"></script>
<script type="text/javascript" src="../../_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>