command_line.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237
  1. <!DOCTYPE html>
  2. <html class="writer-html5" lang="en" >
  3. <head>
  4. <meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
  5. <meta property="article:modified_time" content="2024-10-23T20:27:39+00:00" /><meta property="og:title" content="Command line" />
  6. <meta property="og:type" content="website" />
  7. <meta property="og:url" content="https://docs.crownengine.org/html/latest/reference/command_line.html" />
  8. <meta property="og:site_name" content="Crown 0.59.0 Manual" />
  9. <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:-h--help, Display the help ..." />
  10. <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:-h--help, Display the help ..." />
  11. <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  12. <title>Command line &mdash; Crown 0.59.0 Manual 0.59.4 documentation</title>
  13. <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
  14. <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
  15. <link rel="stylesheet" href="../_static/css/custom.css" type="text/css" />
  16. <link rel="shortcut icon" href="../_static/org.crownengine.Crown.svg"/>
  17. <link rel="canonical" href="https://docs.crownengine.org/html/latest/reference/command_line.html" />
  18. <!--[if lt IE 9]>
  19. <script src="../_static/js/html5shiv.min.js"></script>
  20. <![endif]-->
  21. <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
  22. <script src="../_static/jquery.js"></script>
  23. <script src="../_static/underscore.js"></script>
  24. <script src="../_static/doctools.js"></script>
  25. <script src="../_static/js/theme.js"></script>
  26. <link rel="index" title="Index" href="../genindex.html" />
  27. <link rel="search" title="Search" href="../search.html" />
  28. <link rel="copyright" title="Copyright" href="../copyright.html" />
  29. <link rel="next" title="Lua API reference" href="../lua_api.html" />
  30. <link rel="prev" title="boot.config reference" href="boot_config.html" />
  31. </head>
  32. <body class="wy-body-for-nav">
  33. <div class="wy-grid-for-nav">
  34. <nav data-toggle="wy-nav-shift" class="wy-nav-side">
  35. <div class="wy-side-scroll">
  36. <div class="wy-side-nav-search" >
  37. <a href="../index.html">
  38. <img src="../_static/org.crownengine.Crown.svg" class="logo" alt="Logo"/>
  39. </a>
  40. <div class="version">
  41. Crown 0.59.0 Manual
  42. </div>
  43. <div role="search">
  44. <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
  45. <input type="text" name="q" placeholder="Search docs" />
  46. <input type="hidden" name="check_keywords" value="yes" />
  47. <input type="hidden" name="area" value="default" />
  48. </form>
  49. </div>
  50. </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
  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="../installing_crown/index.html">Installing Crown</a></li>
  55. <li class="toctree-l1"><a class="reference internal" href="../getting_started/index.html">Getting Started</a></li>
  56. <li class="toctree-l1"><a class="reference internal" href="../gameplay/index.html">Writing Gameplay</a></li>
  57. <li class="toctree-l1"><a class="reference internal" href="../deploying/index.html">Deploying</a></li>
  58. <li class="toctree-l1 current"><a class="reference internal" href="index.html">Reference</a><ul class="current">
  59. <li class="toctree-l2"><a class="reference internal" href="console_commands.html">Console commands</a></li>
  60. <li class="toctree-l2"><a class="reference internal" href="boot_config.html">boot.config reference</a></li>
  61. <li class="toctree-l2 current"><a class="current reference internal" href="#">Command line</a><ul>
  62. <li class="toctree-l3"><a class="reference internal" href="#examples">Examples</a></li>
  63. <li class="toctree-l3"><a class="reference internal" href="#options">Options</a></li>
  64. </ul>
  65. </li>
  66. </ul>
  67. </li>
  68. <li class="toctree-l1"><a class="reference internal" href="../lua_api.html">Lua API reference</a></li>
  69. <li class="toctree-l1"><a class="reference internal" href="../glossary.html">Glossary</a></li>
  70. <li class="toctree-l1"><a class="reference internal" href="../copyright.html">License</a></li>
  71. <li class="toctree-l1"><a class="reference internal" href="../hackers/index.html">Hackers</a></li>
  72. </ul>
  73. </div>
  74. </div>
  75. </nav>
  76. <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
  77. <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
  78. <a href="../index.html">Crown 0.59.0 Manual</a>
  79. </nav>
  80. <div class="wy-nav-content">
  81. <div class="rst-content">
  82. <div role="navigation" aria-label="Page navigation">
  83. <ul class="wy-breadcrumbs">
  84. <li><a href="../index.html" class="icon icon-home"></a> &raquo;</li>
  85. <li><a href="index.html">Reference</a> &raquo;</li>
  86. <li>Command line</li>
  87. <li class="wy-breadcrumbs-aside">
  88. <a href="../_sources/reference/command_line.rst.txt" rel="nofollow"> View page source</a>
  89. </li>
  90. </ul>
  91. <hr/>
  92. </div>
  93. <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
  94. <div itemprop="articleBody">
  95. <section id="command-line">
  96. <h1>Command line<a class="headerlink" href="#command-line" title="Permalink to this headline">¶</a></h1>
  97. <section id="examples">
  98. <h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h2>
  99. <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>
  100. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span>export CROWN=/home/user/crown
  101. cd $CROWN/platforms/linux64/bin
  102. ./crown-development --compile --continue --source-dir $CROWN/samples/01-physics --map-source-dir core $CROWN/samples
  103. </pre></div>
  104. </div>
  105. <p>Compile and run for HTML5:</p>
  106. <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
  107. </pre></div>
  108. </div>
  109. <p>Compile a “bundled” version of the project:</p>
  110. <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
  111. </pre></div>
  112. </div>
  113. <p>Run the project from bundled data:</p>
  114. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span>./crown-development --data-dir $CROWN/samples/01-physics_linux
  115. </pre></div>
  116. </div>
  117. <p>Customize the data directory name:</p>
  118. <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
  119. </pre></div>
  120. </div>
  121. </section>
  122. <section id="options">
  123. <h2>Options<a class="headerlink" href="#options" title="Permalink to this headline">¶</a></h2>
  124. <dl>
  125. <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>
  126. </dd>
  127. <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>
  128. </dd>
  129. <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>
  130. <p>The &lt;path&gt; must be absolute.</p>
  131. </dd>
  132. <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>
  133. <p>The &lt;path&gt; must be absolute.</p>
  134. </dd>
  135. <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>
  136. <p>The &lt;path&gt; must be absolute.</p>
  137. </dd>
  138. <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>
  139. <p>The &lt;path&gt; must be absolute.</p>
  140. </dd>
  141. <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>
  142. <p>The &lt;path&gt; must be relative.</p>
  143. </dd>
  144. <dt><code class="docutils literal notranslate"><span class="pre">--compile</span></code></dt><dd><p>Do a full compile of the resources.</p>
  145. <p>When using this option you must also specify <code class="docutils literal notranslate"><span class="pre">--source-dir</span></code>.</p>
  146. </dd>
  147. <dt><code class="docutils literal notranslate"><span class="pre">--bundle</span></code></dt><dd><p>Generate bundles after the data has been compiled.</p>
  148. </dd>
  149. <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;.
  150. Possible values for &lt;platform&gt; are:</p>
  151. <ul class="simple">
  152. <li><p><code class="docutils literal notranslate"><span class="pre">android</span></code></p></li>
  153. <li><p><code class="docutils literal notranslate"><span class="pre">html5</span></code></p></li>
  154. <li><p><code class="docutils literal notranslate"><span class="pre">linux</span></code></p></li>
  155. <li><p><code class="docutils literal notranslate"><span class="pre">windows</span></code></p></li>
  156. </ul>
  157. </dd>
  158. <dt><code class="docutils literal notranslate"><span class="pre">--continue</span></code></dt><dd><p>Run the engine after resource compilation.</p>
  159. </dd>
  160. <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>
  161. <p>When no port is specified, the engine uses the port 10001.</p>
  162. </dd>
  163. <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>
  164. </dd>
  165. <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>
  166. <p>This option should be used only by the tools.</p>
  167. </dd>
  168. <dt><code class="docutils literal notranslate"><span class="pre">--server</span></code></dt><dd><p>Run the engine in server mode.</p>
  169. <p>When using this option you must also specify <code class="docutils literal notranslate"><span class="pre">--source-dir</span></code>.</p>
  170. </dd>
  171. <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>
  172. </dd>
  173. <dt><code class="docutils literal notranslate"><span class="pre">--hidden</span></code></dt><dd><p>Make the main window initially invisible.</p>
  174. </dd>
  175. <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>
  176. </dd>
  177. <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>
  178. </dd>
  179. <dt><code class="docutils literal notranslate"><span class="pre">--run-unit-tests</span></code></dt><dd><p>Run unit tests and quit.</p>
  180. </dd>
  181. </dl>
  182. </section>
  183. </section>
  184. </div>
  185. </div>
  186. <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
  187. <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>
  188. <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>
  189. </div>
  190. <hr/>
  191. <div role="contentinfo">
  192. <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.
  193. <span class="lastupdated">Last updated on Oct 23, 2024.
  194. </span></p>
  195. </div>
  196. Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
  197. <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
  198. provided by <a href="https://readthedocs.org">Read the Docs</a>.
  199. </footer>
  200. </div>
  201. </div>
  202. </section>
  203. </div>
  204. <script>
  205. jQuery(function () {
  206. SphinxRtdTheme.Navigation.enable(true);
  207. });
  208. </script>
  209. <!-- Theme Analytics -->
  210. <script async src="https://www.googletagmanager.com/gtag/js?id=G-XNVGCMNDZH"></script>
  211. <script>
  212. window.dataLayer = window.dataLayer || [];
  213. function gtag(){dataLayer.push(arguments);}
  214. gtag('js', new Date());
  215. gtag('config', 'G-XNVGCMNDZH', {
  216. 'anonymize_ip': true,
  217. });
  218. </script>
  219. </body>
  220. </html>