add-image-to-scene.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188
  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>Add an image to the scene &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="Unlock the IDE" href="unlock-ide.html" />
  23. <link rel="prev" title="Create your first project" href="create-first-project.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 current"><a class="reference internal" href="index.html">First steps</a><ul class="current">
  48. <li class="toctree-l2"><a class="reference internal" href="download-and-install.html">Download and install</a></li>
  49. <li class="toctree-l2"><a class="reference internal" href="create-first-project.html">Create your first project</a></li>
  50. <li class="toctree-l2 current"><a class="current reference internal" href="#">Add an image to the scene</a></li>
  51. <li class="toctree-l2"><a class="reference internal" href="unlock-ide.html">Unlock the IDE</a></li>
  52. <li class="toctree-l2"><a class="reference internal" href="learn-phaser-with-phaser-editor.html">Learn Phaser with Phaser Editor 2D</a></li>
  53. </ul>
  54. </li>
  55. <li class="toctree-l1"><a class="reference internal" href="../workbench/index.html">Workbench</a></li>
  56. <li class="toctree-l1"><a class="reference internal" href="../asset-pack-editor/index.html">Asset Pack Editor</a></li>
  57. <li class="toctree-l1"><a class="reference internal" href="../scene-editor/index.html">Scene Editor</a></li>
  58. <li class="toctree-l1"><a class="reference internal" href="../code-editor/index.html">Code Editor</a></li>
  59. <li class="toctree-l1"><a class="reference internal" href="../animations-editor/index.html">Animations Editor</a></li>
  60. <li class="toctree-l1"><a class="reference internal" href="../atlas-editor/index.html">Atlas Editor</a></li>
  61. <li class="toctree-l1"><a class="reference internal" href="../misc/index.html">Miscellaneous</a></li>
  62. <li class="toctree-l1"><a class="reference internal" href="../pricing/index.html">License and pricing</a></li>
  63. </ul>
  64. </div>
  65. </div>
  66. </nav>
  67. <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" style="background: #343131" >
  68. <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
  69. <a href="../index.html">Phaser Editor 2D</a>
  70. </nav>
  71. <div class="wy-nav-content">
  72. <div class="rst-content">
  73. <div role="navigation" aria-label="Page navigation">
  74. <ul class="wy-breadcrumbs">
  75. <li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
  76. <li class="breadcrumb-item"><a href="index.html">First steps</a></li>
  77. <li class="breadcrumb-item active">Add an image to the scene</li>
  78. <li class="wy-breadcrumbs-aside">
  79. </li>
  80. </ul>
  81. <hr/>
  82. </div>
  83. <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
  84. <div itemprop="articleBody">
  85. <section id="add-an-image-to-the-scene">
  86. <h1>Add an image to the scene<a class="headerlink" href="#add-an-image-to-the-scene" title="Link to this heading"></a></h1>
  87. <p>Let’s add an image to the <code class="docutils literal notranslate"><span class="pre">Level.scene</span></code> file created by the <strong>Basic JavaScript</strong> project template.</p>
  88. <ol class="arabic simple">
  89. <li><p>To upload an image to the project. Rich-click on the <code class="docutils literal notranslate"><span class="pre">assets</span></code> folder and press the <strong>Upload Files</strong> option of the context menu.</p></li>
  90. </ol>
  91. <blockquote>
  92. <div><img alt="Upload image." src="../_images/first-steps-upload-file-1-04042020.jpg" />
  93. </div></blockquote>
  94. <ol class="arabic simple" start="2">
  95. <li><p>It opens the <strong>Upload Files</strong> dialog. Click on the <strong>Browse</strong> button and select the image file in your computer.</p></li>
  96. </ol>
  97. <blockquote>
  98. <div><img alt="Upload image." src="../_images/first-steps-upload-file-2-04042020.jpg" />
  99. </div></blockquote>
  100. <ol class="arabic simple" start="3">
  101. <li><p>Press the <strong>Upload</strong> button. The image is uploaded to the <code class="docutils literal notranslate"><span class="pre">assets</span></code> folder and shown in the <a class="reference external" href="../workbench/files-view.html">Files view</a>.</p></li>
  102. </ol>
  103. <blockquote>
  104. <div><img alt="Upload image." src="../_images/first-steps-upload-file-3-04042020.jpg" />
  105. </div></blockquote>
  106. <ol class="arabic simple" start="4">
  107. <li><p>Check the new image is selected in the <a class="reference external" href="../workbench/files-view.html">Files view</a>. Look in the <a class="reference external" href="../workbench/inspector-view.html">Inspector view</a>, there are the properties of the image file. In the section <strong>Asset Pack File</strong>, there two buttons to import the image into an <a class="reference external" href="../asset-pack-editor/asset-pack-file.html">Asset Pack file</a>. Click on the <strong>Import image</strong> button and select <strong>Add To /assets/asset-pack.json</strong>.</p></li>
  108. </ol>
  109. <blockquote>
  110. <div><blockquote>
  111. <div><img alt="Add image." src="../_images/first-steps-add-image-1-04042020.jpg" />
  112. </div></blockquote>
  113. <p>The <code class="docutils literal notranslate"><span class="pre">assets/asset-pack.json</span></code> is a <a class="reference external" href="https://phaser.io">Phaser</a> file with the configuration of all the files you can load in a game. The <a class="reference external" href="../scene-editor/index.html">Scene Editor</a> uses it to get the images or any other file information.</p>
  114. <p>You can add the image files to the <a class="reference external" href="../asset-pack-editor/asset-pack-file.html">Asset Pack file</a> using the previous method or opening the <code class="docutils literal notranslate"><span class="pre">assets-pack.json</span></code> file in the <a class="reference external" href="../asset-pack-editor/index.html">Asset Pack Editor</a>.</p>
  115. </div></blockquote>
  116. <ol class="arabic simple" start="5">
  117. <li><p>Click on the <a class="reference external" href="../scene-editor/index.html">Scene Editor</a> that is open, it will refresh the <a class="reference external" href="../workbench/blocks-view.html">Blocks view</a> and the new image will be shown in the view.</p></li>
  118. </ol>
  119. <blockquote>
  120. <div><img alt="Add image." src="../_images/first-steps-add-image-2-04042020.jpg" />
  121. </div></blockquote>
  122. <ol class="arabic simple" start="6">
  123. <li><p>Drag the image from the <a class="reference external" href="../workbench/blocks-view.html">Blocks view</a> and drop it in the middle of the scene. Press the <code class="docutils literal notranslate"><span class="pre">End</span></code> key to move the image to the bottom of the scene. Or right click in the image and select the <strong>Edit</strong> → <strong>Move Bottom</strong> option.</p></li>
  124. </ol>
  125. <blockquote>
  126. <div><p>Save the editor and play the project (<code class="docutils literal notranslate"><span class="pre">F12</span></code>).</p>
  127. <img alt="Add image." src="../_images/first-steps-add-image-3-04042020.jpg" />
  128. </div></blockquote>
  129. <div class="admonition note">
  130. <p class="admonition-title">Note</p>
  131. <p>There are a couple of initial steps you have to follow to add an image to the scene. 1) Upload. 2) Add the image to the Asset Pack file. 3) Drag the image from the <a class="reference external" href="../workbench/blocks-view.html">Blocks view</a> and drop it into the scene.</p>
  132. <p>This workflow may be simplified in the future, but for us it is important to make that process transparent, with no custom API or file formats, and make it full compatible with any other third-party tool you can use.</p>
  133. </div>
  134. </section>
  135. </div>
  136. </div>
  137. <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
  138. <a href="create-first-project.html" class="btn btn-neutral float-left" title="Create your first project" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
  139. <a href="unlock-ide.html" class="btn btn-neutral float-right" title="Unlock the IDE" 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; Copyright 2016-2024, Arian Fornaris.</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=UA-67206336-2"></script>
  160. <script>
  161. window.dataLayer = window.dataLayer || [];
  162. function gtag(){dataLayer.push(arguments);}
  163. gtag('js', new Date());
  164. gtag('config', 'UA-67206336-2', {
  165. 'anonymize_ip': false,
  166. });
  167. </script>
  168. </body>
  169. </html>