project-config.html 10.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187
  1. <!DOCTYPE html>
  2. <html class="writer-html5" lang="en" >
  3. <head>
  4. <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
  5. <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  6. <title>Project configuration &mdash; Phaser Editor 2D Help</title>
  7. <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
  8. <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
  9. <link rel="stylesheet" href="../_static/css/custom.css" type="text/css" />
  10. <link rel="shortcut icon" href="../_static/icon.png"/>
  11. <!--[if lt IE 9]>
  12. <script src="../_static/js/html5shiv.min.js"></script>
  13. <![endif]-->
  14. <script src="../_static/jquery.js?v=5d32c60e"></script>
  15. <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
  16. <script src="../_static/documentation_options.js?v=a1f35292"></script>
  17. <script src="../_static/doctools.js?v=888ff710"></script>
  18. <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
  19. <script src="../_static/js/theme.js"></script>
  20. <link rel="index" title="Index" href="../genindex.html" />
  21. <link rel="search" title="Search" href="../search.html" />
  22. <link rel="next" title="Server options" href="server-options.html" />
  23. <link rel="prev" title="Miscellaneous" href="index.html" />
  24. </head>
  25. <body class="wy-body-for-nav">
  26. <div class="wy-grid-for-nav">
  27. <nav data-toggle="wy-nav-shift" class="wy-nav-side">
  28. <div class="wy-side-scroll">
  29. <div class="wy-side-nav-search" style="background: #343131" >
  30. <a href="../index.html" class="icon icon-home">
  31. Phaser Editor 2D
  32. <img src="../_static/logo.png" class="logo" alt="Logo"/>
  33. </a>
  34. <div class="version">
  35. v3.67.0
  36. </div>
  37. <div role="search">
  38. <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
  39. <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
  40. <input type="hidden" name="check_keywords" value="yes" />
  41. <input type="hidden" name="area" value="default" />
  42. </form>
  43. </div>
  44. </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
  45. <ul class="current">
  46. <li class="toctree-l1"><a class="reference internal" href="../intro/index.html">Introduction</a></li>
  47. <li class="toctree-l1"><a class="reference internal" href="../first-steps/index.html">First steps</a></li>
  48. <li class="toctree-l1"><a class="reference internal" href="../workbench/index.html">Workbench</a></li>
  49. <li class="toctree-l1"><a class="reference internal" href="../asset-pack-editor/index.html">Asset Pack Editor</a></li>
  50. <li class="toctree-l1"><a class="reference internal" href="../scene-editor/index.html">Scene Editor</a></li>
  51. <li class="toctree-l1"><a class="reference internal" href="../code-editor/index.html">Code Editor</a></li>
  52. <li class="toctree-l1"><a class="reference internal" href="../animations-editor/index.html">Animations Editor</a></li>
  53. <li class="toctree-l1"><a class="reference internal" href="../atlas-editor/index.html">Atlas Editor</a></li>
  54. <li class="toctree-l1 current"><a class="reference internal" href="index.html">Miscellaneous</a><ul class="current">
  55. <li class="toctree-l2 current"><a class="current reference internal" href="#">Project configuration</a></li>
  56. <li class="toctree-l2"><a class="reference internal" href="server-options.html">Server options</a></li>
  57. <li class="toctree-l2"><a class="reference internal" href="resources-caching.html">Resources caching</a></li>
  58. <li class="toctree-l2"><a class="reference internal" href="resources-filtering.html">Resources filtering</a></li>
  59. <li class="toctree-l2"><a class="reference internal" href="local-preferences.html">Local preferences</a></li>
  60. <li class="toctree-l2"><a class="reference internal" href="content-viewers.html">Content viewers</a></li>
  61. <li class="toctree-l2"><a class="reference internal" href="update.html">Updating the editor</a></li>
  62. <li class="toctree-l2"><a class="reference internal" href="plugins.html">Plugins</a></li>
  63. </ul>
  64. </li>
  65. <li class="toctree-l1"><a class="reference internal" href="../pricing/index.html">License and pricing</a></li>
  66. </ul>
  67. </div>
  68. </div>
  69. </nav>
  70. <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" style="background: #343131" >
  71. <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
  72. <a href="../index.html">Phaser Editor 2D</a>
  73. </nav>
  74. <div class="wy-nav-content">
  75. <div class="rst-content">
  76. <div role="navigation" aria-label="Page navigation">
  77. <ul class="wy-breadcrumbs">
  78. <li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
  79. <li class="breadcrumb-item"><a href="index.html">Miscellaneous</a></li>
  80. <li class="breadcrumb-item active">Project configuration</li>
  81. <li class="wy-breadcrumbs-aside">
  82. </li>
  83. </ul>
  84. <hr/>
  85. </div>
  86. <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
  87. <div itemprop="articleBody">
  88. <section id="project-configuration">
  89. <h1>Project configuration<a class="headerlink" href="#project-configuration" title="Link to this heading"></a></h1>
  90. <p>Any folder is a valid <a class="reference external" href="https://phasereditor2d.com">Phaser Editor 2D</a> project. However, it is convenient to create a <code class="docutils literal notranslate"><span class="pre">phasereditor2d.config.json</span></code> project configuration file, it the root of the project’s folder.</p>
  91. <p>Every <a class="reference external" href="https://phasereditor2d.com">Phaser Editor 2D</a>’s project template contains this file so probably you don’t have to create it yourself.</p>
  92. <p>These are the settings supported by the project configuration:</p>
  93. <table class="docutils align-default">
  94. <colgroup>
  95. <col style="width: 20%" />
  96. <col style="width: 80%" />
  97. </colgroup>
  98. <thead>
  99. <tr class="row-odd"><th class="head"><p>Name</p></th>
  100. <th class="head"><p>Value</p></th>
  101. </tr>
  102. </thead>
  103. <tbody>
  104. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">skip</span></code></p></td>
  105. <td><p>An array with the patterns for <a class="reference external" href="resources-filtering.html">filtering the project resources</a>.</p></td>
  106. </tr>
  107. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">plugins</span></code></p></td>
  108. <td><p>An array with the path to <a class="reference external" href="plugins.html">user plugins</a>.</p></td>
  109. </tr>
  110. <tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">flags</span></code></p></td>
  111. <td><p>An array with the <a class="reference external" href="server-options.html">server options</a>.</p></td>
  112. </tr>
  113. <tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">playUrl</span></code></p></td>
  114. <td><p>A string with the address to open in the browser when you execute a Play command (<code class="docutils literal notranslate"><span class="pre">F12</span></code> or <code class="docutils literal notranslate"><span class="pre">F10</span></code>).</p></td>
  115. </tr>
  116. </tbody>
  117. </table>
  118. <p>This is an example:</p>
  119. <blockquote>
  120. <div><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="o">{</span>
  121. <span class="w"> </span><span class="s2">&quot;skip&quot;</span>:<span class="w"> </span><span class="o">[</span><span class="s2">&quot;dist/&quot;</span>,<span class="w"> </span><span class="s2">&quot;editor-plugins/&quot;</span><span class="o">]</span>,
  122. <span class="w"> </span><span class="s2">&quot;plugins&quot;</span>:
  123. <span class="w"> </span><span class="o">[</span>
  124. <span class="w"> </span><span class="s2">&quot;editor-plugins/my-fonts-plugins&quot;</span>,
  125. <span class="w"> </span><span class="s2">&quot;editor-plugins/my-awesome-plugins&quot;</span>
  126. <span class="w"> </span><span class="o">]</span>,
  127. <span class="w"> </span><span class="s2">&quot;flags&quot;</span>:<span class="w"> </span><span class="o">[</span><span class="s2">&quot;-port&quot;</span>,<span class="w"> </span><span class="s2">&quot;7171&quot;</span>,<span class="w"> </span><span class="s2">&quot;-disable-gzip&quot;</span><span class="o">]</span>,
  128. <span class="w"> </span><span class="s2">&quot;playUrl&quot;</span>:<span class="w"> </span><span class="s2">&quot;http://localhost:4200&quot;</span>
  129. <span class="o">}</span>
  130. </pre></div>
  131. </div>
  132. </div></blockquote>
  133. </section>
  134. </div>
  135. </div>
  136. <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
  137. <a href="index.html" class="btn btn-neutral float-left" title="Miscellaneous" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
  138. <a href="server-options.html" class="btn btn-neutral float-right" title="Server options" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
  139. </div>
  140. <hr/>
  141. <div role="contentinfo">
  142. <p>&#169; Copyright 2016-2024, Arian Fornaris.</p>
  143. </div>
  144. Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
  145. <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
  146. provided by <a href="https://readthedocs.org">Read the Docs</a>.
  147. </footer>
  148. </div>
  149. </div>
  150. </section>
  151. </div>
  152. <script>
  153. jQuery(function () {
  154. SphinxRtdTheme.Navigation.enable(true);
  155. });
  156. </script>
  157. <!-- Theme Analytics -->
  158. <script async src="https://www.googletagmanager.com/gtag/js?id=UA-67206336-2"></script>
  159. <script>
  160. window.dataLayer = window.dataLayer || [];
  161. function gtag(){dataLayer.push(arguments);}
  162. gtag('js', new Date());
  163. gtag('config', 'UA-67206336-2', {
  164. 'anonymize_ip': false,
  165. });
  166. </script>
  167. </body>
  168. </html>