command_line.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305
  1. <!DOCTYPE html>
  2. <html class="writer-html4" lang="en" >
  3. <head>
  4. <meta charset="utf-8" />
  5. <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  6. <title>Command line reference &mdash; Crown Manual 0.45.0 documentation</title>
  7. <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  8. <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
  9. <!--[if lt IE 9]>
  10. <script src="_static/js/html5shiv.min.js"></script>
  11. <![endif]-->
  12. <script type="text/javascript">
  13. var DOCUMENTATION_OPTIONS = {
  14. URL_ROOT:'./',
  15. VERSION:'0.45.0',
  16. LANGUAGE:'None',
  17. COLLAPSE_INDEX:false,
  18. FILE_SUFFIX:'.html',
  19. HAS_SOURCE: true,
  20. SOURCELINK_SUFFIX: ''
  21. };
  22. </script>
  23. <script type="text/javascript" src="_static/jquery.js"></script>
  24. <script type="text/javascript" src="_static/underscore.js"></script>
  25. <script type="text/javascript" src="_static/doctools.js"></script>
  26. <script type="text/javascript" src="_static/js/theme.js"></script>
  27. <link rel="copyright" title="Copyright" href="copyright.html" />
  28. <link rel="next" title="Glossary" href="glossary.html" />
  29. <link rel="prev" title="boot.config reference" href="boot_config.html" />
  30. </head>
  31. <body class="wy-body-for-nav">
  32. <div class="wy-grid-for-nav">
  33. <nav data-toggle="wy-nav-shift" class="wy-nav-side">
  34. <div class="wy-side-scroll">
  35. <div class="wy-side-nav-search" >
  36. <a href="index.html">
  37. <img src="_static/crown-logo-white.svg" class="logo" alt="Logo"/>
  38. </a>
  39. <div class="version">
  40. 0.45.0
  41. </div>
  42. <div role="search">
  43. <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
  44. <input type="text" name="q" placeholder="Search docs" />
  45. <input type="hidden" name="check_keywords" value="yes" />
  46. <input type="hidden" name="area" value="default" />
  47. </form>
  48. </div>
  49. </div>
  50. <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
  51. <ul class="current">
  52. <li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li>
  53. <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</a></li>
  54. <li class="toctree-l1"><a class="reference internal" href="basics.html">Basic concepts</a></li>
  55. <li class="toctree-l1"><a class="reference internal" href="lua_api.html">Lua API reference</a></li>
  56. <li class="toctree-l1"><a class="reference internal" href="boot_config.html">boot.config reference</a></li>
  57. <li class="toctree-l1 current"><a class="current reference internal" href="">Command line reference</a><ul>
  58. <li class="toctree-l2"><a class="reference internal" href="#examples">Examples</a></li>
  59. <li class="toctree-l2"><a class="reference internal" href="#options">Options</a></li>
  60. </ul>
  61. </li>
  62. <li class="toctree-l1"><a class="reference internal" href="glossary.html">Glossary</a></li>
  63. <li class="toctree-l1"><a class="reference internal" href="copyright.html">License</a></li>
  64. </ul>
  65. <ul>
  66. <li class="toctree-l1"><a class="reference internal" href="hackers/index.html">Hackers</a></li>
  67. </ul>
  68. </div>
  69. </div>
  70. </nav>
  71. <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
  72. <nav class="wy-nav-top" aria-label="top navigation">
  73. <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
  74. <a href="index.html">Crown Manual</a>
  75. </nav>
  76. <div class="wy-nav-content">
  77. <div class="rst-content">
  78. <div role="navigation" aria-label="breadcrumbs navigation">
  79. <ul class="wy-breadcrumbs">
  80. <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
  81. <li>Command line reference</li>
  82. <li class="wy-breadcrumbs-aside">
  83. <a href="_sources/command_line.txt" rel="nofollow"> View page source</a>
  84. </li>
  85. </ul>
  86. <hr/>
  87. </div>
  88. <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
  89. <div itemprop="articleBody">
  90. <div class="section" id="command-line-reference">
  91. <h1>Command line reference<a class="headerlink" href="#command-line-reference" title="Permalink to this headline">¶</a></h1>
  92. <div class="section" id="examples">
  93. <h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h2>
  94. <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>
  95. <div class="code highlight-python"><div class="highlight"><pre>crown-development64 --source-dir /home/user/demo --map-source-dir core /home/user --compile
  96. </pre></div>
  97. </div>
  98. <p>Run the engine using compiled data from <code class="docutils literal"><span class="pre">/home/user/demo_linux</span></code>:</p>
  99. <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>
  100. </pre></div>
  101. </div>
  102. </div>
  103. <div class="section" id="options">
  104. <h2>Options<a class="headerlink" href="#options" title="Permalink to this headline">¶</a></h2>
  105. <dl class="docutils">
  106. <dt><code class="docutils literal"><span class="pre">-h</span></code> <code class="docutils literal"><span class="pre">--help</span></code></dt>
  107. <dd>Display the help and quit.</dd>
  108. <dt><code class="docutils literal"><span class="pre">-v</span></code> <code class="docutils literal"><span class="pre">--version</span></code></dt>
  109. <dd>Display engine version and quit.</dd>
  110. <dt><code class="docutils literal"><span class="pre">--source-dir</span> <span class="pre">&lt;path&gt;</span></code></dt>
  111. <dd><p class="first">Use &lt;path&gt; as the source directory for resource compilation.</p>
  112. <p class="last">The &lt;path&gt; must be absolute.</p>
  113. </dd>
  114. <dt><code class="docutils literal"><span class="pre">--data-dir</span> <span class="pre">&lt;path&gt;</span></code></dt>
  115. <dd><p class="first">Use &lt;path&gt; as the destination directory for compiled resources.</p>
  116. <p class="last">The &lt;path&gt; must be absolute.</p>
  117. </dd>
  118. <dt><code class="docutils literal"><span class="pre">--boot-dir</span> <span class="pre">&lt;path&gt;</span></code></dt>
  119. <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>
  120. <p class="last">The &lt;path&gt; must be relative.</p>
  121. </dd>
  122. <dt><code class="docutils literal"><span class="pre">--compile</span></code></dt>
  123. <dd><p class="first">Do a full compile of the resources.</p>
  124. <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>
  125. </dd>
  126. <dt><code class="docutils literal"><span class="pre">--platform</span> <span class="pre">&lt;platform&gt;</span></code></dt>
  127. <dd><p class="first">Compile resources for the given &lt;platform&gt;.
  128. Possible values for &lt;platform&gt; are:</p>
  129. <ul class="last simple">
  130. <li><code class="docutils literal"><span class="pre">android</span></code></li>
  131. <li><code class="docutils literal"><span class="pre">linux</span></code></li>
  132. <li><code class="docutils literal"><span class="pre">windows</span></code></li>
  133. </ul>
  134. </dd>
  135. <dt><code class="docutils literal"><span class="pre">--continue</span></code></dt>
  136. <dd>Run the engine after resource compilation.</dd>
  137. <dt><code class="docutils literal"><span class="pre">--console-port</span> <span class="pre">&lt;port&gt;</span></code></dt>
  138. <dd><p class="first">Set port of the console.</p>
  139. <p class="last">When no port is specified, the engine uses the port 10001.</p>
  140. </dd>
  141. <dt><code class="docutils literal"><span class="pre">--wait-console</span></code></dt>
  142. <dd>Wait for a console connection before starting up.</dd>
  143. <dt><code class="docutils literal"><span class="pre">--parent-window</span> <span class="pre">&lt;handle&gt;</span></code></dt>
  144. <dd><p class="first">Set the parent window &lt;handle&gt; of the main window.</p>
  145. <p class="last">This option should be used only by the tools.</p>
  146. </dd>
  147. <dt><code class="docutils literal"><span class="pre">--server</span></code></dt>
  148. <dd><p class="first">Run the engine in server mode.</p>
  149. <p class="last">When using this option you must also specify <code class="docutils literal"><span class="pre">--source-dir</span></code>.</p>
  150. </dd>
  151. <dt><code class="docutils literal"><span class="pre">--run-unit-tests</span></code></dt>
  152. <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>
  153. </dl>
  154. </div>
  155. </div>
  156. </div>
  157. </div>
  158. <footer>
  159. <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
  160. <a href="glossary.html" class="btn btn-neutral float-right" title="Glossary" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
  161. <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>
  162. </div>
  163. <hr/>
  164. <div role="contentinfo">
  165. <p>
  166. &#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.
  167. </p>
  168. </div>
  169. Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
  170. <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
  171. provided by <a href="https://readthedocs.org">Read the Docs</a>.
  172. </footer>
  173. </div>
  174. </div>
  175. </section>
  176. </div>
  177. <script type="text/javascript">
  178. jQuery(function () {
  179. SphinxRtdTheme.Navigation.enable(true);
  180. });
  181. </script>
  182. </body>
  183. </html>