Phaser.js
/
PhaserEditor2D-v3-docs-html
mirror of https://github.com/PhaserEditor2D/PhaserEditor2D-v3-docs-html.git


			
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224
							<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
  <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <title>Resources filtering &mdash; Phaser Editor 2D Help</title>
      <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
      <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
      <link rel="stylesheet" href="../_static/css/custom.css" type="text/css" />
    <link rel="shortcut icon" href="../_static/icon.png"/>
  <!--[if lt IE 9]>
    <script src="../_static/js/html5shiv.min.js"></script>
  <![endif]-->
  
        <script src="../_static/jquery.js?v=5d32c60e"></script>
        <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
        <script src="../_static/documentation_options.js?v=a1f35292"></script>
        <script src="../_static/doctools.js?v=888ff710"></script>
        <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
    <script src="../_static/js/theme.js"></script>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="Local preferences" href="local-preferences.html" />
    <link rel="prev" title="Resources caching" href="resources-caching.html" /> 
</head>

<body class="wy-body-for-nav"> 
  <div class="wy-grid-for-nav">
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search"  style="background: #343131" >

          
          <a href="../index.html" class="icon icon-home">
            Phaser Editor 2D
              <img src="../_static/logo.png" class="logo" alt="Logo"/>
          </a>
              <div class="version">
                v3.67.0
              </div>
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>
        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
              <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../intro/index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../first-steps/index.html">First steps</a></li>
<li class="toctree-l1"><a class="reference internal" href="../workbench/index.html">Workbench</a></li>
<li class="toctree-l1"><a class="reference internal" href="../asset-pack-editor/index.html">Asset Pack Editor</a></li>
<li class="toctree-l1"><a class="reference internal" href="../scene-editor/index.html">Scene Editor</a></li>
<li class="toctree-l1"><a class="reference internal" href="../code-editor/index.html">Code Editor</a></li>
<li class="toctree-l1"><a class="reference internal" href="../animations-editor/index.html">Animations Editor</a></li>
<li class="toctree-l1"><a class="reference internal" href="../atlas-editor/index.html">Atlas Editor</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Miscellaneous</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="project-config.html">Project configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="server-options.html">Server options</a></li>
<li class="toctree-l2"><a class="reference internal" href="resources-caching.html">Resources caching</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Resources filtering</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#patterns">Patterns</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="local-preferences.html">Local preferences</a></li>
<li class="toctree-l2"><a class="reference internal" href="content-viewers.html">Content viewers</a></li>
<li class="toctree-l2"><a class="reference internal" href="update.html">Updating the editor</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugins.html">Plugins</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../pricing/index.html">License and pricing</a></li>
</ul>

        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu"  style="background: #343131" >
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="../index.html">Phaser Editor 2D</a>
      </nav>

      <div class="wy-nav-content">
        <div class="rst-content">
          <div role="navigation" aria-label="Page navigation">
  <ul class="wy-breadcrumbs">
      <li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
          <li class="breadcrumb-item"><a href="index.html">Miscellaneous</a></li>
      <li class="breadcrumb-item active">Resources filtering</li>
      <li class="wy-breadcrumbs-aside">
      </li>
  </ul>
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
             
  <section id="resources-filtering">
<h1>Resources filtering<a class="headerlink" href="#resources-filtering" title="Link to this heading"></a></h1>
<p><a class="reference external" href="https://phasereditor2d.com">Phaser Editor 2D</a> is the typical web application with a server layer and a client (browser) layer. Because the browser has no direct access to the file of the projects, the editor loads <a class="reference external" href="resources-caching.html">many resources in memory</a>. For this reason, you must keep a low number of files in the project. Usually, HTML5 games need a few files, but you may include the files of third-party tools or the files of the server-side of the game.</p>
<p>When you are running the editor in free-mode, it has a fixed number of files allowed in the project. If you are running the editor in premium-mode, the max number of files allowed per project is 1000. However, if you are working on a huge project, you can change that limit with the <code class="docutils literal notranslate"><span class="pre">-max-number-files</span></code> flag:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>PhaserEditor2D<span class="w"> </span>-max-number-files<span class="w"> </span><span class="m">50000</span>
</pre></div>
</div>
<p><a class="reference external" href="../misc/server-options.html">Learn more about the server options</a></p>
<p>If you cannot change the structure of your project, you can exclude files from the Phaser Editor 2D project by using <code class="docutils literal notranslate"><span class="pre">.skip</span></code> files. It is similar to how you can exclude files from a Git repository, using <code class="docutils literal notranslate"><span class="pre">.gitignore</span></code> files.</p>
<p>You can create a <code class="docutils literal notranslate"><span class="pre">.skip</span></code> file in a folder of the project, and write the file name patterns you want to exclude.</p>
<p>This is an example of a <code class="docutils literal notranslate"><span class="pre">.skip</span></code> file:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="c1"># exclude all node_modules folders in the project.</span>
**/node_modules

<span class="c1"># exclude a single file in the current directory</span>
my-private-secret.data

<span class="c1"># exclude all files in the form @2x.png, @2x.json,...</span>
**/*@2x.*
</pre></div>
</div>
<p>If the <code class="docutils literal notranslate"><span class="pre">.skip</span></code> file is empty, then the editor assumes it has a <code class="docutils literal notranslate"><span class="pre">*</span></code> pattern. It means, it will exclude all the folder’s content. We did it that way for backward compatibility with previous versions of the editor.</p>
<p>In addition to the <code class="docutils literal notranslate"><span class="pre">.skip</span></code> files you create in each project, you can edit the <code class="docutils literal notranslate"><span class="pre">default-skip</span></code> file that is placed in the Phaser Editor 2D install directory. The patterns defined in that file will be applied to all projects. By default, it includes the pattens to skip all files starting in a dor (<code class="docutils literal notranslate"><span class="pre">.</span></code>), all <code class="docutils literal notranslate"><span class="pre">node_modules</span></code> folders, and all <code class="docutils literal notranslate"><span class="pre">__MACOSX</span></code> files.</p>
<p>Another way of filtering the files, is using the <code class="docutils literal notranslate"><span class="pre">skip</span></code> setting of the <a class="reference external" href="../project-config.html">project configuration file</a>. You can set an array of “skipping rules”, the same used in the <code class="docutils literal notranslate"><span class="pre">.skip</span></code> file:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>//<span class="w"> </span>phasereditor2d.config.json

<span class="o">{</span>
<span class="w">    </span><span class="s2">&quot;skip&quot;</span>:<span class="w"> </span><span class="o">[</span><span class="s2">&quot;my-private-secret.data&quot;</span>,<span class="w"> </span><span class="s2">&quot;**/*@2x.*&quot;</span><span class="o">]</span>
<span class="o">}</span>
</pre></div>
</div>
<section id="patterns">
<h2>Patterns<a class="headerlink" href="#patterns" title="Link to this heading"></a></h2>
<p>We use the <a class="reference external" href="https://github.com/bmatcuk/doublestar#patterns">doublestart</a> project for pattern matching. Following is a part of the documentation of that project:</p>
<p>Special terms in the patterns:</p>
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Special Terms</p></th>
<th class="head"><p>Meaning</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">*</span></code></p></td>
<td><p>matches any sequence of non-path-separators</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">**</span></code></p></td>
<td><p>matches any sequence of characters, including path separators</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">?</span></code></p></td>
<td><p>matches any single non-path-separator character</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">[class]</span></code></p></td>
<td><p>matches any single non-path-separator character against a class of characters (see below)</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">{alt1,...}</span></code></p></td>
<td><p>matches a sequence of characters if one of the comma-separated alternatives matches</p></td>
</tr>
</tbody>
</table>
<p>Character classes support the following:</p>
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Class</p></th>
<th class="head"><p>Meaning</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">[abc]</span></code></p></td>
<td><p>matches any single character within the set</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">[a-z]</span></code></p></td>
<td><p>matches any single character in the range</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">[^class]</span></code></p></td>
<td><p>matches any single character which does <em>not</em> match the class</p></td>
</tr>
</tbody>
</table>
</section>
</section>


           </div>
          </div>
          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
        <a href="resources-caching.html" class="btn btn-neutral float-left" title="Resources caching" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
        <a href="local-preferences.html" class="btn btn-neutral float-right" title="Local preferences" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
    </div>

  <hr/>

  <div role="contentinfo">
    <p>&#169; Copyright 2016-2024, Arian Fornaris.</p>
  </div>

  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
    provided by <a href="https://readthedocs.org">Read the Docs</a>.
   

</footer>
        </div>
      </div>
    </section>
  </div>
  <script>
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script>
    <!-- Theme Analytics -->
    <script async src="https://www.googletagmanager.com/gtag/js?id=UA-67206336-2"></script>
    <script>
      window.dataLayer = window.dataLayer || [];
      function gtag(){dataLayer.push(arguments);}
      gtag('js', new Date());

      gtag('config', 'UA-67206336-2', {
          'anonymize_ip': false,
      });
    </script> 

</body>
</html>