2
0

boot_config.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209
  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="2025-08-14T13:57:37+00:00" /><meta property="og:title" content="boot.config reference" />
  6. <meta property="og:type" content="website" />
  7. <meta property="og:url" content="https://docs.crownengine.org/html/latest/reference/boot_config.html" />
  8. <meta property="og:site_name" content="Crown 0.60.0 Manual" />
  9. <meta property="og:description" content="Generic configurations: boot_script = &quot;lua/game&quot;, Lua script to launch on boot.,, boot_package = &quot;boot&quot;, Package to load on boot.,, render_config = &quot;core/renderer/default&quot;, Render configuration to use.,, window_title = &quot;My window&quot;, Title..." />
  10. <meta name="description" content="Generic configurations: boot_script = &quot;lua/game&quot;, Lua script to launch on boot.,, boot_package = &quot;boot&quot;, Package to load on boot.,, render_config = &quot;core/renderer/default&quot;, Render configuration to use.,, window_title = &quot;My window&quot;, Title..." />
  11. <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  12. <title>boot.config reference &mdash; Crown 0.60.0 Manual 0.60.0 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/boot_config.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="Command line" href="command_line.html" />
  30. <link rel="prev" title="Console commands" href="console_commands.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.60.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="../importing_resources/index.html">Importing Resources</a></li>
  57. <li class="toctree-l1"><a class="reference internal" href="../gameplay/index.html">Writing Gameplay</a></li>
  58. <li class="toctree-l1"><a class="reference internal" href="../deploying/index.html">Deploying</a></li>
  59. <li class="toctree-l1 current"><a class="reference internal" href="index.html">Reference</a><ul class="current">
  60. <li class="toctree-l2"><a class="reference internal" href="console_commands.html">Console commands</a></li>
  61. <li class="toctree-l2 current"><a class="current reference internal" href="#">boot.config reference</a><ul>
  62. <li class="toctree-l3"><a class="reference internal" href="#generic-configurations">Generic configurations</a></li>
  63. <li class="toctree-l3"><a class="reference internal" href="#platform-specific-configurations">Platform-specific configurations</a><ul>
  64. <li class="toctree-l4"><a class="reference internal" href="#renderer-configurations">Renderer configurations</a></li>
  65. <li class="toctree-l4"><a class="reference internal" href="#physics-configurations">Physics configurations</a></li>
  66. </ul>
  67. </li>
  68. </ul>
  69. </li>
  70. <li class="toctree-l2"><a class="reference internal" href="command_line.html">Command line</a></li>
  71. </ul>
  72. </li>
  73. <li class="toctree-l1"><a class="reference internal" href="../lua_api.html">Lua API reference</a></li>
  74. <li class="toctree-l1"><a class="reference internal" href="../glossary.html">Glossary</a></li>
  75. <li class="toctree-l1"><a class="reference internal" href="../copyright.html">License</a></li>
  76. <li class="toctree-l1"><a class="reference internal" href="../hackers/index.html">Hackers</a></li>
  77. </ul>
  78. </div>
  79. </div>
  80. </nav>
  81. <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
  82. <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
  83. <a href="../index.html">Crown 0.60.0 Manual</a>
  84. </nav>
  85. <div class="wy-nav-content">
  86. <div class="rst-content">
  87. <div role="navigation" aria-label="Page navigation">
  88. <ul class="wy-breadcrumbs">
  89. <li><a href="../index.html" class="icon icon-home"></a> &raquo;</li>
  90. <li><a href="index.html">Reference</a> &raquo;</li>
  91. <li>boot.config reference</li>
  92. <li class="wy-breadcrumbs-aside">
  93. <a href="../_sources/reference/boot_config.rst.txt" rel="nofollow"> View page source</a>
  94. </li>
  95. </ul>
  96. <hr/>
  97. </div>
  98. <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
  99. <div itemprop="articleBody">
  100. <section id="boot-config-reference">
  101. <h1>boot.config reference<a class="headerlink" href="#boot-config-reference" title="Permalink to this headline">¶</a></h1>
  102. <section id="generic-configurations">
  103. <h2>Generic configurations<a class="headerlink" href="#generic-configurations" title="Permalink to this headline">¶</a></h2>
  104. <dl class="simple">
  105. <dt><code class="docutils literal notranslate"><span class="pre">boot_script</span> <span class="pre">=</span> <span class="pre">&quot;lua/game&quot;</span></code></dt><dd><p>Lua script to launch on boot.</p>
  106. </dd>
  107. <dt><code class="docutils literal notranslate"><span class="pre">boot_package</span> <span class="pre">=</span> <span class="pre">&quot;boot&quot;</span></code></dt><dd><p>Package to load on boot.</p>
  108. </dd>
  109. <dt><code class="docutils literal notranslate"><span class="pre">render_config</span> <span class="pre">=</span> <span class="pre">&quot;core/renderer/default&quot;</span></code></dt><dd><p>Render configuration to use.</p>
  110. </dd>
  111. <dt><code class="docutils literal notranslate"><span class="pre">window_title</span> <span class="pre">=</span> <span class="pre">&quot;My</span> <span class="pre">window&quot;</span></code></dt><dd><p>Title of the main window on platforms that support it.</p>
  112. </dd>
  113. </dl>
  114. </section>
  115. <section id="platform-specific-configurations">
  116. <h2>Platform-specific configurations<a class="headerlink" href="#platform-specific-configurations" title="Permalink to this headline">¶</a></h2>
  117. <p>All configurations for a given <em>platform</em> are placed under a key named <em>platform</em>. E.g.:</p>
  118. <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">//</span> <span class="n">Linux</span><span class="o">-</span><span class="n">only</span> <span class="n">configs</span>
  119. <span class="n">linux</span> <span class="o">=</span> <span class="p">{</span>
  120. <span class="n">renderer</span> <span class="o">=</span> <span class="p">{</span>
  121. <span class="n">resolution</span> <span class="o">=</span> <span class="p">[</span> <span class="mi">1280</span> <span class="mi">720</span> <span class="p">]</span>
  122. <span class="n">aspect_ratio</span> <span class="o">=</span> <span class="o">-</span><span class="mi">1</span>
  123. <span class="n">vsync</span> <span class="o">=</span> <span class="n">true</span>
  124. <span class="p">}</span>
  125. <span class="p">}</span>
  126. </pre></div>
  127. </div>
  128. <section id="renderer-configurations">
  129. <h3>Renderer configurations<a class="headerlink" href="#renderer-configurations" title="Permalink to this headline">¶</a></h3>
  130. <dl class="simple">
  131. <dt><code class="docutils literal notranslate"><span class="pre">resolution</span> <span class="pre">=</span> <span class="pre">[</span> <span class="pre">1280</span> <span class="pre">720</span> <span class="pre">]</span></code></dt><dd><p>Sets the width and height of the main window.</p>
  132. </dd>
  133. <dt><code class="docutils literal notranslate"><span class="pre">aspect_ratio</span> <span class="pre">=</span> <span class="pre">-1</span></code></dt><dd><p>Sets the aspect ratio.
  134. If the value is set to <code class="docutils literal notranslate"><span class="pre">-1</span></code>, the aspect ratio is computed as <code class="docutils literal notranslate"><span class="pre">width/height</span></code> of the main window.</p>
  135. </dd>
  136. <dt><code class="docutils literal notranslate"><span class="pre">vsync</span> <span class="pre">=</span> <span class="pre">true</span></code></dt><dd><p>Sets whether to enable the vsync.</p>
  137. </dd>
  138. <dt><code class="docutils literal notranslate"><span class="pre">fullscreen</span> <span class="pre">=</span> <span class="pre">false</span></code></dt><dd><p>Sets whether to enable fullscreen.</p>
  139. </dd>
  140. </dl>
  141. </section>
  142. <section id="physics-configurations">
  143. <h3>Physics configurations<a class="headerlink" href="#physics-configurations" title="Permalink to this headline">¶</a></h3>
  144. <dl class="simple">
  145. <dt><code class="docutils literal notranslate"><span class="pre">step_frequency</span> <span class="pre">=</span> <span class="pre">60</span></code></dt><dd><p>The frequency at which the physics simulation is stepped.
  146. Higher values means a more accurate simulation at the expense of compute time.</p>
  147. </dd>
  148. <dt><code class="docutils literal notranslate"><span class="pre">max_substeps</span> <span class="pre">=</span> <span class="pre">4</span></code></dt><dd><p>Maximum number of physics sub-steps allowed in a frame.
  149. A value of 4 at 60 Hz means the physics simulation is allowed to simulate up to ~0.067 seconds (4/60) worth of physics per frame.
  150. If one frame takes longer than <code class="docutils literal notranslate"><span class="pre">max_substeps/step_frequency</span></code> then physics will appear slowed down.</p>
  151. </dd>
  152. </dl>
  153. </section>
  154. </section>
  155. </section>
  156. </div>
  157. </div>
  158. <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
  159. <a href="console_commands.html" class="btn btn-neutral float-left" title="Console commands" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
  160. <a href="command_line.html" class="btn btn-neutral float-right" title="Command line" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
  161. </div>
  162. <hr/>
  163. <div role="contentinfo">
  164. <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.
  165. <span class="lastupdated">Last updated on Aug 14, 2025.
  166. </span></p>
  167. </div>
  168. Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
  169. <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
  170. provided by <a href="https://readthedocs.org">Read the Docs</a>.
  171. </footer>
  172. </div>
  173. </div>
  174. </section>
  175. </div>
  176. <script>
  177. jQuery(function () {
  178. SphinxRtdTheme.Navigation.enable(true);
  179. });
  180. </script>
  181. <!-- Theme Analytics -->
  182. <script async src="https://www.googletagmanager.com/gtag/js?id=G-XNVGCMNDZH"></script>
  183. <script>
  184. window.dataLayer = window.dataLayer || [];
  185. function gtag(){dataLayer.push(arguments);}
  186. gtag('js', new Date());
  187. gtag('config', 'G-XNVGCMNDZH', {
  188. 'anonymize_ip': true,
  189. });
  190. </script>
  191. </body>
  192. </html>