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


			
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210
							<!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>Install Phaser Editor 2D Core &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="Install Phaser Editor 2D All-in-One" href="install-all-in-one.html" />
    <link rel="prev" title="Download and install" href="download-and-install.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 current"><a class="reference internal" href="index.html">First steps</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="download-and-install.html">Download and install</a><ul class="current">
<li class="toctree-l3 current"><a class="current reference internal" href="#">Install Phaser Editor 2D Core</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#getting-phaser-editor-2d-core-from-the-phaser-editor-2d-website">Getting Phaser Editor 2D Core from the Phaser Editor 2D website</a></li>
<li class="toctree-l4"><a class="reference internal" href="#getting-phaser-editor-2d-core-from-the-npm-registry">Getting Phaser Editor 2D Core from the NPM registry</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="install-all-in-one.html">Install Phaser Editor 2D All-in-One</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="create-first-project.html">Create your first project</a></li>
<li class="toctree-l2"><a class="reference internal" href="add-image-to-scene.html">Add an image to the scene</a></li>
<li class="toctree-l2"><a class="reference internal" href="unlock-ide.html">Unlock the IDE</a></li>
<li class="toctree-l2"><a class="reference internal" href="learn-phaser-with-phaser-editor.html">Learn Phaser with Phaser Editor 2D</a></li>
</ul>
</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"><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">First steps</a></li>
          <li class="breadcrumb-item"><a href="download-and-install.html">Download and install</a></li>
      <li class="breadcrumb-item active">Install Phaser Editor 2D Core</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="install-phaser-editor-2d-core">
<h1>Install Phaser Editor 2D Core<a class="headerlink" href="#install-phaser-editor-2d-core" title="Link to this heading"></a></h1>
<p>You can install <a class="reference external" href="../intro/core.html">Phaser Editor 2D Core</a> using two main methods:</p>
<ul class="simple">
<li><p>Download it from the Phaser Editor 2D website.</p></li>
<li><p>Install it using the Node Package Manager (NPM)</p></li>
</ul>
<section id="getting-phaser-editor-2d-core-from-the-phaser-editor-2d-website">
<h2>Getting Phaser Editor 2D Core from the Phaser Editor 2D website<a class="headerlink" href="#getting-phaser-editor-2d-core-from-the-phaser-editor-2d-website" title="Link to this heading"></a></h2>
<p>Download the <code class="docutils literal notranslate"><span class="pre">PhaserEditor2D-core-&lt;version&gt;-&lt;platform&gt;.zip</span></code> file for your platform from the <a class="reference external" href="https://phasereditor2d.com/downloads">Downloads page</a>.</p>
<p>Un-compress the downloaded file, open the terminal and run:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span><span class="nb">cd</span><span class="w"> </span>/path/to/downloaded/PhaserEditor2D
$<span class="w"> </span>./PhaserEditor2D<span class="w"> </span>-project<span class="w"> </span>path/to/project
</pre></div>
</div>
<p>The server starts and opens the default browser in the address: <code class="docutils literal notranslate"><span class="pre">http://127.0.0.1:1959/editor</span></code>.</p>
<p>The <code class="docutils literal notranslate"><span class="pre">-project</span></code> flag is mandatory, its value must be the path to the game project.</p>
<p>Check the <a class="reference external" href="create-first-project.html">Create your first project</a> section for creating a new game.</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>In previous versions of the editor, there was the workspace concept. It allowed you to create new projects inside a workspace folder. It is not supported anymore, the editor’s server only runs for a single project.</p>
</div>
<p>By default, the server runs in application-mode. It means it does its best on providing better integration with your OS:</p>
<blockquote>
<div><ul class="simple">
<li><p>It opens the default browser at the right URL (you can change it with the <code class="docutils literal notranslate"><span class="pre">-browser-command</span></code> option).</p></li>
<li><p>It allows launching third-party OS applications like Visual Studio Code or the file manager (Windows Explorer, macOS Finder, etc…).</p></li>
<li><p>It denies remote connections.</p></li>
</ul>
</div></blockquote>
<p>However, you can run the server in a remote host using the <code class="docutils literal notranslate"><span class="pre">-public</span></code> option:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>./PhaserEditor2D<span class="w"> </span>-public
</pre></div>
</div>
<p>It allows remote connections but disables all the OS integration described before.</p>
<p><a class="reference external" href="../misc/server-options.html">Learn more about all the command line options</a></p>
</section>
<section id="getting-phaser-editor-2d-core-from-the-npm-registry">
<h2>Getting Phaser Editor 2D Core from the NPM registry<a class="headerlink" href="#getting-phaser-editor-2d-core-from-the-npm-registry" title="Link to this heading"></a></h2>
<p>You can install <a class="reference external" href="../intro/core.html">Phaser Editor 2D Core</a> globally in your system using <a class="reference external" href="https://www.npmjs.com">NPM</a>:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>&gt;<span class="w"> </span>npm<span class="w"> </span>install<span class="w"> </span>-g<span class="w"> </span>phasereditor2d-launcher
</pre></div>
</div>
<p>And you can run it in a terminal:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>phasereditor2d-launcher<span class="w"> </span>-project<span class="w"> </span>path/to/project
</pre></div>
</div>
<p>The <a class="reference external" href="https://www.npmjs.com/package/phasereditor2d-launcher">phasereditor2d-launcher</a> script downloads the latest <a class="reference external" href="../intro/core.html">Phaser Editor 2D Core</a> version from the Phaser Editor 2D website and runs it. Next time, the script will use the downloaded editor.</p>
<p>However, probably you would like to install <code class="docutils literal notranslate"><span class="pre">phasereditor2d-launcher</span></code> as a dependency of your project. Then do:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>&gt;<span class="w"> </span>npm<span class="w"> </span>install<span class="w"> </span>phasereditor2d-launcher<span class="w"> </span>--save-dev
</pre></div>
</div>
<p>And run it:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>npx<span class="w"> </span>phasereditor2d-launcher<span class="w"> </span>-project<span class="w"> </span>.
</pre></div>
</div>
<p>If your project was created using one of the project templates provided by the <a class="reference external" href="../intro/all-in-one.html">Phaser Editor 2D All-in-One</a> distribution or downloaded from the <a class="reference external" href="https://phasereditor2d.com/start">Phaser Editor 2D Start page</a>, then the editor is installed together with the other dependencies. Also, the <code class="docutils literal notranslate"><span class="pre">package.json</span></code> file contains the <code class="docutils literal notranslate"><span class="pre">editor</span></code> script for running the editor:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>&gt;<span class="w"> </span>npm<span class="w"> </span>run<span class="w"> </span>editor
</pre></div>
</div>
<p><a class="reference external" href="https://www.npmjs.com/package/phasereditor2d-launcher">Learn more about the phasereditor2d-launcher module</a>.</p>
</section>
</section>


           </div>
          </div>
          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
        <a href="download-and-install.html" class="btn btn-neutral float-left" title="Download and install" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
        <a href="install-all-in-one.html" class="btn btn-neutral float-right" title="Install Phaser Editor 2D All-in-One" 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>