boot_config.html 9.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184
  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>boot.config reference &mdash; Crown Manual 0.48.0 documentation</title><link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
  7. <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
  8. <!--[if lt IE 9]>
  9. <script src="../_static/js/html5shiv.min.js"></script>
  10. <![endif]-->
  11. <script>
  12. var DOCUMENTATION_OPTIONS = {
  13. URL_ROOT:'../',
  14. VERSION:'0.48.0',
  15. LANGUAGE:'en',
  16. COLLAPSE_INDEX:false,
  17. FILE_SUFFIX:'.html',
  18. HAS_SOURCE: true,
  19. SOURCELINK_SUFFIX: '.txt'
  20. };
  21. </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 reference" href="command_line.html" />
  30. <link rel="prev" title="Reference" href="index.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"><img src="../_static/crown-logo-white.svg" class="logo" alt="Logo"/>
  38. </a>
  39. <div class="version">
  40. 0.48.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><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
  50. <ul class="current">
  51. <li class="toctree-l1"><a class="reference internal" href="../changelog.html">Changelog</a></li>
  52. <li class="toctree-l1"><a class="reference internal" href="../introduction.html">Introduction</a></li>
  53. <li class="toctree-l1"><a class="reference internal" href="../basics.html">Basic concepts</a></li>
  54. <li class="toctree-l1 current"><a class="reference internal" href="index.html">Reference</a><ul class="current">
  55. <li class="toctree-l2 current"><a class="current reference internal" href="#">boot.config reference</a><ul>
  56. <li class="toctree-l3"><a class="reference internal" href="#generic-configurations">Generic configurations</a></li>
  57. <li class="toctree-l3"><a class="reference internal" href="#platform-specific-configurations">Platform-specific configurations</a><ul>
  58. <li class="toctree-l4"><a class="reference internal" href="#renderer-configurations">Renderer configurations</a></li>
  59. </ul>
  60. </li>
  61. </ul>
  62. </li>
  63. <li class="toctree-l2"><a class="reference internal" href="command_line.html">Command line reference</a></li>
  64. </ul>
  65. </li>
  66. <li class="toctree-l1"><a class="reference internal" href="../lua_api.html">Lua API reference</a></li>
  67. <li class="toctree-l1"><a class="reference internal" href="../glossary.html">Glossary</a></li>
  68. <li class="toctree-l1"><a class="reference internal" href="../copyright.html">License</a></li>
  69. <li class="toctree-l1"><a class="reference internal" href="../hackers/index.html">Hackers</a></li>
  70. </ul>
  71. </div>
  72. </div>
  73. </nav>
  74. <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
  75. <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
  76. <a href="../index.html">Crown Manual</a>
  77. </nav>
  78. <div class="wy-nav-content">
  79. <div class="rst-content">
  80. <div role="navigation" aria-label="Page navigation">
  81. <ul class="wy-breadcrumbs">
  82. <li><a href="../index.html" class="icon icon-home"></a> &raquo;</li>
  83. <li><a href="index.html">Reference</a> &raquo;</li>
  84. <li>boot.config reference</li>
  85. <li class="wy-breadcrumbs-aside">
  86. <a href="../_sources/reference/boot_config.rst.txt" rel="nofollow"> View page source</a>
  87. </li>
  88. </ul>
  89. <hr/>
  90. </div>
  91. <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
  92. <div itemprop="articleBody">
  93. <div class="section" id="boot-config-reference">
  94. <h1>boot.config reference<a class="headerlink" href="#boot-config-reference" title="Permalink to this headline">¶</a></h1>
  95. <div class="section" id="generic-configurations">
  96. <h2>Generic configurations<a class="headerlink" href="#generic-configurations" title="Permalink to this headline">¶</a></h2>
  97. <dl class="docutils">
  98. <dt><code class="docutils literal"><span class="pre">boot_script</span> <span class="pre">=</span> <span class="pre">&quot;lua/game&quot;</span></code></dt>
  99. <dd>Lua script to launch on boot.</dd>
  100. <dt><code class="docutils literal"><span class="pre">boot_package</span> <span class="pre">=</span> <span class="pre">&quot;boot&quot;</span></code></dt>
  101. <dd>Package to load on boot.</dd>
  102. <dt><code class="docutils literal"><span class="pre">window_title</span> <span class="pre">=</span> <span class="pre">&quot;My</span> <span class="pre">window&quot;</span></code></dt>
  103. <dd>Title of the main window on platforms that support it.</dd>
  104. </dl>
  105. </div>
  106. <div class="section" id="platform-specific-configurations">
  107. <h2>Platform-specific configurations<a class="headerlink" href="#platform-specific-configurations" title="Permalink to this headline">¶</a></h2>
  108. <p>All configurations for a given <em>platform</em> are placed under a key named <em>platform</em>. E.g.:</p>
  109. <div class="code highlight-default"><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>
  110. <span class="n">linux</span> <span class="o">=</span> <span class="p">{</span>
  111. <span class="n">renderer</span> <span class="o">=</span> <span class="p">{</span>
  112. <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>
  113. <span class="n">aspect_ratio</span> <span class="o">=</span> <span class="o">-</span><span class="mi">1</span>
  114. <span class="n">vsync</span> <span class="o">=</span> <span class="n">true</span>
  115. <span class="p">}</span>
  116. <span class="p">}</span>
  117. </pre></div>
  118. </div>
  119. <div class="section" id="renderer-configurations">
  120. <h3>Renderer configurations<a class="headerlink" href="#renderer-configurations" title="Permalink to this headline">¶</a></h3>
  121. <dl class="docutils">
  122. <dt><code class="docutils literal"><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>
  123. <dd>Sets the width and height of the main window.</dd>
  124. <dt><code class="docutils literal"><span class="pre">aspect_ratio</span> <span class="pre">=</span> <span class="pre">-1</span></code></dt>
  125. <dd>Sets the aspect ratio.
  126. If the value is set to <code class="docutils literal"><span class="pre">-1</span></code>, the aspect ratio is computed as <code class="docutils literal"><span class="pre">width/height</span></code> of the main window.</dd>
  127. <dt><code class="docutils literal"><span class="pre">vsync</span> <span class="pre">=</span> <span class="pre">true</span></code></dt>
  128. <dd>Sets whether to enable the vsync.</dd>
  129. <dt><code class="docutils literal"><span class="pre">fullscreen</span> <span class="pre">=</span> <span class="pre">false</span></code></dt>
  130. <dd>Sets whether to enable fullscreen.</dd>
  131. </dl>
  132. </div>
  133. </div>
  134. </div>
  135. </div>
  136. </div>
  137. <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
  138. <a href="index.html" class="btn btn-neutral float-left" title="Reference" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
  139. <a href="command_line.html" class="btn btn-neutral float-right" title="Command line reference" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
  140. </div>
  141. <hr/>
  142. <div role="contentinfo">
  143. <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>
  144. </div>
  145. Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
  146. <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
  147. provided by <a href="https://readthedocs.org">Read the Docs</a>.
  148. </footer>
  149. </div>
  150. </div>
  151. </section>
  152. </div>
  153. <script>
  154. jQuery(function () {
  155. SphinxRtdTheme.Navigation.enable(true);
  156. });
  157. </script>
  158. <!-- Theme Analytics -->
  159. <script async src="https://www.googletagmanager.com/gtag/js?id=G-XNVGCMNDZH"></script>
  160. <script>
  161. window.dataLayer = window.dataLayer || [];
  162. function gtag(){dataLayer.push(arguments);}
  163. gtag('js', new Date());
  164. gtag('config', 'G-XNVGCMNDZH', {
  165. 'anonymize_ip': true,
  166. });
  167. </script>
  168. </body>
  169. </html>