cpp
/
crown-engine
oglindă de https://github.com/crownengine/crown.git


			
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301
							

<!DOCTYPE html>
<html class="writer-html4" lang="en" >
<head>
  <meta charset="utf-8" />
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  
  <title>Command line reference &mdash; Crown Manual 0.40.0 documentation</title>
  

  <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  <link rel="stylesheet" href="_static/pygments.css" type="text/css" />

  
  <!--[if lt IE 9]>
    <script src="_static/js/html5shiv.min.js"></script>
  <![endif]-->
  
    
      <script type="text/javascript">
          var DOCUMENTATION_OPTIONS = {
              URL_ROOT:'./',
              VERSION:'0.40.0',
              LANGUAGE:'None',
              COLLAPSE_INDEX:false,
              FILE_SUFFIX:'.html',
              HAS_SOURCE:  true,
              SOURCELINK_SUFFIX: ''
          };
      </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/js/theme.js"></script>

    
    <link rel="copyright" title="Copyright" href="copyright.html" />
    <link rel="next" title="License" href="copyright.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" class="icon icon-home"> Crown Manual
          

          </a>

          
              <div class="version">
                0.40.0
              </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"><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="basics.html">Basic concepts</a></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="boot_config.html">boot.config reference</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="">Command line reference</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#examples">Examples</a></li>
<li class="toctree-l2"><a class="reference internal" href="#options">Options</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="copyright.html">License</a></li>
</ul>
<ul>
<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="top navigation">
        
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="index.html">Crown Manual</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" class="icon icon-home"></a> &raquo;</li>
        
      <li>Command line reference</li>
    
    
      <li class="wy-breadcrumbs-aside">
        
          
            <a href="_sources/command_line.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">
            
  <div class="section" id="command-line-reference">
<h1>Command line reference<a class="headerlink" href="#command-line-reference" title="Permalink to this headline">¶</a></h1>
<div class="section" id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h2>
<p>Compile source data from <code class="docutils literal"><span class="pre">/home/user/demo</span></code> using a mapped <code class="docutils literal"><span class="pre">core</span></code> folder.</p>
<div class="code highlight-python"><div class="highlight"><pre>crown-development64 --source-dir /home/user/demo --map-source-dir core /home/user --compile
</pre></div>
</div>
<p>Run the engine using compiled data from <code class="docutils literal"><span class="pre">/home/user/demo_linux</span></code>:</p>
<div class="code highlight-python"><div class="highlight"><pre><span class="n">crown</span><span class="o">-</span><span class="n">development64</span> <span class="o">--</span><span class="n">data</span><span class="o">-</span><span class="nb">dir</span> <span class="o">/</span><span class="n">home</span><span class="o">/</span><span class="n">user</span><span class="o">/</span><span class="n">demo_linux</span>
</pre></div>
</div>
</div>
<div class="section" id="options">
<h2>Options<a class="headerlink" href="#options" title="Permalink to this headline">¶</a></h2>
<dl class="docutils">
<dt><code class="docutils literal"><span class="pre">-h</span></code> <code class="docutils literal"><span class="pre">--help</span></code></dt>
<dd>Display the help and quit.</dd>
<dt><code class="docutils literal"><span class="pre">-v</span></code> <code class="docutils literal"><span class="pre">--version</span></code></dt>
<dd>Display engine version and quit.</dd>
<dt><code class="docutils literal"><span class="pre">--source-dir</span> <span class="pre">&lt;path&gt;</span></code></dt>
<dd><p class="first">Use &lt;path&gt; as the source directory for resource compilation.</p>
<p class="last">The &lt;path&gt; must be absolute.</p>
</dd>
<dt><code class="docutils literal"><span class="pre">--data-dir</span> <span class="pre">&lt;path&gt;</span></code></dt>
<dd><p class="first">Use &lt;path&gt; as the destination directory for compiled resources.</p>
<p class="last">The &lt;path&gt; must be absolute.</p>
</dd>
<dt><code class="docutils literal"><span class="pre">--boot-dir</span> <span class="pre">&lt;path&gt;</span></code></dt>
<dd><p class="first">Boot the engine with the <code class="docutils literal"><span class="pre">boot.config</span></code> from given &lt;path&gt;.</p>
<p class="last">The &lt;path&gt; must be relative.</p>
</dd>
<dt><code class="docutils literal"><span class="pre">--compile</span></code></dt>
<dd><p class="first">Do a full compile of the resources.</p>
<p class="last">When using this option you must also specify <code class="docutils literal"><span class="pre">--platform</span></code>, <code class="docutils literal"><span class="pre">--source-dir</span></code> and <code class="docutils literal"><span class="pre">--data-dir</span></code>.</p>
</dd>
<dt><code class="docutils literal"><span class="pre">--platform</span> <span class="pre">&lt;platform&gt;</span></code></dt>
<dd><p class="first">Compile resources for the given &lt;platform&gt;.
Possible values for &lt;platform&gt; are:</p>
<ul class="last simple">
<li><code class="docutils literal"><span class="pre">android</span></code></li>
<li><code class="docutils literal"><span class="pre">linux</span></code></li>
<li><code class="docutils literal"><span class="pre">windows</span></code></li>
</ul>
</dd>
<dt><code class="docutils literal"><span class="pre">--continue</span></code></dt>
<dd>Run the engine after resource compilation.</dd>
<dt><code class="docutils literal"><span class="pre">--console-port</span> <span class="pre">&lt;port&gt;</span></code></dt>
<dd><p class="first">Set port of the console.</p>
<p class="last">When no port is specified, the engine uses the port 10001.</p>
</dd>
<dt><code class="docutils literal"><span class="pre">--wait-console</span></code></dt>
<dd>Wait for a console connection before starting up.</dd>
<dt><code class="docutils literal"><span class="pre">--parent-window</span> <span class="pre">&lt;handle&gt;</span></code></dt>
<dd><p class="first">Set the parent window &lt;handle&gt; of the main window.</p>
<p class="last">This option should be used only by the tools.</p>
</dd>
<dt><code class="docutils literal"><span class="pre">--server</span></code></dt>
<dd><p class="first">Run the engine in server mode.</p>
<p class="last">When using this option you must also specify <code class="docutils literal"><span class="pre">--source-dir</span></code>.</p>
</dd>
<dt><code class="docutils literal"><span class="pre">--run-unit-tests</span></code></dt>
<dd>Run unit tests and quit. Available only on <code class="docutils literal"><span class="pre">linux</span></code> and <code class="docutils literal"><span class="pre">windows</span></code>.</dd>
</dl>
</div>
</div>


           </div>
           
          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
        <a href="copyright.html" class="btn btn-neutral float-right" title="License" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
      
      
        <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>
      
    </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.

    </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 type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script>

  
</body>
</html>