Phaser.js
/
PhaserEditor2D-v3-docs-html
镜像来自 https://github.com/PhaserEditor2D/PhaserEditor2D-v3-docs-html.git


			
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226
							<!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>Aseprite support &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="Spine animations" href="spine-animations.html" />
    <link rel="prev" title="Sprite animation preview" href="sprite-animations-preview.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 current"><a class="reference internal" href="index.html">Scene Editor</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="create-new-scene-file.html">Create a new Scene file</a></li>
<li class="toctree-l2"><a class="reference internal" href="add-object.html">Adding an object to the scene</a></li>
<li class="toctree-l2"><a class="reference internal" href="inspector-view.html">Inspector view</a></li>
<li class="toctree-l2"><a class="reference internal" href="game-objects.html">Game Object types</a></li>
<li class="toctree-l2"><a class="reference internal" href="scene-properties.html">Scene properties</a></li>
<li class="toctree-l2"><a class="reference internal" href="arcade-physics.html">Arcade Physics</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="sprite-animations.html">Sprite animations</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="sprite-animations-preview.html">Sprite animation preview</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">Aseprite support</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#aseprite-code-snippets">Aseprite Code Snippets</a></li>
<li class="toctree-l4"><a class="reference internal" href="#aseprite-exporting-instructions">Aseprite exporting instructions</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="spine-animations.html">Spine animations</a></li>
<li class="toctree-l2"><a class="reference internal" href="shader-effects.html">Shader Effects</a></li>
<li class="toctree-l2"><a class="reference internal" href="working-with-parent-objects.html">Working with parent objects</a></li>
<li class="toctree-l2"><a class="reference internal" href="object-list.html">Object List</a></li>
<li class="toctree-l2"><a class="reference internal" href="input.html">Input</a></li>
<li class="toctree-l2"><a class="reference internal" href="prefabs.html">Prefabs</a></li>
<li class="toctree-l2"><a class="reference internal" href="script-node.html">Script Nodes</a></li>
<li class="toctree-l2"><a class="reference internal" href="user-components.html">User Components</a></li>
<li class="toctree-l2"><a class="reference internal" href="manipulation-tools.html">Manipulation tools</a></li>
<li class="toctree-l2"><a class="reference internal" href="layout-tools.html">Layout tools</a></li>
<li class="toctree-l2"><a class="reference internal" href="scene-compiler.html">The scene compiler</a></li>
<li class="toctree-l2"><a class="reference internal" href="misc.html">Miscellaneous</a></li>
<li class="toctree-l2"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li>
</ul>
</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"><a class="reference internal" href="../misc/index.html">Miscellaneous</a></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">Scene Editor</a></li>
          <li class="breadcrumb-item"><a href="sprite-animations.html">Sprite animations</a></li>
      <li class="breadcrumb-item active">Aseprite support</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="aseprite-support">
<h1>Aseprite support<a class="headerlink" href="#aseprite-support" title="Link to this heading"></a></h1>
<p>Aseprite (<a class="reference external" href="https://www.aseprite.org">www.aseprite.org</a>) is a popular software for making pixel art and animations. <a class="reference external" href="https://phaser.io">Phaser</a> provides an Aseprite files loader and a method for making animations with the files.</p>
<p>This is the workflow for working with Aseprite animations in <a class="reference external" href="https://phasereditor2d.com">Phaser Editor 2D</a>:</p>
<ul>
<li><p>Export the <a class="reference external" href="/scene-editor/sprite-animations-aseprite.html">Aseprite</a> files to the Phaser Editor 2D project. You should follow <a class="reference external" href="#aseprite-exporting-instructions">these instructions</a> for exporting the files. The following image shows the atlas and PNG files of the “paladin” and “tank” animations:</p>
<blockquote>
<div><img alt="Aseprite exported files." src="../_images/scene-editor-aseprite-export-1-20231102.webp" />
</div></blockquote>
</li>
<li><p>Import the <a class="reference external" href="/scene-editor/sprite-animations-aseprite.html">Aseprite</a> files in an <a class="reference external" href="../asset-pack-editor/asset-pack-file.html">Asset Pack file</a>. You can select the atlas files (<code class="docutils literal notranslate"><span class="pre">.json</span></code>) and import them with the <a class="reference external" href="../asset-pack-editor/import-from-files-view.html">import buttons of the Inspector view</a>:</p>
<blockquote>
<div><img alt="Select the Aseprite files" src="../_images/scene-editor-import-aseprite-files-files-view-20231102.webp" />
<img alt="Import the files" src="../_images/scene-editor-import-aseprite-files-inspector-view-20231102.webp" />
<p>You can check the files are correctly defined in the <a class="reference external" href="../asset-pack-editor/asset-pack-file.html">Asset Pack file</a>:</p>
<img alt="Aseprite files in the pack file" src="../_images/scene-editor-aseprite-pack-file-1-20231102.webp" />
<img alt="Aseprite files in the pack file" src="../_images/scene-editor-aseprite-pack-file-2-20231102.webp" />
</div></blockquote>
</li>
<li><p>Now the <a class="reference external" href="/scene-editor/sprite-animations-aseprite.html">Aseprite</a> files are in the <a class="reference external" href="../asset-pack-editor/asset-pack-file.html">Asset Pack file</a> you can access the animations in the different tools of the editor:</p>
<blockquote>
<div><img alt="Aseprite animation in the scene editor blocks view." src="../_images/scene-editor-aseprite-animation-block-20231102.webp" />
</div></blockquote>
</li>
</ul>
<section id="aseprite-code-snippets">
<h2>Aseprite Code Snippets<a class="headerlink" href="#aseprite-code-snippets" title="Link to this heading"></a></h2>
<p>In <a class="reference external" href="https://phaser.io">Phaser</a>, before playing an <a class="reference external" href="/scene-editor/sprite-animations-aseprite.html">Aseprite</a> animation in a sprite, you should create the animations in the Animations Manager.</p>
<p>For creating the animations you should call the <a class="reference external" href="https://photonstorm.github.io/phaser3-docs/Phaser.Animations.AnimationManager.html#createFromAseprite__anchor">createFromAseprite</a> and pass as argument the <a class="reference external" href="/scene-editor/sprite-animations-aseprite.html">Aseprite</a> asset key.</p>
<p>In <a class="reference external" href="https://phasereditor2d.com">Phaser Editor 2D</a> you can add this chunk of code in an assisted way:</p>
<ul>
<li><p>Right-click on the scene. It opens the context menu. In the <strong>Code Snippet</strong> menu, select the <strong>Add Create Animations From Aseprite</strong> option.</p>
<blockquote>
<div><img alt="Select the Aseprite code snippet to add." src="../_images/scene-editor-aseprite-code-snippet-1-20231107.webp" />
</div></blockquote>
</li>
<li><p>It opens a dialog with all the <a class="reference external" href="/scene-editor/sprite-animations-aseprite.html">Aseprite</a> asset keys defined in the <a class="reference external" href="../asset-pack-editor/asset-pack-file.html">Asset Pack files</a> of the project. Select the one you want to use in your project. Probably all of them:</p>
<img alt="Select the Aseprite_ asset key." src="../_images/scene-editor-aseprite-code-snippet-2-20231107.webp" />
</li>
<li><p>Finally, when you compile the scene, it generates these lines of codes at the first lines of the <strong>create()</strong> method of the scene:</p>
<div class="highlight-javascript notranslate"><div class="highlight"><pre><span></span><span class="c1">// snippets</span>
<span class="k">this</span><span class="p">.</span><span class="nx">anims</span><span class="p">.</span><span class="nx">createFromAseprite</span><span class="p">(</span><span class="s2">&quot;paladin&quot;</span><span class="p">);</span>
<span class="k">this</span><span class="p">.</span><span class="nx">anims</span><span class="p">.</span><span class="nx">createFromAseprite</span><span class="p">(</span><span class="s2">&quot;tank&quot;</span><span class="p">);</span>
</pre></div>
</div>
</li>
</ul>
</section>
<section id="aseprite-exporting-instructions">
<h2>Aseprite exporting instructions<a class="headerlink" href="#aseprite-exporting-instructions" title="Link to this heading"></a></h2>
<p>Taken from the <a class="reference external" href="https://photonstorm.github.io/phaser3-docs/Phaser.Loader.LoaderPlugin.html#aseprite_anchor">Phaser documentation</a>:</p>
<blockquote class="pull-quote">
<div><p>To export a compatible JSON file in Aseprite, please do the following:</p>
<p>Go to “File - Export Sprite Sheet”</p>
<p>On the Layout tab: 2a. Set the “Sheet type” to “Packed” 2b. Set the “Constraints” to “None” 2c. Check the “Merge Duplicates” checkbox</p>
<p>On the Sprite tab: 3a. Set “Layers” to “Visible layers” 3b. Set “Frames” to “All frames”, unless you only wish to export a sub-set of tags</p>
<p>On the Borders tab: 4a. Check the “Trim Sprite” and “Trim Cells” options 4b. Ensure “Border Padding”, “Spacing” and “Inner Padding” are all &gt; 0 (1 is usually enough)</p>
<p>On the Output tab: 5a. Check “Output File”, give your image a name and make sure you choose “png files” as the file type 5b. Check “JSON Data” and give your json file a name 5c. The JSON Data type can be either a Hash or Array, Phaser doesn’t mind. 5d. Make sure “Tags” is checked in the Meta options 5e. In the “Item Filename” input box, make sure it says just “{frame}” and nothing more.</p>
<p>Click export.</p>
<p>This was tested with Aseprite 1.2.25.</p>
<p>This will export a png and json file which you can load using the Aseprite Loader</p>
</div></blockquote>
</section>
</section>


           </div>
          </div>
          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
        <a href="sprite-animations-preview.html" class="btn btn-neutral float-left" title="Sprite animation preview" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
        <a href="spine-animations.html" class="btn btn-neutral float-right" title="Spine animations" 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>