cpp
/
crown-engine
mirror of https://github.com/crownengine/crown.git


			
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242
							<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
  <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />

    <meta property="article:modified_time" content="2025-10-13T23:06:03+00:00" /><meta property="og:title" content="Command line" />
<meta property="og:type" content="website" />
<meta property="og:url" content="https://docs.crownengine.org/html/latest/reference/command_line.html" />
<meta property="og:site_name" content="Crown 0.60.0 Manual" />
<meta property="og:description" content="Examples: Compile and run the project/home/user/crown/samples/01-physics using a mapped core folder: Compile and run for HTML5: Compile a “bundled” version of the project: Run the project from bundled data: Customize the data directory name: Options:--, End of the runtime’s op..." />
<meta name="description" content="Examples: Compile and run the project/home/user/crown/samples/01-physics using a mapped core folder: Compile and run for HTML5: Compile a “bundled” version of the project: Run the project from bundled data: Customize the data directory name: Options:--, End of the runtime’s op..." />

  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <title>Command line &mdash; Crown 0.60.0 Manual 0.60.0 documentation</title>
      <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
      <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
      <link rel="stylesheet" href="../_static/css/custom.css" type="text/css" />
    <link rel="shortcut icon" href="../_static/org.crownengine.Crown.svg"/>
    <link rel="canonical" href="https://docs.crownengine.org/html/latest/reference/command_line.html" />
  <!--[if lt IE 9]>
    <script src="../_static/js/html5shiv.min.js"></script>
  <![endif]-->
  
        <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
        <script src="../_static/jquery.js"></script>
        <script src="../_static/underscore.js"></script>
        <script src="../_static/doctools.js"></script>
    <script src="../_static/js/theme.js"></script>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="copyright" title="Copyright" href="../copyright.html" />
    <link rel="next" title="Lua API reference" href="../lua_api.html" />
    <link rel="prev" title="boot.config reference" href="boot_config.html" /> 
</head>

<body class="wy-body-for-nav"> 
  <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" >
            <a href="../index.html">
            <img src="../_static/org.crownengine.Crown.svg" class="logo" alt="Logo"/>
          </a>
              <div class="version">
                Crown 0.60.0 Manual
              </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="Navigation menu">
              <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../changelog.html">Changelog</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../installing_crown/index.html">Installing Crown</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting_started/index.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../importing_resources/index.html">Importing Resources</a></li>
<li class="toctree-l1"><a class="reference internal" href="../gameplay/index.html">Writing Gameplay</a></li>
<li class="toctree-l1"><a class="reference internal" href="../deploying/index.html">Deploying</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="console_commands.html">Console commands</a></li>
<li class="toctree-l2"><a class="reference internal" href="boot_config.html">boot.config reference</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Command line</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#examples">Examples</a></li>
<li class="toctree-l3"><a class="reference internal" href="#options">Options</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../lua_api.html">Lua API reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="../glossary.html">Glossary</a></li>
<li class="toctree-l1"><a class="reference internal" href="../copyright.html">License</a></li>
<li class="toctree-l1"><a class="reference internal" href="../hackers/index.html">Hackers</a></li>
</ul>

        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="../index.html">Crown 0.60.0 Manual</a>
      </nav>

      <div class="wy-nav-content">
        <div class="rst-content">
          <div role="navigation" aria-label="Page navigation">
  <ul class="wy-breadcrumbs">
      <li><a href="../index.html" class="icon icon-home"></a> &raquo;</li>
          <li><a href="index.html">Reference</a> &raquo;</li>
      <li>Command line</li>
      <li class="wy-breadcrumbs-aside">
            <a href="../_sources/reference/command_line.rst.txt" rel="nofollow"> View page source</a>
      </li>
  </ul>
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
             
  <section id="command-line">
<h1>Command line<a class="headerlink" href="#command-line" title="Permalink to this headline">¶</a></h1>
<section id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h2>
<p>Compile and run the project <code class="docutils literal notranslate"><span class="pre">/home/user/crown/samples/01-physics</span></code> using a mapped <code class="docutils literal notranslate"><span class="pre">core</span></code> folder:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>export CROWN=/home/user/crown
cd $CROWN/platforms/linux64/bin
./crown-development --compile --continue --source-dir $CROWN/samples/01-physics --map-source-dir core $CROWN/samples
</pre></div>
</div>
<p>Compile and run for HTML5:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>./crown-development --compile --continue --platform html5 --source-dir $CROWN/samples/01-physics --map-source-dir core $CROWN/samples
</pre></div>
</div>
<p>Compile a “bundled” version of the project:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>./crown-development --compile --bundle --source-dir $CROWN/samples/01-physics --map-source-dir core $CROWN/samples
</pre></div>
</div>
<p>Run the project from bundled data:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>./crown-development --data-dir $CROWN/samples/01-physics_linux
</pre></div>
</div>
<p>Customize the data directory name:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>./crown-development --compile --data-dir $CROWN/samples/01-physics_custom --source-dir $CROWN/samples/01-physics --map-source-dir core $CROWN/samples
</pre></div>
</div>
</section>
<section id="options">
<h2>Options<a class="headerlink" href="#options" title="Permalink to this headline">¶</a></h2>
<dl>
<dt><code class="docutils literal notranslate"><span class="pre">--</span></code></dt><dd><p>End of the runtime’s options.</p>
<p>All options following <code class="docutils literal notranslate"><span class="pre">--</span></code> are passed to the game but will not be
interpreted by the runtime.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">-h</span></code> <code class="docutils literal notranslate"><span class="pre">--help</span></code></dt><dd><p>Display the help and quit.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">-v</span></code> <code class="docutils literal notranslate"><span class="pre">--version</span></code></dt><dd><p>Display engine version and quit.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--source-dir</span> <span class="pre">&lt;path&gt;</span></code></dt><dd><p>Use &lt;path&gt; as the source directory for resource compilation.</p>
<p>The &lt;path&gt; must be absolute.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--data-dir</span> <span class="pre">&lt;path&gt;</span></code></dt><dd><p>Run with the data located at &lt;path&gt;.</p>
<p>The &lt;path&gt; must be absolute.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--bundle-dir</span> <span class="pre">&lt;path&gt;</span></code></dt><dd><p>Run with the bundles located at &lt;path&gt;.</p>
<p>The &lt;path&gt; must be absolute.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--map-source-dir</span> <span class="pre">&lt;name&gt;</span> <span class="pre">&lt;path&gt;</span></code></dt><dd><p>Mount &lt;path&gt;/&lt;name&gt; at &lt;source-dir&gt;/&lt;name&gt;.</p>
<p>The &lt;path&gt; must be absolute.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--boot-dir</span> <span class="pre">&lt;path&gt;</span></code></dt><dd><p>Boot the engine with the <code class="docutils literal notranslate"><span class="pre">boot.config</span></code> from given &lt;path&gt;.</p>
<p>The &lt;path&gt; must be relative.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--compile</span></code></dt><dd><p>Do a full compile of the resources.</p>
<p>When using this option you must also specify <code class="docutils literal notranslate"><span class="pre">--source-dir</span></code>.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--bundle</span></code></dt><dd><p>Generate bundles after the data has been compiled.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--platform</span> <span class="pre">&lt;platform&gt;</span></code></dt><dd><p>Compile resources for the given &lt;platform&gt;.
Possible values for &lt;platform&gt; are:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">android</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">html5</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">linux</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">windows</span></code></p></li>
</ul>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--continue</span></code></dt><dd><p>Run the engine after resource compilation.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--console-port</span> <span class="pre">&lt;port&gt;</span></code></dt><dd><p>Set port of the console.</p>
<p>When no port is specified, the engine uses the port 10001.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--wait-console</span></code></dt><dd><p>Wait for a console connection before starting up.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--parent-window</span> <span class="pre">&lt;handle&gt;</span></code></dt><dd><p>Set the parent window &lt;handle&gt; of the main window.</p>
<p>This option should be used only by the tools.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--server</span></code></dt><dd><p>Run the engine in server mode.</p>
<p>When using this option you must also specify <code class="docutils literal notranslate"><span class="pre">--source-dir</span></code>.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--pumped</span></code></dt><dd><p>Do not advance the renderer unless explicitly requested via console.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--hidden</span></code></dt><dd><p>Make the main window initially invisible.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--window-rect</span> <span class="pre">&lt;x</span> <span class="pre">y</span> <span class="pre">w</span> <span class="pre">h&gt;</span></code></dt><dd><p>Sets the main window’s position and size.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--string-id</span> <span class="pre">&lt;string&gt;</span></code></dt><dd><p>Print the 32- and 64-bits IDs of &lt;string&gt;.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">--run-unit-tests</span></code></dt><dd><p>Run unit tests and quit.</p>
</dd>
</dl>
</section>
</section>


           </div>
          </div>
          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
        <a href="boot_config.html" class="btn btn-neutral float-left" title="boot.config reference" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
        <a href="../lua_api.html" class="btn btn-neutral float-right" title="Lua API reference" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
    </div>

  <hr/>

  <div role="contentinfo">
    <p>&#169; <a href="../copyright.html">Copyright</a> Except where otherwise noted, content on this page is licensed under a CC-BY-SA 4.0 Int. License.
      <span class="lastupdated">Last updated on Oct 13, 2025.
      </span></p>
  </div>

  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
    provided by <a href="https://readthedocs.org">Read the Docs</a>.
   

</footer>
        </div>
      </div>
    </section>
  </div>
  <script>
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script>
    <!-- Theme Analytics -->
    <script async src="https://www.googletagmanager.com/gtag/js?id=G-XNVGCMNDZH"></script>
    <script>
      window.dataLayer = window.dataLayer || [];
      function gtag(){dataLayer.push(arguments);}
      gtag('js', new Date());

      gtag('config', 'G-XNVGCMNDZH', {
          'anonymize_ip': true,
      });
    </script> 

</body>
</html>