create-first-project.html 9.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168
  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>Create your first project &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="Add an image to the scene" href="add-image-to-scene.html" />
  23. <link rel="prev" title="Install Phaser Editor 2D All-in-One" href="install-all-in-one.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 current"><a class="current reference internal" href="#">Create your first project</a></li>
  50. <li class="toctree-l2"><a class="reference internal" href="add-image-to-scene.html">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">Create your first project</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="create-your-first-project">
  86. <h1>Create your first project<a class="headerlink" href="#create-your-first-project" title="Link to this heading"></a></h1>
  87. <p>We provide a couple of project templates that you can download from the <a class="reference external" href="https://phasereditor2d.com/start">Phaser Editor 2D Start page</a>. You’ll see that each template card contains links for downloading a zip with the project, a link to the GitHub project, and a link for opening the project in <a class="reference external" href="https://gitpod.io">Gitpod</a> (a cloud-based development environment).</p>
  88. <img alt="Download project templates online" src="../_images/first-steps-online-start-page-09132021.webp" />
  89. <p>There are two groups for templates: <strong>Basic Templates</strong> and <strong>Example Games</strong>.</p>
  90. <p>The <strong>Basic Templates</strong> are “empty” projects with different setups. If you are making a professional game, we recommend using the <strong>Webpack TypeScript</strong> template.</p>
  91. <p>You can take a look to the <strong>Example Games</strong> for learning Phaser Editor 2D by looking the code of “real games”.</p>
  92. <p>Each project template has a README file (in the GitHub repository) with the instructions for installing all required dependencies.</p>
  93. <p>More templates are available in the <a class="reference external" href="https://marketplace.phasereditor2d.com">Phaser Editor 2D Marketplace</a>.</p>
  94. <p>This method for stating a new project is great for the <a class="reference external" href="../intro/core.html">Phaser Editor 2D Core</a> distribution or for starting a new project in the cloud.</p>
  95. <p>The <a class="reference external" href="../intro/all-in-one.html">Phaser Editor 2D All-in-One</a> distribution has the option of creating a new project. It contains some built-in templates (available offline), and also connects to the marketplace for getting more.</p>
  96. <p>Follow these steps:</p>
  97. <ul>
  98. <li><p>Click on the <strong>New Project</strong> button:</p>
  99. <img alt="All-in-one new project." src="../_images/first-steps-allInOne-new-project-1-20220415.webp" />
  100. </li>
  101. <li><p>Select one of the project templates. Or click on the <em>Get more in the Marketplace</em> link, it shows more templates available in the the <a class="reference external" href="https://marketplace.phasereditor2d.com">Phaser Editor 2D Marketplace</a> (it requires an Internet connection):</p>
  102. <img alt="Select project template" src="../_images/first-steps-allInOne-new-project-2-20220415.webp" />
  103. <img alt="Select project template from the marketplace." src="../_images/first-steps-allInOne-new-project-marketplace-20220415.webp" />
  104. <p>Projects in the marketplace are created by the Phaser Editor 2D team but also by the community.</p>
  105. </li>
  106. <li><p>When you select a project template, the IDE opens the OS file explorer. Select a directory where the project content will be copied:</p>
  107. <img alt="Select the project folder." src="../_images/first-steps-select-project-template-20220415.webp" />
  108. </li>
  109. </ul>
  110. <p>The new project is created and shown in the workbench. If you get it from the marketplace, then it will get a time for fetching the files.</p>
  111. <img alt="Workbench shows the new project" src="../_images/first-steps-new-project-2-04012021.webp" />
  112. <p>To run your project, click in the <strong>Play</strong> button at the beginning of the toolbar:</p>
  113. <img alt="Play the project." src="../_images/first-steps-new-play-project-04012021.webp" />
  114. </section>
  115. </div>
  116. </div>
  117. <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
  118. <a href="install-all-in-one.html" class="btn btn-neutral float-left" title="Install Phaser Editor 2D All-in-One" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
  119. <a href="add-image-to-scene.html" class="btn btn-neutral float-right" title="Add an image to the scene" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
  120. </div>
  121. <hr/>
  122. <div role="contentinfo">
  123. <p>&#169; Copyright 2016-2024, Arian Fornaris.</p>
  124. </div>
  125. Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
  126. <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
  127. provided by <a href="https://readthedocs.org">Read the Docs</a>.
  128. </footer>
  129. </div>
  130. </div>
  131. </section>
  132. </div>
  133. <script>
  134. jQuery(function () {
  135. SphinxRtdTheme.Navigation.enable(true);
  136. });
  137. </script>
  138. <!-- Theme Analytics -->
  139. <script async src="https://www.googletagmanager.com/gtag/js?id=UA-67206336-2"></script>
  140. <script>
  141. window.dataLayer = window.dataLayer || [];
  142. function gtag(){dataLayer.push(arguments);}
  143. gtag('js', new Date());
  144. gtag('config', 'UA-67206336-2', {
  145. 'anonymize_ip': false,
  146. });
  147. </script>
  148. </body>
  149. </html>