Home Explore Help
Sign In
Phaser.js
/
PhaserEditor2D-v3-docs
mirror of https://github.com/PhaserEditor2D/PhaserEditor2D-v3-docs.git
2
0
Fork 0
Files Issues 0 Wiki
Branch: master
Branches Tags
PhaserEditor2D-...
/
first-steps
/
create-first-project.rst

create-first-project.rst 2.8 KB
Permalink History Raw

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455 
  1. .. include:: ../_header.rst
    2. 

  2. 

  3. Create your first project
    4. 

  4. -------------------------
    5. 

  5. 

  6. We provide a couple of project templates that you can download from the `Phaser Editor 2D Start page <https://phasereditor2d.com/start>`_. 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 Gitpod_ (a cloud-based development environment).
    7. 

  7. 

  8. .. image:: ../images/first-steps-online-start-page-09132021.webp
    9. 

  9.   :alt: Download project templates online
    10. 

  10. 

  11. There are two groups for templates: **Basic Templates** and **Example Games**.
    12. 

  12. 

  13. The **Basic Templates** are "empty" projects with different setups. If you are making a professional game, we recommend using the **Webpack TypeScript** template.
    14. 

  14. 

  15. You can take a look to the **Example Games** for learning Phaser Editor 2D by looking the code of "real games".
    16. 

  16. 

  17. Each project template has a README file (in the GitHub repository) with the instructions for installing all required dependencies.
    18. 

  18. 

  19. More templates are available in the `Phaser Editor 2D Marketplace <https://marketplace.phasereditor2d.com>`_.
    20. 

  20. 

  21. This method for stating a new project is great for the |core|_ distribution or for starting a new project in the cloud.
    22. 

  22. 

  23. The |allInOne|_ 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.
    24. 

  24. 

  25. Follow these steps:
    26. 

  26. 

  27. * Click on the **New Project** button:
    28. 

  28.   
    29. 

  29.   .. image:: ../images/first-steps-allInOne-new-project-1-20220415.webp
    30. 

  30.     :alt: All-in-one new project.
    31. 

  31.   
    32. 

  32. * Select one of the project templates. Or click on the *Get more in the Marketplace* link, it shows more templates available in the the `Phaser Editor 2D Marketplace <https://marketplace.phasereditor2d.com>`_ (it requires an Internet connection):
    33. 

  33. 

  34.   .. image:: ../images/first-steps-allInOne-new-project-2-20220415.webp
    35. 

  35.     :alt: Select project template
    36. 

  36. 

  37.   .. image:: ../images/first-steps-allInOne-new-project-marketplace-20220415.webp
    38. 

  38.     :alt: Select project template from the marketplace.
    39. 

  39. 

  40.   Projects in the marketplace are created by the Phaser Editor 2D team but also by the community.
    41. 

  41. 

  42. * When you select a project template, the IDE opens the OS file explorer. Select a directory where the project content will be copied:
    43. 

  43. 

  44.   .. image:: ../images/first-steps-select-project-template-20220415.webp
    45. 

  45.     :alt: Select the project folder.
    46. 

  46. 

  47. 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.
    48. 

  48. 

  49. .. image:: ../images/first-steps-new-project-2-04012021.webp
    50. 

  50.   :alt: Workbench shows the new project
    51. 

  51. 

  52. To run your project, click in the **Play** button at the beginning of the toolbar:
    53. 

  53. 

  54. .. image:: ../images/first-steps-new-play-project-04012021.webp
    55. 

  55.   :alt: Play the project.
    56.