boot_config.html 8.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284
  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.42.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.42.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="Command line reference" href="command_line.html" />
  29. <link rel="prev" title="Lua API reference" href="lua_api.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.42.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 current"><a class="current reference internal" href="">boot.config reference</a><ul>
  57. <li class="toctree-l2"><a class="reference internal" href="#generic-configurations">Generic configurations</a></li>
  58. <li class="toctree-l2"><a class="reference internal" href="#platform-specific-configurations">Platform-specific configurations</a><ul>
  59. <li class="toctree-l3"><a class="reference internal" href="#renderer-configurations">Renderer configurations</a></li>
  60. </ul>
  61. </li>
  62. </ul>
  63. </li>
  64. <li class="toctree-l1"><a class="reference internal" href="command_line.html">Command line reference</a></li>
  65. <li class="toctree-l1"><a class="reference internal" href="glossary.html">Glossary</a></li>
  66. <li class="toctree-l1"><a class="reference internal" href="copyright.html">License</a></li>
  67. </ul>
  68. <ul>
  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">
  75. <nav class="wy-nav-top" aria-label="top navigation">
  76. <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
  77. <a href="index.html">Crown Manual</a>
  78. </nav>
  79. <div class="wy-nav-content">
  80. <div class="rst-content">
  81. <div role="navigation" aria-label="breadcrumbs navigation">
  82. <ul class="wy-breadcrumbs">
  83. <li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
  84. <li>boot.config reference</li>
  85. <li class="wy-breadcrumbs-aside">
  86. <a href="_sources/boot_config.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-python"><div class="highlight"><pre>// Linux-only configs
  110. linux = {
  111. renderer = {
  112. resolution = [ 1280 720 ]
  113. aspect_ratio = -1
  114. vsync = true
  115. }
  116. }
  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>
  138. <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
  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. <a href="lua_api.html" class="btn btn-neutral float-left" title="Lua API reference" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
  141. </div>
  142. <hr/>
  143. <div role="contentinfo">
  144. <p>
  145. &#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.
  146. </p>
  147. </div>
  148. Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
  149. <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
  150. provided by <a href="https://readthedocs.org">Read the Docs</a>.
  151. </footer>
  152. </div>
  153. </div>
  154. </section>
  155. </div>
  156. <script type="text/javascript">
  157. jQuery(function () {
  158. SphinxRtdTheme.Navigation.enable(true);
  159. });
  160. </script>
  161. </body>
  162. </html>