files-view.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184
  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>Files view &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="Inspector view" href="inspector-view.html" />
  23. <link rel="prev" title="Editors" href="editors.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 current"><a class="reference internal" href="index.html">Workbench</a><ul class="current">
  49. <li class="toctree-l2"><a class="reference internal" href="views.html">Views</a></li>
  50. <li class="toctree-l2"><a class="reference internal" href="editors.html">Editors</a></li>
  51. <li class="toctree-l2 current"><a class="current reference internal" href="#">Files view</a><ul>
  52. <li class="toctree-l3"><a class="reference internal" href="#the-design-and-assets-sub-tabs">The Design and Assets sub-tabs</a></li>
  53. <li class="toctree-l3"><a class="reference internal" href="#context-menu">Context menu</a></li>
  54. <li class="toctree-l3"><a class="reference internal" href="#inspector-view-integration">Inspector view integration</a></li>
  55. </ul>
  56. </li>
  57. <li class="toctree-l2"><a class="reference internal" href="inspector-view.html">Inspector view</a></li>
  58. <li class="toctree-l2"><a class="reference internal" href="outline-view.html">Outline view</a></li>
  59. <li class="toctree-l2"><a class="reference internal" href="blocks-view.html">Blocks view</a></li>
  60. <li class="toctree-l2"><a class="reference internal" href="main-toolbar.html">Main toolbar</a></li>
  61. <li class="toctree-l2"><a class="reference internal" href="main-menu.html">Main menu</a></li>
  62. <li class="toctree-l2"><a class="reference internal" href="playing-project.html">Playing the project</a></li>
  63. <li class="toctree-l2"><a class="reference internal" href="projects.html">Projects</a></li>
  64. <li class="toctree-l2"><a class="reference internal" href="new-file-dialog.html">New File dialog</a></li>
  65. <li class="toctree-l2"><a class="reference internal" href="upload-dialog.html">Upload dialog</a></li>
  66. <li class="toctree-l2"><a class="reference internal" href="color-themes.html">Color themes</a></li>
  67. <li class="toctree-l2"><a class="reference internal" href="command-palette.html">Command palette</a></li>
  68. </ul>
  69. </li>
  70. <li class="toctree-l1"><a class="reference internal" href="../asset-pack-editor/index.html">Asset Pack Editor</a></li>
  71. <li class="toctree-l1"><a class="reference internal" href="../scene-editor/index.html">Scene Editor</a></li>
  72. <li class="toctree-l1"><a class="reference internal" href="../code-editor/index.html">Code Editor</a></li>
  73. <li class="toctree-l1"><a class="reference internal" href="../animations-editor/index.html">Animations Editor</a></li>
  74. <li class="toctree-l1"><a class="reference internal" href="../atlas-editor/index.html">Atlas Editor</a></li>
  75. <li class="toctree-l1"><a class="reference internal" href="../misc/index.html">Miscellaneous</a></li>
  76. <li class="toctree-l1"><a class="reference internal" href="../pricing/index.html">License and pricing</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" style="background: #343131" >
  82. <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
  83. <a href="../index.html">Phaser Editor 2D</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" aria-label="Home"></a></li>
  90. <li class="breadcrumb-item"><a href="index.html">Workbench</a></li>
  91. <li class="breadcrumb-item active">Files view</li>
  92. <li class="wy-breadcrumbs-aside">
  93. </li>
  94. </ul>
  95. <hr/>
  96. </div>
  97. <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
  98. <div itemprop="articleBody">
  99. <section id="files-view">
  100. <h1>Files view<a class="headerlink" href="#files-view" title="Link to this heading"></a></h1>
  101. <p>The <a class="reference external" href="../workbench/files-view.html">Files view</a> shows the files of the project. The files are displayed in a tree structure, like in many other file navigators.</p>
  102. <p>Like the other <a class="reference external" href="../misc/content-viewers.html">content viewers</a> present in the IDE, the Files view shows inline previews of a certain type of files. At the same time, you can zoom in/out them by pressing the <code class="docutils literal notranslate"><span class="pre">Shift</span></code> key and rolling the mouse wheel.</p>
  103. <img alt="Files view zooming." src="../_images/files-view-zoom-04052020.webp" />
  104. <section id="the-design-and-assets-sub-tabs">
  105. <h2>The Design and Assets sub-tabs<a class="headerlink" href="#the-design-and-assets-sub-tabs" title="Link to this heading"></a></h2>
  106. <p>The main activities you do with Phaser Editor 2D are to create the scenes and pack the assets. For this reason, we added two sub-tabs to the Files view: <strong>Design</strong> and <strong>Assets</strong>. It allows you (we hope) to filter the files and show in the view only the files related to a certain activity.</p>
  107. <p>When you select the <strong>Design</strong> tab, the view shows only the files you commonly edit with Phaser Editor 2D: the Scene files, the User Components files, the Animations files, the Asset Pack files.</p>
  108. <p>When you select the <strong>Assets</strong> tab, the view shows only the files used as assets by the different editor: images, atlas files, audio files, video files, Asset Pack files, etc…</p>
  109. <p>In both cases, empty folders are not shown. And all files are shown if no sub-tab is selected.</p>
  110. <p>There is another usual activity in the editor: coding. JavaScript and TypeScript files are excluded in both filters. We think coding is not the strong point in the editor and we encourage you to use <a class="reference external" href="https://code.visualstudio.com">Visual Studio Code</a> if possible. In any case, you always have the option of showing all files.</p>
  111. <img alt="Tab sections." src="../_images/files-view-tab-sections-03122021.webp" />
  112. </section>
  113. <section id="context-menu">
  114. <h2>Context menu<a class="headerlink" href="#context-menu" title="Link to this heading"></a></h2>
  115. <p>The context menu lists a couple of common file operations.</p>
  116. <p>The <strong>New…</strong> sub-menu shows shortcuts to create new files related to the IDE tools.</p>
  117. <p>The <strong>Open With</strong> sub-menu shows all the editors you can use to open a selected file.</p>
  118. <p>There <strong>Rename</strong>, <strong>Move</strong>, <strong>Copy To</strong> and <strong>Delete</strong> options work just like in any other file manager. But warning, at this moment, these operations cannot be undone, so take care of them.</p>
  119. <p>If you run the server locally (not using the <code class="docutils literal notranslate"><span class="pre">-public</span></code> option), then the context menu shows the <strong>Locate File</strong> item. It opens the default file manager of your OS at the location of the selected file or folder.</p>
  120. <p>The <strong>Upload Files</strong> option opens the <a class="reference external" href="upload-dialog.html">Upload dialog</a>. The files will be uploaded to the selected folder (or parent folder if the selected item is a file).</p>
  121. <img alt="Context menu of the Files view." src="../_images/files-view-context-menu-09302020.webp" />
  122. </section>
  123. <section id="inspector-view-integration">
  124. <h2>Inspector view integration<a class="headerlink" href="#inspector-view-integration" title="Link to this heading"></a></h2>
  125. <p>The <a class="reference external" href="../workbench/inspector-view.html">Inspector view</a> shows the properties of the objects selected in the active view or part. When you select a file in the <a class="reference external" href="../workbench/files-view.html">Files view</a>, the <a class="reference external" href="../workbench/inspector-view.html">Inspector view</a> displays different property sections of the file.</p>
  126. <p>In all cases, the <a class="reference external" href="../workbench/inspector-view.html">Inspector view</a> shows the <strong>File</strong> section. It displays the <strong>Name</strong>, <strong>Full Name</strong>, <strong>Size</strong>, and a button to open the file in an editor.</p>
  127. <p>In addition, plugins can provide their own file property sections for <a class="reference external" href="../workbench/inspector-view.html">Inspector view</a>. There are the cases of the images preview, the scenes preview or the <a class="reference external" href="../asset-pack-editor/import-from-files-view.html">Asset Pack Editor section</a>.</p>
  128. <img alt="Inspector view shows the selected file properties." src="../_images/files-view-inspector-1-04052020.jpg" />
  129. </section>
  130. </section>
  131. </div>
  132. </div>
  133. <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
  134. <a href="editors.html" class="btn btn-neutral float-left" title="Editors" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
  135. <a href="inspector-view.html" class="btn btn-neutral float-right" title="Inspector view" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
  136. </div>
  137. <hr/>
  138. <div role="contentinfo">
  139. <p>&#169; Copyright 2016-2024, Arian Fornaris.</p>
  140. </div>
  141. Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
  142. <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
  143. provided by <a href="https://readthedocs.org">Read the Docs</a>.
  144. </footer>
  145. </div>
  146. </div>
  147. </section>
  148. </div>
  149. <script>
  150. jQuery(function () {
  151. SphinxRtdTheme.Navigation.enable(true);
  152. });
  153. </script>
  154. <!-- Theme Analytics -->
  155. <script async src="https://www.googletagmanager.com/gtag/js?id=UA-67206336-2"></script>
  156. <script>
  157. window.dataLayer = window.dataLayer || [];
  158. function gtag(){dataLayer.push(arguments);}
  159. gtag('js', new Date());
  160. gtag('config', 'UA-67206336-2', {
  161. 'anonymize_ip': false,
  162. });
  163. </script>
  164. </body>
  165. </html>